Články v kategorii
- Instalace do webu - úvod 💡
- Instalace do známých platforem ⭐
- Přidání nového formuláře
- Webový konfigurátor - párování kolonek ⭐
- Webový konfigurátor - ovládací prvky
- Aplikace - párování kolonek
- 📍 Adresy - nastavení
- 💼 Firmy - nastavení
- ✉️ E-maily - nastavení
- 📞 Tel. čísla - nastavení
- 👤 Jména - nastavení
- Deaktivace/aktivace služeb ve formuláři
- Vzhled a chování Foxentry 🎨
- Javascriptové API
- ⚙️ Rest API
- Zjištění stavu validace formulářů
- Vlastní zpracování dat z validace - Callbacky
- Cookies 🍪
- Jak vymazat cache prohlížeče
⚙️ Rest API
Kompletní technická dokumentace
Podrobný popis všech endpointů, autentizace a interaktivní nástroje pro testování požadavků najdete na našem vývojářském portálu: Foxentry.DEV.
Pokud chcete využívat funkcionalit Foxentry ve své vlastní mobilní aplikaci, interním systému nebo kdekoliv, kde se nehodí standardní implementace pomocí skriptu, je vám k dispozici naše rozhraní pracující na principu REST API.
API vs JS knihovna: nepřipravte se o hotové UX
Mnoho vývojářů při nasazování automaticky volí napojení přes čisté API. Přestože je naše rozhraní špičkové, integrací po vlastní ose se klienti často připravují o vyladěný frontendový zážitek. Naše hotová javascriptová knihovna řeší záludnosti prohlížečů, interaktivní prvky i nestandardní chování uživatelů kompletně za vás, čímž vám ušetří desítky hodin složitého vývoje vlastních rozhraní.
Založte si svůj API projekt
Prvním krokem k integraci je vytvoření správného typu projektu v administraci Foxentry:
- Kliknutím na tlačítko ve vašem úvodním dashboardu se dostanete do formuláře pro vytváření nových projektů.
- V dalších krocích si pojmenujte váš projekt a zvolte, zda jej spravujete pro sebe nebo pro klienta.
- Jelikož implementujete API, v sekci typu projektu zvolte možnost Aplikace.
Vytvořte si svůj API klíč
Na každý nově vytvořený projekt automaticky přidáváme 100 kreditů se 14denní platností, abyste mohli integraci v klidu otestovat. Pro zahájení testování je potřeba vygenerovat klíč:
- V detailu vašeho projektu klikněte v levém menu na Nastavení.
- Zvolte možnost API klíče. Zde uvidíte přehled všech vygenerovaných klíčů pro daný projekt.
- Klikněte na tlačítko Vytvořit API klíč.
U každého klíče můžete v rámci bezpečnosti nastavit omezení pro konkrétní IP adresy, ze kterých budou požadavky přicházet.
Struktura API dokumentace
Dokumentace na portálu foxentry.dev je navržena tak, aby vás provedla celým procesem integrace od prvního požadavku až po komplexní zpracování dat:
- Autentizace: dozvíte se, jak správně sestavit hlavičku požadavku (header) a jak používat vaše API klíče.
- Endpointy služeb: podrobný technický popis pro validaci adres, firem, e-mailů, telefonů i jmen.
- Status kódy a chyby: přehled všech možných odpovědí serveru pro správné ošetření chybových stavů i úspěšných validací.
Rychlý start s Foxentry SDKs
Nemusíte psát celou integraci od nuly. Připravili jsme pro vás oficiální open-source knihovny (SDKs), které zajistí správné zpracování všech požadavků i odpovědí a výrazně zkrátí čas potřebný pro implementaci.
| Jazyk / Platforma | Technické požadavky | Odkaz |
|---|---|---|
PHP
|
Verze 8.1 nebo vyšší | GitHub repo |
JavaScript / TS
|
Node.js verze 18 nebo vyšší | GitHub repo |
C#
|
.NET verze 8.0 nebo vyšší | GitHub repo |
Swift
|
Verze 5.0 nebo vyšší | GitHub repo |
Kotlin
|
Java verze 17 nebo vyšší | GitHub repo |
Potřebujete technickou pomoc?
Pokud v dokumentaci nenajdete odpověď na svůj specifický 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.
