Alan Şablonlarında API Kullanımı ve Postman Koleksiyonu
Alan Şablonu detayında artık API Kullanımı sekmesi var. Şablona özel uç adresini, gönderilecek form alanlarını ve rol kimliklerini görüyor, hazır Postman koleksiyonunu tek tıkla indiriyorsunuz.
Belge şablonlarında uzun süredir olan API Kullanımı sekmesi artık Alan Şablonlarında da açık. Entegrasyonu kurarken şablon kimliğini panelden elle kopyalamaya ve uç adresini dokümanda aramaya gerek kalmıyor.
Şablona Özel Rehber
Alan Şablonu detayında API Kullanımı sekmesini açtığınızda o şablona ait gerçek değerleri görürsünüz:
- Çağıracağınız uç adresi ve gönderim biçimi
- Gönderilecek alanların listesi (imzalanacak PDF, şablon kimliği, taraf listesi, çapa bulunamadığında davranış, davet gönderme tercihi)
- Şablondaki roller, her rolün kimliği ve o rolün kaç alan doldurduğu
- Kopyalanmaya hazır bir örnek istek
Alan Şablonu, belgenin kendisini taşımaz: sözleşme metnini her çağrıda siz gönderirsiniz, şablon yalnız imza ve alan yerleşimini uygular. Rehber de bu akışı anlatır, belge şablonundakinden farklıdır.
Postman Koleksiyonu
Aynı sekmedeki Postman Collection İndir düğmesi şablona özel bir koleksiyon indirir. Koleksiyonda gönderim isteği dosya yükleme biçiminde hazır gelir; ayrıca şablon detayı, şablon listesi ve yerleşim önizleme istekleri de bulunur.
Postman’e aldıktan sonra api_key değişkenine kendi API anahtarınızı yapıştırın ve gönderim isteğinde imzalanacak PDF’i seçin. Sözleşme durumu ve hatırlatma istekleri için demand_id değişkenini doldurmanız gerekir. Önizleme ve gönderim uçları yazma yetkisi olan bir anahtar ister.
Koleksiyon gerçek ortamda çalışır: gönderim isteğini çalıştırdığınızda gerçek bir sözleşme oluşur ve kredi düşer. Davet gönderimi koleksiyonda varsayılan olarak kapalı gelir.
Yerleşim önizleme isteği kuru koşumdur: hangi alanın çapasının bulunduğunu, hangisinin bulunamadığını gösterir, sözleşme oluşturmaz ve bu istek için kredi düşülmez. Önizlemenin ayrı ve daha sıkı bir hız sınırı vardır.
Neden Önemli
Bir Alan Şablonunu programatik kullanmak isteyen ekipler, rol kimliklerini ve alan adlarını deneyerek buluyordu. Bu uçtaki alan adları JSON uçlarındakilerden farklı (örneğin davet bayrağının adı ayrı) ve tanınmayan bir alan adı sessizce yok sayılabildiği için entegrasyon beklenen sonucu vermeyebiliyordu. Artık panelde gördüğünüz alan adları çağrıdaki alan adlarının aynısı.
API üzerinden gönderdiğiniz taraf verilerinde veri sorumlusu sizsiniz; İmzala veri işleyen sıfatıyla hareket eder (bkz. Veri İşleme Sözleşmesi).
Uçların tam sözleşmesi, hata kodları ve örnek gövdeler için API dokümantasyonuna bakabilirsiniz.
Konuyla İlgili