Nebojte se REST API — úvod pro neprogramátory

Neděláte integrace každý den? Tady je minimum pojmů, se kterým zvládnete Signi API vyzkoušet — bez programování.

Jak API funguje

Komunikace s API je jako objednávka v restauraci: pošlete požadavek (co chcete a s jakými údaji) a dostanete odpověď. Obojí putuje přes zabezpečený web (HTTPS), stejně jako když prohlížíte stránky.

Pár pojmů, které v dokumentaci potkáte:

• Endpoint — internetová adresa jedné konkrétní služby, např. https://api.signi.com/api/v1/contract/ pro založení dokumentu.
• GET / POST / DELETE — druh požadavku: GET čte, POST vytváří či posílá data, DELETE maže.
• JSON — textový formát, ve kterém se posílají data. Čitelný okem: { "email": "jan@email.cz" }.
• API klíč — heslo vašeho workspace; posílá se s každým požadavkem. Viz Jak vygenerovat API klíč.

Čím si API vyzkoušet

curl — příkaz dostupný v terminálu každého počítače (na Macu i Windows). Všechny ukázky v této dokumentaci jsou právě curl — stačí zkopírovat, doplnit svůj klíč a spustit.

Postman — aplikace s přívětivým prostředím, kde požadavky naklikáte místo psaní příkazů. Přehledně vidíte adresu, hlavičky, tělo požadavku i odpověď.

Kde začít

Projděte si Quickstart — za pár minut pošlete první dokument k podpisu a hned uvidíte, jak spolu požadavky a odpovědi hrají.

Chcete jít do hloubky? Doporučujeme úvod do REST API (česky) nebo everything curl (anglicky).