Cieszymy się, że po pewnym czasie możemy podzielić się z Wami nowymi informacjami na temat Foxentry. I nie chodzi o to, że dzieciaki wróciły do szkoły. Tym razem mamy naprawdę dużą nowość – Foxentry API 2.0.
Nie musisz zwlekać, po prostu spójrz na naszą nową dokumentację i sprawdź, co się zmieniło.
Foxentry API 2.0
Zmiany zauważysz od samego początku. Ostatnio zrezygnowaliśmy z Blueprint z Apiary na rzecz specyfikacji OpenAPI, która jest bardziej nowoczesna i powszechnie stosowana. Dzięki temu teraz możesz swobodnie testować poszczególne punkty końcowe, gdziekolwiek uznałeś to za stosowne. To zdecydowanie ułatwia import do różnych narzędzi, takich jak Postman czy Spotlight.
Zadowolony programista = spokojny menadżer
Dzięki nowemu API dokonaliśmy także rewizji ogólnego podejścia do doświadczenia programistycznego. Zawsze kierowaliśmy się przekonaniem, że wdrożenie Foxentry to sprawa zaledwie kilku minut, a naszym użytkownikom oferowaliśmy interfejs, który umożliwiał łatwą konfigurację. Jednakże, w przypadku bardziej złożonych połączeń poprzez API, musimy przyznać, zostaliśmy trochę w tyle. Postanowiliśmy to zmienić i we współpracy z firmą DX heroes rozpoczęliśmy długotrwałe doskonalenie Developer Experience. Możesz oczekiwać nowy Developer Hub, gotowe SDK, opcje No Code i wiele innych świetnych funkcji, które stopniowo będziemy udostępniać na portalu Foxentry.dev.
A więc, co nowego?
Przede wszystkim udostępniamy szereg nowych endpoinów do wykorzystania. Teraz masz możliwość skorzystania np. z jednoinputowego autouzupełnienia adresów, odwrotnego geokodowania (dostępnych adresów w danej lokalizacji GPS) czy autouzupełnienia najpopularniejszych domen mailowych zgodnie z geolokalizacją. Pełną listę aktualnych endpointów znajdziesz w poniższej tabeli:
| Name | URL | Description |
|---|---|---|
| Validate company data | /company/validate | Walidacja różnych parametrów firmy i ich kombinacji. |
| Search company | /company/search | Autouzupełnianie danych firmowych. |
| Get company data | /company/get | Uzyskanie dodatkowych informacji o firmie. |
| Validate e-mail | /email/validate | Weryfikacja adresów e-mail i kontrola dostarczalności. |
| Search e-mail | /email/search | Autouzupełnianie adresów e-mail. |
| Validate location data | /location/validate | Walidacja różnych danych lokalizacyjnych i ich kombinacji. |
| Search location | /location/search | Autouzupełnianie adresów. |
| Get location data | /location/get | Uzyskanie dodatkowych informacji o lokalizacji. |
| Localization | /location/localize | Zwrócenie listy adresów w podanej lokalizacji GPS. |
| Validate name data | /name/validate | Walidacja imion i nazwisk. |
| Validate phone number | /phone/validate | Walidacja numerów telefonów i ich podłączenia do sieci. |
Nowa logika response
Logika response przeszła kompleksową metamorfozę - teraz dokładnie analizujemy i oceniamy znaczenie informacji wejściowych osobno. Dzięki temu jesteśmy w stanie natychmiastowo automatycznie poprawić dane (resultCorrected) lub nawet zaproponować bardziej satysfakcjonującą alternatywę, nawet jeśli informacje są poprawne (suggestions). To umożliwia dostarczenie Twoim programistom kompleksowego narzędzia o różnorodnych zastosowaniach. Nie tylko mogą określać ważność danych, ale także automatycznie poprawiać i strukturyzować je według własnych potrzeb.
W response szczegółowo opisano, co dokładnie jest nieprawidłowe w zatwierdzonych informacjach oraz określono wagę błędów. Ponadto Foxentry dostarcza strukturalne korekty i wewnętrzne wskazówki dotyczące sposobu przetwarzania informacji. Innymi słowy, precyzyjnie definiujemy, co i jak powinno być prezentowane użytkownikowi w Twojej aplikacji.
Nowy silnik dla autouzupełnienia i walidacji
W obszarze autocomplete i walidacji dokonaliśmy znaczącego postępu. Aktualnie, dla bardziej złożonych zapytań, korzystamy z sieci neuronowej, co umożliwia nam skuteczniejszą weryfikację nawet najbardziej skomplikowanych błędów użytkowników. Wewnętrzne testy wykazały poprawę dokładności wyników nawet o 37%. W praktyce oznacza to, że użytkownicy mogą popełnić więcej błędów, a mimo to Foxentry jest w stanie wszystko skorygować.
Dodatkowe informacje dotyczące endpointów
Dla każdego endpointu dodano dodatkowe informacje, które mogą wracać w ramach odpowiedzi. Na przykład, podczas walidacji adresu e-mail, teraz można uzyskać informacje o tzw. sygnałach ostrzegawczych, czy dany e-mail jest e-mailem jednorazowym czy freemailem. W przypadku weryfikacji imienia i nazwiska dodaliśmy obsługę poprawnych adresów imion, nazwisk i wszelkich tytułów, a także daty świąt związanych z imionami czeskimi i słowackimi. Wszystkie dostępne informacje są szczegółowo opisane w zakresach danych poszczególnych usług. Tutaj jest przykład zakresu danych dla firmy.
Zaawansowane opcje zapytań i filtry
Aktualnie obsługujemy ponad 2000 klientów, z których wielu regularnie dzieli się z nami swoimi opiniami. Przede wszystkim postanowiliśmy stworzyć nową wersję API, dostosowując ją do zgłaszanych przez nich potrzeb i oczekiwań. Dlatego też zastanowiliśmy się nad różnymi formatami informacji wejściowych i wyjściowych, oferując użytkownikom szeroki zakres opcji dostosowywania odpowiedzi do ich indywidualnych potrzeb. Wierzymy, że jednym z use-casów będzie standaryzacja danych wewnętrznych oraz automatyzacja ich struktury. Wiemy, że wielu z Was codziennie boryka się z koniecznością dostosowywania danych do różnych struktur, co często wymaga znacznego wysiłku. Często, kosztem użytkowników, którzy muszą dostosować się do struktury danych narzuconej przez niektórych właścicieli witryn – struktury, która może być niezgodna z naturalnym sposobem korzystania z serwisu (np. podzielona kolumna zawierająca zarówno numery ulic, jak i opisy, co według naszych testów jest rozwiązaniem wolniejszym i bardziej podatnym na błędy). To samo dotyczy różnych formatów numerów telefonów, danych firmowych itp. Dzięki Foxentry możesz łatwo rozwiązać te problemy retrospektywnie, bez dodatkowego komplikowania procesu składania zamówienia czy wypełniania formularzy przez użytkowników.
Przygotowanie do publikacji nowo obsługiwanych krajów
Jednym z głównych powodów, dla których postanowiliśmy w pierwszej kolejności pracować nad nową wersją API, była konieczność uproszczenia procesu dodawania obsługi nowych krajów. Dotychczas każde wprowadzenie obsługi nowego kraju wiązało się z licznymi skomplikowanymi dostosowaniami oraz zmartwieniami związanymi z różnicami w jakości dostępnych zasobów i ich strukturą. Nowe API umożliwi nam znaczne ułatwienie tego procesu, eliminując konieczność wprowadzania modyfikacji, które mogłyby prowadzić do problemów z kompatybilnością wsteczną. Dla nas priorytetem pozostaje wsparcie dla różnych krajów, i z tego powodu zrezygnowaliśmy z koncepcji wprowadzania obsługi krajów sekwencyjnie na wszystkich serwisach. W przyszłej aktualizacji planujemy udostępnić więcej krajów, a nie tylko jednostki. Aktualną dostępność usług według kraju możesz sprawdzić tutaj.
Ważne ogłoszenie dla użytkowników starej wersji
Jeśli korzystasz jeszcze z poprzedniej wersji API, nie musisz się obawiać, że Foxentry na Twym projekcie nagle przestanie działać. Stara wersja będzie nadal dostępna przez co najmniej pół roku, jednak zalecamy jak najszybsze przejście na nową wersję, ze względu na liczne korzyści, które nowe API oferuje. Ostateczny termin migracji na nowe API to 1 marca 2024 roku.
W API 2.0 wprowadziliśmy również wersjonowanie i kompatybilność wsteczną, co oznacza, że nie będziemy wprowadzać wszystkich nowych aktualizacji w tak "energiczny" sposób.
Co nas czeka w najbliższej przyszłości
Obecnie skupiamy się na opracowywaniu nowej biblioteki JS, która umożliwi integrację nowego API również w projektach webowych. Nowa biblioteka JS obejmie również ogólne ulepszenia w zakresie doświadczenia użytkownika podczas wypełniania formularzy, co jest dla nas szczególnie istotne. Ponadto, pracujemy nad drobnymi, ale istotnymi elementami, takimi jak finalizacja połączenia z MAKE lub Zapierem. To jednak tylko wierzchołek góry lodowej, a o kolejnych planowanych innowacjach będziemy informować na bieżąco.
Pavel Hrdlička
Założyciel Foxentry i generał w walce z niepotrzebnym wklepywaniem danych. Wieloletni miłośnik web designu i inteligentnych rozwiązań, który prowadzi biznes niemal od przedszkola.