Spouštíme novou verzi API

Jsme rádi, že vám můžeme po nějakém tom čase říct i nějakou novinku týkající se přímo Foxentry. A není to jen radostné zvolání, že jsou děcka už zase zpátky ve škole. Tentokrát je to opravdu velké - Foxentry API 2.0.

Není potřeba zdržovat, rovnou se mrkněte na naši novou dokumentaci a pojďme si říct, co všechno se změnilo.

Foxentry API 2.0

Změny naleznete už od základu. Nově jsme totiž upustili od Blueprintu od Apiary a přešli na OpenAPI specifikaci, která je modernější a používanější. Díky tomu si můžete testovat jednotlivé endpointy kdekoliv uznáte za vhodné, protože se tím poměrně razantaně usnadňuje import do různých nástrojů typu Postman či Spotlight.

Spokojený developer = klid v duši manažera

S novým API jsme aktualizovali i celkový přístup k developer experience. Vždycky jsme si zakládali na tom, že samotná implementace Foxentry je věc na pár minut a dokázali jsme uživatelům nabídnout rozhraní, kde si mohou vše jednoduše nastavit. V případě složitějších napojení přes API jsme ale (ruku na srdce❤️) trochu zaostávali. To jsme se nyní rozhodli změnit a ve spolupráci s DX heroes se pustili do dlouhodobého zlepšování Developer Experience. Čeká nás nový Developer Hub, předpřipravené SDKs, No code options a další super vychytávky, které budeme postupně zveřejňovat na portálu Foxentry.dev.

A co je tedy nového?

V prvé řadě nabízíme více endpointů k využití. Nově můžete využít například jednoinputový našeptávač adres, reverzní geocoding (dostupné adresy v dané GPS lokaci) či našeptávač nejčastějších e-mailových domén dle geolokace. Seznam všech aktuálních endpointů je v tabulce:

Nová logika response

Kompletně byla přepracována logika response a nyní odděleně vyhodnocujeme validitu informace na vstupu. Tímto způsobem jsme schopni informaci buď automaticky ihned opravit (resultCorrected) nebo případně nabídnout více vyhovující alternativy, i když je informace validní (suggestions). Díky tomuto nabízíme vašim vývojářům komplexní nástroj pro různé use cases, kdy potřebují nejenom zjistit validitu dat, ale zároveň chtějí co nejvíce automatizovaně data opravovat a strukturovat.

V response je zároveň i nově detailně uvedeno, co přesně je ve validované informaci špatně a závažnost daných chyb. Foxentry pak navíc uvádí strukturované opravy a interní doporučení, jak byste měli s informací pracovat. Tedy co a jakým způsobem je uživatelovi třeba zobrazit ve vaší aplikaci.

Nový engine pro našeptávače a validátory

V případě našeptávačů a validátorů jsme ze zase posunuli o kus dál. Nyní používáme neuronovou síť pro složitější dotazy a díky tomu se nám daří validovat i složitější chyby uživatelů. Dle interních testů to vychází na zlepšení dopátrání se výsledku až o 37 %. V reálném světě to znamená, že uživatel může nasekat mnohem více chyb a i tak je Foxentry schopno vše opravit. 

Informace navíc napříč endpointy

Ke každému endpointu přibyly další informace, které je možné vracet v rámci response. Např. v případě validace e-mailů se můžete nově dozvědět tzv. varovné signály, zda se jedná o jednorázový mail či freemail, u validace jmen jsme přidali podporu správného oslovení jména, příjmení a všech titulů plus data svátků pro česká i slovenská jména. Všechny dostupné informace jsou detailně popsány v rámci datascopes jednotlivých služeb. Zde je pro příklad datascope firem.

Pokročilé query options a filtry

Máme aktuálně přes 2 000 klientů a mnoho z nich se s námi pravidelně dělí o zpětnou vazbu. Novou verzi API jsme primárně budovali tak, aby reflektovala přání a požadavky, se kterými jsme se za tu dobu setkali. Myslíme tedy na různé formáty jak vstupních, tak výstupních informací a nabízíme uživatelům široké možnosti, jak si upravit response dle svých potřeb. Jsme přesvědčeni, že jedním z use-cases bude právě třeba sjednocení interních dat  a jejich případná automatická strukturalizace. Jistě mnozí z vás řeší dennodenně, že různé systémy požadují rozdílnou strukturu dat a je potřeba vynakládat poměrně velké úsilí na to, abyste tato data měli v požadovaném formátu.Někdy přímo na úkor uživatelů, na které někteří majitelé webů strukturalizaci delegují, i když je to pro uživatele nepřirozené (typicky rozdělená kolonka ulice a čísla popisného, což je dle našich testů mnohem pomalejší řešení s větším výskytem chyb). To samé platí pro různé formáty telefonních čísel, firemních údajů a tak dále. Díky Foxentry můžete tyto věci řešit jednoduše zpětně a uživatelům zbytečně nekomplikovat celý proces objednávky či vyplnění jekéhokoliv formuláře.

Příprava na zveřejnění nově podporovaných zemí

Jedním z důvodů, proč jsme vůbec museli začít řešit novou verzi API bylo to, že pro nás vždycky znamenalo přidání nově podporované země dost složitých úprav a starostí kvůli rozdílným kvalitám zdrojů a jejich struktury. Nové API nám do budoucna zjednoduší celý tento proces a nebude nutné dělat úpravy tak, že by to znamenalo zpětnou nekompabilitu. Za nás můžeme říct, že podpora dalších zemí je stále priorita a upustili jsme od myšlenky zveřejňovat země postupně po jedné v rámci všech služeb. V budoucí aktualizaci počítáme se zveřejněním více zemí a nebudou to jen jednotky. Aktuální dostupnost služeb dle zemí naleznete zde. 

Důležité informace pro uživatele staré verze

Pokud používáte starou verzi API, nemusíte se bát, že by vám Foxentry přestalo fungovat ze dne na den. Stará verze bude k dispozici minimálně ještě půl roku, nicméně i tak vám doporučujeme přejít na novou verzi co nejdřív, vzhledem k o dost větším benefitům. Nejzazší termín pro přechod na nové API je stanoven na 1. 3. 2024.

V API 2.0 je také brán ohled na verzování a zpětnou kompabilitu, tudíž všechny nové aktualizace nebudeme řešit takto "razantně".

Co nás čeká v nejbližší době

Momentálně pracujeme na nové JS knihovně, která dovolí využití nového API i pro webové projekty. Součástí nové JS knihovny bude i celkové zlepšení UX pro vyplňování formulářů a slibujeme si tak od toho opravdu hodně. Z menších dílčích věcí pak právě dokončujeme například napojení na MAKE či Zapier. Je toho ovšem daleko víc a ovšem vás budeme informovat. 

Zajímá vás více? Představíme vám API osobně