Jak začít s API?

<< Klikněte pro zobrazení obsahu >>

Jak začít s API?

Navigace:  Začínáme > API Dotykačka >

Jestliže máte zájem využívat Dotykačka API v2, je nutné postupovat podle níže uvedených kroků a v první řadě si prostřednictvím formuláře požádat o vygenerování autorizačních údajů (Client ID a Client Secret). Ty jsou nezbytné pro komunikaci s API rozhraním.

API rozhraní je dostupné zákazníkům s licencí NAPLNO a NEOMEZENĚ. Pro testovací účely od nás dostanete speciální testovací licenční klíč. Tímto klíčem aktivujete pokladní aplikaci Dotykačka a dojde tak k vytvoření testovacího cloudu. Testování tedy neprovádíte na živých datech.

 

1. krok: Žádost o přístup k API v2

Pro komunikaci s rozhraním API v2, je nutné vyplnit tento registrační formulář klientské aplikace. Na základě pečlivě vyplněného formuláře vás budeme kontaktovat, abychom zjistili případné další údaje o vaší aplikaci a vydali vám Client ID a Client Secret, které jsou nezbytné pro používání API.

Dále vám poskytneme testovací licenční klíč. Tento licenční klíč použijete pro vytvoření testovacího cloudu a testování vaší integrace.

 

2. krok: Instalace a aktivace pokladní aplikace Dotykačka

Prostřednictvím Dotylačka Marketplace si do svého zařízení stáhněte a nainstalujte aplikaci Dotykačka. Po její prvním spuštění bude nutné projít aktivací. Při aktivaci použijte přidělený testovací klíč. Po úspěšné aktivaci dojde k vytvoření testovacího cloudového úložiště (Vzdálené správy) a budete moci pokladní aplikaci včetně cloudu začít používat

 

3. krok: Seznámení s možnostmi rozhraní API v2

Nyní se podívejte do dokumentace k rozhraní API a projděte si především část Obecné (v anglickém jazyce), abyste porozuměli základním pojmům, dostupným společným funkcím a popisům schémat. Jednotlivé funkce API jsou seskupeny podle entit, které spravují. Pokud hledáte konkrétní funkci z dřívějšího rozhraní API v1, najdete je v části Služby API v1 (v anglickém jazyce).

uziv_tip_icon

Pro snadnější implementaci je k dispozici kolekce pro Postman (v anglickém jazyce), kterou postupně doplňujeme. Pokud hledáte knihovnu pro snadnější integraci API v2, podívejte se do sekce Knihovny třetích stran (v anglickém jazyce).

 

4. krok: Autorizace

Přidělené Client ID a Client Secret použijete pro připojení klientské aplikace do vašeho testovacího a později zákaznického cloudu. Jde o citlivé osobní údaje, které nikomu nesdělujte. Tyto údaje jsou nutné pro získání autorizačního (refresh) tokenu, kterým se vaše aplikace bude připojovat. Pro každé volání API pak budete potřebovat ještě přístupový (access) token. Pro další postup se již podívejte do kompletní dokumentace API v2 v anglickém jazyce), kde je to vše popsáno.

nahoru