Development Newsletters
Release: 20-09-2023
Lista wprowadzanych zmian:
Nowa dokumentacja API
Prezentujemy nową dokumentację API: https://doc.adocean-global.com/.
Uwaga: Stara dokumentacja dostępna będzie jeszcze przez jakiś czas pod dotychczasowym adresem: https://adocean-global.com/en/product/api/, po 20 września zostanie ona wyłączona a adres zostanie przekierowany na adres nowej dokumentacji. W związku z opisaną niżej funkcjonalnością wbudowanego formularza API, wyłączony zostanie także stary formularz znajdujący się obecnie pod adresem https://api.adocean.pl.
Uwaga: Adres samego API nie ulega zmianie, zmienia się tylko dokumentacja.
Najważniejsze zmiany:
Odświeżony widok
Prezentujemy nowy, bardziej przejrzysty i bardziej przyjazny format dokumentacji, dzięki czemu korzystanie z niej będzie teraz zdecydowanie przyjemniejsze.
Wyszukiwarka operacji i parametrów
Od teraz zapoznawanie się z możliwościami API czy wyszukiwanie potrzebnych komend będzie o wiele łatwiejsze - wystarczy wpisać w pole wyszukiwania fragment nazwy poszukiwanej operacji lub nazwę występującego w niej parametru:
Wbudowany formularz API
Nowa dokumentacja zawiera w sobie zarówno funkcjonalność starej dokumentacji, jak i formularza API dostępnego pod adresem https://api.adocean.pl. Innymi słowy, umożliwia ona wysyłanie żądań API od razu z poziomu dokumentacji:
Pozwala także podejrzeć przykłady odpowiedzi oraz schemat obiektów:
Możliwość skopiowania żądania HTTP za pomocą cURL
Po wysłaniu zapytania, można je wyświetlić za pomocą polecenia CURL:
Możliwość zmiany formatu odpowiedzi
Istnieje także możliwość wyboru formatu odpowiedzi: XML lub JSON. Można to zrobić w zakładce API Servers (JSPN/XML):
Możliwość zapisania klucza API
Aby ułatwić korzystanie z dokumentacji, wprowadziliśmy możliwość zapisania sesji w zakładce Authentication. Po wprowadzeniu ID nowo otwartej sesji, będzie ono automatycznie kopiowane do każdej funkcji: