Czym jest API?
API (Application Programming Interface) to zestaw reguł i procedur, które umożliwiają aplikacjom komunikację i współdziałanie. Kluczowe zagadnienia w kontekście API obejmują:
- Procedury API: Dokumentacja API zawierająca zalecenia biznesowe i funkcjonalności.
- Protokoły API: Protokoły takie jak HTTP/HTTPS, REST, SOAP, które określają sposób komunikacji między aplikacjami.
- Narzędzia API: Narzędzia takie jak Postman czy Swagger, które pozwalają programistom testować funkcje API.
Rodzaje interfejsów programowania API
- SOAP API (Simple Object Access Protocol): Protokół komunikacyjny oparty na modelu językowym XML.
- REST API (Representational State Transfer): REST wykorzystuje standardowe metody, takie jak HTTP, GET, POST, PUT i DELETE.
Czym jest API KSeF?
API KSeF (Krajowy System e-Faktur) to interfejs programowania aplikacji, który umożliwia komunikację pomiędzy systemami ERP organizacji a centralnym rejestrem faktur prowadzonym przez administrację skarbową. Działa jako łącze przesyłu danych, które zostało udostępnione przez Ministerstwo Finansów, umożliwiając integrację systemów ERP oraz narzędzi zewnętrznych z pomocą interfejsu API KSeF.
Dzięki API KSeF, odbiorcy faktur mogą odbierać faktury ustrukturyzowane w zewnętrznych narzędziach, eliminując konieczność korzystania z aplikacji udostępnionej przez Ministerstwo Finansów. Wystawcy faktur również mogą wystawiać faktury ustrukturyzowane bezpośrednio z zewnętrznych systemów, co zwiększa efektywność procesów księgowych.
W procesie wystawiania faktur, API KSeF zwraca informację o poprawności technicznej przesyłanych danych. W przypadku pozytywnej walidacji, system nadaje unikalny numer identyfikujący fakturę – numer KSeF – oraz generuje UPO (Urzędowe Poświadczenie Odbioru) dla podatnika.
Rodzaj programowania interfejsu API KSeF
API KSeF występuje w modelu REST API (Representational State Transfer). Udostępniony interfejs API przez Ministerstwo Finansów wykorzystuje standardowy protokół dla modelu REST API, czyli HTTP GET lub POST. Dokumentacja opublikowana przez Ministerstwo Finansów opisuje interfejs REST API jako umożliwiający kompleksową realizację obsługi faktur ustrukturyzowanych w systemie KSeF.
Szczegółowa definicja interfejsu API jest dostępna w formacie zgodnym z OpenAPI i można ją pobrać w formie pliku JSON. KSeF API dostępne jest również w formie interfejsu Swagger.