API Endpointy

Modul Signi přidává do EspoCRM vlastní REST API endpointy, které využívá frontendová část (JavaScript klient) pro komunikaci s backendem a následně se službou Signi.

Tyto endpointy jsou zabezpečené standardní autentizací EspoCRM.

Controller: Signi

Třída: Espo\Modules\Signi\Controllers\Signi

Odeslání dokumentu

Spustí proces odeslání konkrétního dokumentu do Signi.

• Metoda: GET
• Route: signi/send-document/{entityType}/{entityId}
  • Poznámka: Parametr entityType je v URL vyžadován pro routování, ale v aktuální implementaci se předpokládá, že entityId vždy odkazuje na Document.
• Parametry:
  • entityId: ID dokumentu v EspoCRM.
• Návratová hodnota: JSON odpověď ze Signi API (obsahuje contract_id, status atd.).
• Chyby:
  • 400 Bad Request: Chybí ID.
  • 404 Not Found: Dokument neexistuje, chybí soubor nebo API klíč.
  • 500 Error: Dokument nemá podepisující, je již odeslán, nebo chyba komunikace.

Storno dokumentu

Zruší (stornuje) proces podepisování v Signi i v EspoCRM.

• Metoda: GET
• Route: signi/storno/{signiId}
• Parametry:
  • signiId: ID kontraktu v Signi (hodnota pole signiId z dokumentu).
• Návratová hodnota: JSON objekt s výsledkem operace.
• Chyby:
  • 404: Kontrakt nenalezen (v Signi).
  • 400: Kontrakt je již podepsán (nelze stornovat).

---

Externí API (Signi.com)

Modul komunikuje s následujícími endpointy veřejného API Signi:

Akce	Metoda	Endpoint	Popis
Odeslání	POST	/api/v1/contract/?type=doc	Vytvoření nového kontraktu z PDF dokumentu. Používá multipart/form-data.
Stav	GET	/api/v1/contract/{id}	Získání aktuálního stavu kontraktu.
Storno	DELETE	/api/v1/contract/{id}	Zrušení kontraktu.
Stažení	GET	/api/v1/contract/{id}/download	Stažení finálního podepsaného PDF.

Dokumentace Signi API: https://api.signi.com/doc/