słownik automatyzacji

API

API (Application Programming Interface) to zbiór reguł i konwencji określających, jak jeden system może komunikować się z drugim przez sieć lub wewnątrz procesu. W automatyzacji termin API odnosi się najczęściej do interfejsów HTTP (REST lub GraphQL), przez które systemy wymieniają dane w formacie JSON.

REST API to dziś dominujący standard. Opiera się na zasobach (rzeczy, o które pytasz) i metodach HTTP (GET -- pobierz, POST -- stwórz, PUT/PATCH -- zaktualizuj, DELETE -- usuń). Dobra dokumentacja REST API mówi Ci jakie zasoby istnieją, jakiego uwierzytelnienia wymaga i co zwraca przy sukcesie i błędzie. Stripe, Resend, HubSpot -- to wszystko REST API.

GraphQL to alternatywa, gdzie zamiast wielu endpointów masz jeden, przez który pytasz dokładnie o to, czego potrzebujesz. Przydatne gdy frontend chce różnych kombinacji danych, mniej popularne w automatyzacjach backendowych gdzie zazwyczaj wiesz z góry czego potrzebujesz.

Wiele firm ma API, które na papierze istnieje, ale w praktyce jest niestabilne, bez rate limitów, z niejasną dokumentacją albo bez obsługi paginacji. Ocena jakości API dostawcy to pierwsza rzecz, którą sprawdzam zanim zaproponuję integrację.

W praktyce

Integracja z API KSeF (Krajowy System e-Faktur) to dobry przykład API z charakterem. Masz dwa tryby: sesję interaktywną (synchroniczna, jednorazowe faktury) i wsadową (asynchroniczna, batch). Każda sesja wymaga tokena wystawionego na NIP podatnika, podpisanego cyfrowo. Dokumentacja techniczna liczy kilkaset stron. Payload faktury to XML zgodny ze schematem FA(3) Ministerstwa Finansów. Błędy są zwracane jako kody z listy w dokumentacji. To jest API, które wymaga prawdziwej integracji, a nie "podłączenia gotowego node'a".

Zbudowałem tę integrację w n8n z Code nodeami w JavaScript. Każde wysłanie faktury to: walidacja schematu, podpisanie XML, upload przez API wsadowe, polling statusu sesji, odbiór numerów UPO, zapis do bazy.

Powiązane

← Wróć do słownika