Kde to je
V panelu otevřete Nastavení → Integrace → API pro platby a stiskněte Spravovat API pro platby. Stránka je na adrese /Admin/Nastaveni/ApiPlatby a v nadpisu uvádí cestu Nastavení → Integrace → API pro platby. Odkaz „← Integrace“ nahoře vás vrátí na přehled integrací. Je jen pro majitele účtu, zaměstnanec k ní přístup nemá.
K čemu stránka slouží
Zde si vygenerujete přihlašovací údaje, kterými se váš vlastní systém (například účetnictví nebo párování plateb z banky) přihlásí k API Obsadta. Přes API lze ověřit spojení, přečíst rezervace a objednávky vstupenek čekající na platbu, zjistit stav podle variabilního symbolu a platbu potvrdit nebo zamítnout. Podrobnosti jsou v článku API pro platby.
API pro platby je funkce tarifu Pro+ s aktivním předplatným. V nižším tarifu se místo tlačítek zobrazí upozornění s odkazem „Přejít na předplatné“. Už vygenerované údaje u účtu bez Pro+ nebo s neaktivním předplatným přestanou fungovat a API vrací chybu 403.
Za bezpečné uložení secretu odpovídáte vy. Obsadto si pamatuje jen jeho otisk, takže ho nikdy nedokáže zobrazit znovu.
Pole
Client id
- Co dělá: Veřejné označení vašich přihlašovacích údajů, 24 znaků. Zobrazí se ve zvýrazněném rámečku hned po vygenerování a pak ještě ve stavu pod nadpisem Přihlašovací údaje. Vedle pole je tlačítko Kopírovat.
- Výchozí hodnota: Prázdné, dokud údaje nevygenerujete.
- Povolené hodnoty: Pole je jen ke čtení, hodnotu vytváří Obsadto.
- Platí pro: jen tarif Pro+.
- Na co má vliv: Váš systém ho posílá při každém volání API spolu se secretem. Podle něj se počítá limit 30 požadavků za minutu.
Secret
- Co dělá: Tajné heslo k API, nejméně 43 znaků. Zobrazí se jen jednou, hned po vygenerování, spolu s upozorněním. Vedle pole je tlačítko Kopírovat. Po opuštění stránky už ho nepůjde zobrazit.
- Výchozí hodnota: Prázdné, dokud údaje nevygenerujete.
- Povolené hodnoty: Pole je jen ke čtení, hodnotu vytváří Obsadto.
- Platí pro: jen tarif Pro+.
- Na co má vliv: Spolu s client id slouží k přihlášení k API. Ztracený secret nejde obnovit, vygenerujte nové údaje.
Vygenerovat přihlašovací údaje
- Co dělá: Vytvoří první client id a secret a zobrazí je.
- Výchozí hodnota: Bez účinku, dokud se nestiskne. Tlačítko je vidět jen tehdy, když ještě nemáte platné údaje.
- Povolené hodnoty: Tlačítko.
- Platí pro: jen tarif Pro+.
- Na co má vliv: Vznikne jedna sada platných údajů.
Vygenerovat nové
- Co dělá: Po potvrzení dotazu vytvoří nové client id a secret. Dosavadní údaje okamžitě přestanou platit.
- Výchozí hodnota: Bez účinku, dokud se nestiskne. Tlačítko je vidět, když už máte platné údaje.
- Povolené hodnoty: Tlačítko s potvrzením.
- Platí pro: jen tarif Pro+.
- Na co má vliv: Váš systém je potřeba přenastavit na nové údaje, jinak dostane chybu 401.
Zrušit přístup
- Co dělá: Po potvrzení dotazu zruší platné údaje. Váš systém se pak k API nepřihlásí.
- Výchozí hodnota: Bez účinku, dokud se nestiskne. Tlačítko je vidět, když máte platné údaje.
- Povolené hodnoty: Tlačítko s potvrzením.
- Platí pro: všechny tarify, aby šlo přístup zrušit i po snížení tarifu.
- Na co má vliv: API vrací chybu 401, dokud nevygenerujete nové údaje.
Jak spolu pole souvisí
- Poskytovatel má nejvýše jedny platné údaje. Každé vygenerování předchozí zneplatní.
- Pod nadpisem Přihlašovací údaje vidíte datum, od kdy údaje platí, client id a čas posledního použití.
- Tabulka Posledních 50 volání ukazuje čas, operaci, variabilní symbol (u ověření spojení prázdný), výsledek a adresu, ze které volání přišlo. Neúspěšné přihlášení se do tabulky dostane jen tehdy, když zadané client id patří vám (platné i zrušené); neznámé client id se nezapisuje. Požadavky z blokované adresy se nezapisují, při vzniku blokace vznikne jediný řádek s operací blocked (vidí ho jen superadmin, protože adresa nepatří žádnému poskytovateli). Překročení limitu 30 za minutu u vašeho client id se zapíše s výsledkem 429. Záznam se uchovává 90 dní.
- Limity: 30 požadavků za minutu na client id; počítají se jen požadavky s ověřeným přihlášením. Po 10 neúspěšných přihlášeních za minutu z jedné adresy se z ní 15 minut odmítá vše, i správné údaje. Odpověď je 429 s hlavičkou Retry-After, která udává skutečný zbytek okna v sekundách.
Příklady nastavení
První použití. Stisknete Vygenerovat přihlašovací údaje, oba údaje zkopírujete do nastavení svého systému a pak ověříte spojení podle článku API pro platby.
Únik secretu. Stisknete Vygenerovat nové, potvrdíte a nové údaje vložíte do svého systému. Starý secret přestane platit okamžitě.
Konec používání. Stisknete Zrušit přístup a potvrdíte.