Belge gönderme akışı (gelişmiş, adım adım)

Önerilen entegrasyon: Tek istekte belge gönderme — PDF, alıcı, alan ve ayar tek multipart isteğinde.

Bu sayfa, panel sihirbazıyla aynı 4 adımlı Developer yüzeyini anlatır.

Tüm path’ler base /api/v1 üzerinedir.

Adımlar

1. Oluştur

Operasyonu başlatmak için öncelikle oluşturma yapmanız gerekmektedir. Yanıtta dönen operationId sonraki tüm adımlarda kullanılır. workspaceId, token’ın workspace’i ile aynı olmalıdır.

POST /developer/documents

(scope: documents:create)

2. PDF yükle

Oluşturulan operasyona imzalanacak PDF dosyasını yükleyin. İstek multipart/form-data olmalıdır; dosya alanı adı file.

POST /developer/documents/{operationId}/pdf

(scope: documents:create)

3. Konfigüre et

Alıcıları, sayfa meta bilgilerini ve imza / form alanlarını tanımlayın. Bu adım belgenin kimlere gideceğini ve hangi alanların doldurulacağını belirler.

PUT /developer/documents/{operationId}/configuration

(scope: documents:create)

4. Gönder

Teslimat kanallarını (e-posta, SMS, kiosk veya bu cihazda aç) belirleyerek imza sürecini başlatın. Kiosk için önce GET /developer/kiosks ile kioskDeviceId alın. Yeni entegrasyon için önerilen yol: Tek istekte belge gönderme.

POST /developer/documents/{operationId}/send

(scope: documents:create)

5. Durum

Gönderim sonrası işlemin durumunu tekil detay veya liste uçlarından izleyin.

GET /developer/documents/{operationId}

veya liste: GET /developer/documents

(scope: documents:read)

6. Sil (opsiyonel)

Taslak veya artık ihtiyaç duyulmayan operasyonu silmek için kullanılır.

DELETE /developer/documents/{operationId}

(scope: documents:delete)

Gönderim sonrası

Send yanıtında initialRecipientAccessCode ve openOnThisDeviceForActiveRecipient döner. Detay/liste yanıtındaki publicShortCode ile imza linki:

{appBase}/r/{code}

open_on_device kanalında code genelde initialRecipientAccessCode’dur; e-posta/SMS linkleri alıcıya özel üretilir.

Durum polling: Durum takibi.

İmza türleri, doğrulama politikası, sıralı akış ve tamamlanan PDF: İmzalama akışı.

Ayrık alanlarla hızlı gönderim

PDF yükleyip formu doğrudan ayrık alanlarla gönderebilirsiniz: configuration’da alanlara config.isDetached: true verin; x/y zorunlu değildir (pageNumber: 0). Alıcı PDF dışı adımlarda doldurur; final PDF’in sonuna ek sayfada basılır.

Aynı 4 adım geçerlidir (create → PDF → configuration → send).

Kurallar ve örnek body: Geliştirici belgeleri — Ayrık bileşenler.

Şablondan gönderim

Hazır şablondan tek istekte göndermek için: Şablon gönderme akışı.

Kritik kavramlar

Konfigürasyon ve gönderimde kullanılan sabitler (imza alanı tipi SIGNATURE, kanal email / sms / kiosk / open_on_device, alıcı rolü vb.)

Geliştirici belgeleri — referans tabloları sayfasında açıklanır.

workspaceId create body’de token’ın workspace’i ile aynı olmalıdır.

Hızlı deneme: Playground.