Bu makale, Sign.Plus e-İmza API'sini kullanarak bir belgeyi imzaya gönderme sürecinde size adım adım rehberlik edecektir.
Bu adımları izleyerek bir zarf oluşturacak, bir belge ekleyecek, bir alıcı belirleyecek, bir imza ek açıklaması ekleyecek ve son olarak zarfı imzaya göndereceksiniz.
Ön Koşullar
- API Planı bulunan bir Sign.Plus hesabı
- Kişisel Erişim Belirteciniz:
Personal Access Token
1. Adım: Zarf oluşturun
Zarf, alıcılar tarafından imzalanacak belgeler için bir kapsayıcıdır.
- Yeni bir zarf oluşturmak için POST /v2/envelope uç noktasına bir istek gönderin.
{
"name": "My wonderful envelope",
"flow_type": "REQUEST_SIGNATURE",
"legality_level": "SES",
"expires_at": 1831280113,
"sandbox": true
} - API anahtarınızı
Authorizationbaşlığına ekleyin. -
İşlem başarılı olduğunda bir
Envelopenesnesi alırsınız.{ "id": "<string>" ... } -
iddeğerinienvelope_idolarak kaydedin.
2. Adım: Zarfınıza belge ekleyin
-
Belge eklemek için POST /v2/envelope/{envelope_id}/document uç noktasını kullanın.
-
{envelope_id}değerini 1. Adım'da aldığınız kimlikle değiştirin. - Belge dosyasını istek gövdesinde
multipart/form-data.olarak içeren bir POST isteği gönderin. -
İşlem başarılı olursa yanıt olarak bir
Documentnesnesi alırsınız.{ "id": "<string>" ... } -
iddeğerini daha sonra kullanmak üzeredocument_idolarak kaydedin.
3. Adım: Zarfınız için bir alıcı belirleyin
-
Bir alıcı eklemek için POST /v2/envelope/{envelope_id}/signing_steps uç noktasını kullanın.
-
{envelope_id}ifadesini kendi zarf kimliğinizle değiştirin. -
Aşağıdaki JSON gövdesiyle bir
POSTisteği gönderin:{
"signing_steps": [
{
"recipients": [
{
"name": "John Doe", "email": "john.doe@example.com", "role": "SIGNER"
} ] } ] } -
İşlem başarılı olursa bir
SigninStepdizisi alırsınız. -
Diziyi inceleyin ve imza çerçevesini (imza ek açıklaması) eklemek istediğiniz alıcının
idadını alın. Buiddeğerinirecipient_idolarak kaydedin.
4. Adım: Belgenize imza ek açıklaması ekleyin
İmza ek açıklaması eklemeden önce imzanızı Sign.Plus platformunda tanımladığınızdan emin olun.
- İmza ek açıklaması eklemek için POST /v2/envelope/{envelope_id}/annotation uç noktasını kullanın.
-
{envelope_id}yerine zarf kimliğinizi yazın. - Aşağıdaki JSON gövdesiyle bir
POSTisteği gönderin:{
"recipient_id": "<recipient_id>",
"document_id": "<document_id>",
"page": 1,
"x": 50,
"y": 20,
"width": 20,
"height": 60,
"required": true,
"type": "SIGNATURE",
}<recipient_id>ve<document_id>yerine uygun değerleri yazın.
5. Adım: Zarfınızı imza için gönderin
- Zarfı göndermek için POST /v2/envelope/{envelope_id}/send uç noktasını kullanın.
-
{envelope_id}yerine zarf kimliğinizi yazın. - Bu uç noktaya bir
POSTisteği gönderin. - İşlem başarılı olursa zarf, imzalanmak üzere alıcıya gönderilir.
Sonuç
Sign.Plus e-İmza API'sini kullanarak bir belgeyi imzaya başarıyla gönderdiniz. Alıcı, belgeyi imzalayabilmesi için bir bağlantı içeren bir e-posta bildirimi alacaktır.
Bu süreçte kullanılan her bir API uç noktası hakkında daha ayrıntılı bilgi için lütfen API belgelerimize göz atın.