API – přístup k datům
Veřejné REST API DATIFY: k čemu je, kde najdete jeho dokumentaci a jak si vytvoříte přístupový token.
Kromě aplikace se k datům dostanete i přes veřejné REST API. Hodí se, když chcete DATIFY propojit s jiným systémem, pravidelně do něj sypat data odjinud nebo si zautomatizovat něco, na co se v aplikaci proklikáváte pořád dokola.
Dokumentace API
Kompletní referenci endpointů, i s příklady požadavků a možností si je rovnou vyzkoušet, najdete na developers.datify.cz.
Je to samostatná technická dokumentace pro vývojáře – tenhle článek slouží jen jako rozcestník a popisuje, jak si obstarat token.
Co přes API zvládnete
API je zaměřené na záznamy: čtete je, zakládáte (i hromadně), upravujete, mažete a vyhledáváte dotazem s filtrem. Agendy a datové zdroje si přes něj projdete a přečtete jejich strukturu; sloupce se zakládají a upravují v aplikaci. Kromě toho API umí nahrávat přílohy a číst údaje o uživatelích. Automatizace se spouštějí svými spouštěči, ne přes API.
Přístupový token
Každý požadavek se musí autorizovat osobním přístupovým tokenem (Personal Access Token), který předáte v hlavičce:
Authorization: Bearer VÁŠ_TOKENToken si vytvoříte na stránce Personal access tokens, kterou najdete na adrese /tokens vašeho DATIFY:
- Nahoře vyberte pracovní prostor, pro který token platí.
- Klikněte na Nový token.
- Zadejte Název tokenu a potvrďte.
- Token si hned zkopírujte tlačítkem Kopírovat token do schránky.
Vytvořit token může Administrátor pracovního prostoru. Odstranit pak každý smí jen své vlastní tokeny.
Token se zobrazí jen jednou, při vytvoření. Uložte si ho proto rovnou do správce hesel. Když ho ztratíte nebo unikne, starý token odstraňte a vytvořte nový.
Tokenů si můžete udělat víc, třeba zvlášť pro testování a pro ostrý provoz. Přehled máte v tabulce s názvem, datem vytvoření a ID tokenu; odsud token také odstraníte.
Co token umí
Token jedná přesně jako vy. Má stejná oprávnění jako váš uživatelský účet, takže přes API se dostanete přesně k tomu, k čemu se dostanete v aplikaci. Když někomu předáte token, dáváte mu tím svá práva.
Změny provedené přes API se zapisují do historie záznamu s označením API, takže je poznáte od ruční úpravy. Krok zpět (Ctrl+Z) se týká úprav z aplikace, takže zásah přes API vracíte úpravou záznamu.
Kolik požadavků API zvládne a jak poznáte, že jste na limitu, popisuje článek Rate limiting API.