Przeglądając naszą stronę internetową mogłeś natknąć się na pojęcie API. Skrót ten jest ściśle związany z branżą IT, więc może nie do końca rozumiesz o co chodzi w tej usłudze i jakie korzyści możesz z niej mieć. Omówimy czym jest API i jak działa. Uznaliśmy, że warto zaznajomić Cię z tym tematem, gdyż np. pomoże on rozbudować funkcjonalność Twojego firmowego oprogramowania. Zdecydowaliśmy więc stworzyć trzyczęściową serię, aby porządnie omówić to zagadnienie. Dziś skupimy się na części teoretycznej. W podsumowaniu tego artykułu dowiesz się, co będą zawierały nadchodzące artykuły serii.

 

Rola API

Źródło: https://bykowski.pl/wp-content/uploads/2021/06/api-przyklad-dzialania-1.jpg

 

Powyższy diagram w bardzo prosty sposób przedstawia rolę API. Warto jednak wcześniej odpowiedzieć sobie na pytanie – co to jest w ogóle API? Rozwinięciem skrótu jest interfejs programistyczny aplikacji (ang. application programming interface). Są różne rodzaje API – my posiadamy REST API. Jego znaczenie nie powinno mieć dla Ciebie większego znaczenia, dlatego nie będziemy skupiać się tutaj stricte nad typem API. Interfejs programistyczny aplikacji jest określonym zbiorem rozwiązań za sprawą których możesz korzystać z danych innego serwisu na własnej stronie internetowej lub oprogramowaniu. Co to znaczy? Dysponując w firmie wewnętrznym serwisem do obsługi np. transportowej możesz pobierać dane ze swojego konta w EasyCargo, które następnie zostaną dostarczone wprost do firmowego oprogramowania.

 

Klucz API w EasyCargo

Aby jednak komunikacja z EasyCargo lub innymi oprogramowaniami poprzez API była możliwa, to potrzebujesz jeszcze klucz API. Pozwala on nam identyfikować Twój serwis podczas jego interakcji z EasyCargo. Jeśli chcesz go uzyskać, to skontaktuj się z nami poprzez adres e-mail wsparcie@easycargo3d.com lub używając formularza kontaktowego. Gdy klucz zostanie wygenerowany, możesz go znaleźć z poziomu profilu użytkownika w prawym górnym rogu, po kliknięciu na przycisk Pokaż klucz API.

Uwaga: obchodź się z kluczem API jak z hasłem do konta – zachowaj go tylko dla siebie.

Gdy najważniejsze informacje o API mamy za sobą, to wreszcie możemy przejść do wyjaśnienia roli interfejsu programistycznego aplikacji na podstawie diagramu.

 

Jak działa API

Myślimy, że do tej części artykułu zrozumiałeś już idee działania API. Interfejs programistyczny aplikacji EasyCargo znajdziesz pod tym linkiem. Chcemy jeszcze zwrócić Twoją uwagę na to, że wszystkie przykłady zapytań w dokumentacji API są napisane z użyciem protokołu HTTP. Zalecamy używać bezpieczniejszego protokołu HTTPS.

 

Dokumentacja API w EasyCargo

Podsumowując pierwsza część serii skupiała się głównie na wytłumaczeniu czym jest API i jaka jest jego idea działania. Kolejny artykuł będzie bardziej praktyczny. Postaramy się bliżej zaznajomić Cię z korzystaniem z API do EasyCargo m.in. z użyciem naszego klienta API. Zobaczysz sam, że odpowiednie zapytania do interfejsu programistycznego EasyCargo skutkują uzyskaniem żądanych danych. W ostatniej części serii omówimy co umożliwia komunikacja poprzez API z EasyCargo.

Bartosz Ziółkowski | 21. 03. 2022