Podpisuj.cz Podpisuj.cz by WOPRO
Pro vývojáře

Napojení na ERP nebo CRM přes API

Smlouvy vznikají ve vašich systémech, ne v naší aplikaci. Když v ERP schválíte objednávku nebo v CRM uzavřete obchod, může smlouva odejít k podpisu sama, bez toho, aby ji někdo ručně stahoval a nahrával jinam.

Co API umí

  • Založit dokument k podpisu z PDF a seznamu lidí. Pozvánky rozešleme sami.
  • Sledovat stav — kdo už podepsal a kdo je na řadě.
  • Stáhnout podepsané PDF i původní soubor.
  • Spustit ověření totožnosti člověka, například při onboardingu klienta.
  • Poslat webhook, když někdo podepíše nebo je dokument hotový, ať se nemusíte pořád ptát.

Co k tomu potřebujete

  1. Aktivní balíček obálek. API je jeho součástí; bez balíčku klíč nevznikne a volání vrací chybu s odkazem na dokup.
  2. API klíč, který si vytvoříte v účtu v sekci API klíče. Tajnou část ukazujeme jednou, hned si ji uložte.
  3. Server, který umí zavolat HTTPS. Nic víc. Žádnou knihovnu instalovat nemusíte, je to obyčejné REST rozhraní s JSON.

Kolik to stojí

API nemá vlastní sazebník. Dokument založený přes API spotřebuje jednu obálku ze stejného zůstatku jako dokument vytvořený ve webu. Ověření totožnosti přes API se neúčtuje, měsíčně jich ale můžete spustit nejvýš dvojnásobek obálek vašeho balíčku. Podrobněji v článku Jak se u nás platí.

Tři scénáře, které dávají smysl

Smlouva po uzavření obchodu. V CRM se obchod přesune do stavu „vyhráno", váš systém vygeneruje PDF a zavolá založení dokumentu. K obchodu si uloží ID dokumentu. Až přijde webhook o dokončení, stáhne podepsané PDF a přiloží ho k záznamu. Obchodník se o nic nestará.

Onboarding klienta s ověřením. Při registraci nového klienta spustíte ověření totožnosti a klienta přesměrujete na odkaz, který vám vrátíme. Po návratu si stav potvrdíte dotazem. Šetří to schůzku i kopírování občanky.

Nástup zaměstnance. HR systém při schválení nástupu pošle pracovní smlouvu a dodatky k podpisu. Než člověk přijde, má podepsáno a ověřenou totožnost.

Na co si dát pozor

  • Ukládejte si ID dokumentu, které vám vrátíme, ke své zakázce. Bez něj se ke stavu později těžko dostanete.
  • Nespoléhejte jen na webhook. Doručení neopakujeme donekonečna. Když na výsledku stojí účetní proces, ověřte si stav i dotazem.
  • Hlídejte si zůstatek obálek. Před hromadným rozesláním se zeptejte na zůstatek, ať vám nedojdou uprostřed dávky.
  • Podepisuje se v pořadí, v jakém lidi uvedete. Dokud první nepodepíše, další dokument nevidí.
  • Když balíček zrušíte, API se vypne hned, i kdyby vám obálky ještě zbývaly.

Dokumentace

Úplný seznam endpointů, ukázky volání v curl i v PHP, chybové kódy a popis webhooků najdete v dokumentaci API. Když v ní něco chybí nebo si nevíte rady, napište na [email protected].