Články v kategorii

⚙️ API - Dokumentace

Aktualizováno před měsícem

Pro plnohodnotné využití Foxentry v rámci vašich vlastních systémů, mobilních aplikací nebo interních platforem je vám k dispozici naše rozsáhlá API dokumentace. Ta je navržena tak, aby vývojářům poskytla veškeré technické detaily potřebné pro rychlou a stabilní integraci.

Vývojářský portál

Kompletní technickou dokumentaci k aktuální verzi 2.0 najdete na adrese foxentry.dev. Dokumentace je interaktivní a umožňuje vám testovat požadavky přímo v prohlížeči.

Struktura API dokumentace

Dokumentace je rozdělena do logických celků, které vás provedou od prvního požadavku až po pokročilé nastavení validací:

  1. Úvod a autentizace: zde se dozvíte, jak správně sestavit hlavičku požadavku a jak používat vaše API klíče pro autorizaci dotazů,
  2. Endpointy služeb: podrobný technický popis všech dostupných služeb Foxentry, jako jsou adresy, firmy, e-maily, telefony nebo jména,
  3. Status kódy a chyby: přehled všech možných odpovědí serveru, kde se naučíte rozlišovat mezi úspěšnou validací, technickou chybou nebo vyčerpáním limitů.

Rychlý start s SDKs

Nechcete psát celou integraci od nuly? Připravili jsme pro vás hotové knihovny (SDKs) pro nejpoužívanější technologie, které najdete v sekci SDKs & Libraries. Aktuálně podporujeme například PHP, JavaScript / TypeScript nebo Python.

Potřebujete poradit?

Pokud v dokumentaci nenajdete odpověď na svůj specifický technický dotaz, neváhejte se obrátit na naši technickou podporu nebo využijte sekci FAQ přímo na vývojářském portálu.

Pořád nevíte? Ozvěte se nám