Twórz procesy podpisywania dokumentów z API Agrello
Twórz dokumenty, uzupełniaj szablony danymi, zapraszaj do podpisania, odbieraj zdarzenia przez webhooki i pobieraj podpisane dokumenty z własnej aplikacji lub systemu wewnętrznego.
Co przygotować przed pierwszym żądaniem
OAuth 2.0 Client Credentials. Wyślij nagłówek Authorization: Bearer $TOKEN.
Tokeny dostępu wygasają po 24 godzinach. Po odpowiedzi 401 pobierz nowy token.
Używaj punktów końcowych /v3. Swagger oznacza API v2 jako przestarzałe.
Minimalny proces podpisywania od początku do końca
Skopiuj przykład do wykorzystania w aplikacji serwerowej. Poniżej znajdziesz kolejność operacji. Pełna dokumentacja API jest dostępna w Swaggerze.
Poznaj najważniejsze pojęcia
Obszar roboczy
└── Folder
├── Szablon i zmienne
└── Kontener
├── uczestnicy i zaproszenia
├── podpisy
└── podpisany dokument
Folder
Porządkuje dokumenty według zespołu, klienta, procesu lub projektu. Niektóre odpowiedzi API mogą nadal zawierać starsze pole spaceId.
Szablon
Dokument źródłowy wielokrotnego użytku ze zmiennymi. Aby wprowadzić zmiany, utwórz nową wersję jako osobny szablon.
Kontener
Pakiet dokumentów wysyłanych do podpisu wraz z plikami, zaproszeniami, uczestnikami, podpisami, metadanymi i plikiem wynikowym.
Dopasuj proces do miejsca, w którym powstaje dokument
Wariant A – prześlij własny plik
Twój system generuje plik, a Agrello obsługuje podpisywanie.
/v3/workspace/v3/folders/v3/folders/{folderId}/containers/v3/containers/{containerId}/outputWariant B – utwórz dokument z szablonu
Zmienne szablonu Agrello są uzupełniane danymi z Twojej aplikacji lub systemu wewnętrznego.
/v3/folders/{folderId}/templates/v3/templates/{templateId}/v3/folders/{folderId}/containers/v3/webhooks{
"templateId": "template-uuid",
"variables": [
{ "name": "employee_name", "value": "Jane Smith" },
{ "name": "start_date", "value": "2026-06-01" },
{ "name": "employee_signature", "value": "jane@example.com" }
],
"signers": []
}Formaty pliku wynikowego
- PDF — podpisany plik PDF.
- ASICE — unijny format kontenera dla podpisów XAdES.
- EDOC — łotewski kontener podpisu elektronicznego.
- ADOC_B — litewski kontener podpisu elektronicznego.
- ZIP — archiwum z plikami wynikowymi, jeśli ma zastosowanie.
Sprawdzaj, kiedy dokument zostanie podpisany
Używaj webhooków w integracjach opartych na zdarzeniach. Odpytuj kontener o szczegóły tylko wtedy, gdy potrzebujesz rozwiązania awaryjnego albo chcesz sprawdzić zgodność danych.
{
"event": "DOCUMENT_SIGNED",
"url": "https://your-app.com/webhooks/agrello/document-signed"
}{
"containerId": "container-uuid",
"userId": "last-signer-uuid",
"signerCount": 2
}DOCUMENT_SIGNATURE_ADDED, DOCUMENT_SIGNED, REMINDER_CREATED.Pokaż nam swój proces, a pomożemy Ci wdrożyć go z API
Omów dane uwierzytelniające, szablony, format pliku wynikowego, role osób podpisujących, obsługę webhooków i najszybszą drogę do podpisania dokumentu testowego.