Jak wysłać dokument do podpisu?

Ten artykuł przeprowadzi Cię przez proces wysyłania dokumentu do podpisu za pomocą Sign.Plus eSignature API.

Wykonując poniższe kroki, utworzysz kopertę (envelope), dodasz dokument, ustawisz odbiorcę, wstawisz anotację podpisu, a na koniec wyślesz kopertę do podpisu.

Wymagania wstępne

• Konto Sign.Plus z planem API
• Twój Personal Access Token

Krok 1: Utwórz kopertę (envelope)

Koperta (envelope) jest kontenerem na dokumenty, które mają być podpisane przez odbiorców.

1. Wyślij żądanie do punktu końcowego POST /v2/envelope, aby utworzyć nową kopertę. {
"name": "My wonderful envelope",
"flow_type": "REQUEST_SIGNATURE",
"legality_level": "SES",
"expires_at": 1831280113,
"sandbox": true
}
2. W nagłówku Authorization podaj swój klucz API.

3. Po pomyślnym wykonaniu żądania otrzymasz obiekt Envelope.

   { "id": "<string>" ... }

4. Zapisz id jako envelope_id

Krok 2: Dodaj dokument do koperty

1. Użyj punktu końcowego POST /v2/envelope/{envelope_id}/document, aby dodać dokument.

2. Zamień {envelope_id} na identyfikator otrzymany w kroku 1.

3. Wyślij żądanie POST z plikiem dokumentu w treści żądania jako multipart/form-data.

4. W przypadku powodzenia otrzymasz obiekt Document jako odpowiedź.
   { "id": "<string>" ... }

5. Zapisz id jako document_id do wykorzystania później.

Krok 3: Ustaw odbiorcę dla swojej koperty

1. Użyj punktu końcowego POST /v2/envelope/{envelope_id}/signing_steps, aby dodać odbiorcę.

2. Zamień {envelope_id} na identyfikator swojej koperty.

3. Wyślij żądanie POST z następującą treścią JSON:

   {
"signing_steps": [
{
"recipients": [
{
"name": "John Doe", "email": "john.doe@example.com", "role": "SIGNER"
} ] } ] }

4. W przypadku powodzenia otrzymasz tablicę SigninStep.

5. Przeglądaj tablicę i zapisz nazwę id odbiorcy, dla którego chcesz dodać ramkę podpisu (adnotację podpisu). Zapisz ten id jako recipient_id.

Krok 4: Wstaw adnotację podpisu w dokumencie

Zanim dodasz adnotację podpisu, upewnij się, że Twój podpis został już zdefiniowany na platformie Sign.Plus.

1. Użyj punktu końcowego POST /v2/envelope/{envelope_id}/annotation, aby dodać adnotację podpisu.
2. Zamień {envelope_id} na identyfikator swojej koperty. 
3. Wyślij żądanie POST z następującą treścią JSON:
   {
"recipient_id": "<recipient_id>",
"document_id": "<document_id>",
"page": 1,
"x": 50,
"y": 20,
"width": 20,
"height": 60,
"required": true,
"type": "SIGNATURE",
}

   Zastąp <recipient_id> oraz <document_id>odpowiednimi wartościami.

Krok 5: Wyślij kopertę do podpisu

1. Użyj punktu końcowego POST /v2/envelope/{envelope_id}/send, aby wysłać kopertę.
2. Zamień {envelope_id} na identyfikator swojej koperty.
3. Wyślij żądanie POSTdo tego punktu końcowego.
4. W przypadku powodzenia koperta zostanie wysłana do odbiorcy w celu podpisania.
   
   

Podsumowanie

Udało się pomyślnie wysłać dokument do podpisu za pomocą Sign.Plus eSignature API. Odbiorca otrzyma powiadomienie e-mail z linkiem do podpisania dokumentu.

Aby uzyskać bardziej szczegółowe informacje na temat każdego punktu końcowego API używanego w tym procesie, zapoznaj się z naszą dokumentacją API.