Przejdź do treści
Zacznij bezpłatnie

Specyfikacja integracji API

Określ, jak połączone są dwa systemy: jakie dane przepływają, jak są zabezpieczone, jak obsługiwane są błędy i kto za to odpowiada.

Wypełnij i zobacz podgląd

Specyfikacja integracji API

Integracja: Zamówienia ze sklepu do księgowości
Wersja: 1.0
Autor: Hamza Idrissi
Data: 5 kwietnia 2029

1. Cel

Wysyłaj każde opłacone zamówienie ze sklepu internetowego do systemu księgowego jako fakturę sprzedaży, aby dział finansów nie musiał go przepisywać.

2. Systemy

  • Wysyła dane: Sklep internetowy (API v2)
  • Odbiera dane: System księgowy (REST API)

3. Przepływ danych

1. Klient płaci za zamówienie.
2. Sklep wysyła webhook do usługi integracyjnej.
3. Usługa zamienia zamówienie na fakturę i wywołuje API systemu księgowego.
4. System księgowy zwraca numer faktury, który usługa zapisuje przy zamówieniu.

4. Endpointy i komunikaty

Metoda i ścieżka Co robi Główne pola Co zwraca
POST /invoices Utwórz fakturę Treść: klient, pozycje, podatek, suma Zwraca: id i numer faktury
GET /customers?email= Znajdź klienta Zwraca: id klienta lub puste
POST /customers Utwórz klienta Treść: nazwa, e-mail, adres

5. Mapowanie pól

order.total_paid → invoice.total
order.billing_email → customer.email
order.items[].sku → line.product_code

6. Uwierzytelnianie i bezpieczeństwo

OAuth 2.0 client credentials. Tokeny są ważne godzinę. Sekrety są przechowywane w sejfie, nigdy w kodzie. Wszystkie wywołania używają HTTPS. Webhooki są podpisywane, a podpis jest sprawdzany.

Dane osobowe są przesyłane tylko wtedy, gdy są potrzebne, nie są zapisywane w logach i są objęte politykami prywatności obu systemów.

7. Błędy i ponowne próby

Ponawiaj próby przy 429 i 5xx do 5 razy z rosnącymi opóźnieniami. Nie ponawiaj prób przy błędach 4xx; zapisuj je w logach i alarmuj finanse. Każda faktura ma unikalny klucz, więc ponowna próba nie może utworzyć duplikatu.

8. Limity i wolumeny

API systemu księgowego pozwala na 60 wywołań na minutę. Oczekiwane 400 zamówień dziennie, do 2 000 w dni wyprzedaży.

9. Testowanie

Użyj środowiska testowego systemu księgowego. Przetestuj zwykłe zamówienie, zamówienie z rabatem, zwrot, istniejącego klienta i awarię API.

10. Właściciele i wsparcie

Właściciel: zespół e-commerce. Wsparcie: Hamza Idrissi. Eskalacja: pomoc techniczna dostawcy systemu księgowego.

11. Zmiany i wersjonowanie

Każda ze stron zgłasza zmianę niekompatybilną z 30-dniowym wyprzedzeniem.

Wzory to starannie opracowany punkt wyjścia, a nie porada prawna. Gdy znaczenie mają przepisy prawa, sprawdź, które obowiązują w Twojej sytuacji i miejscu.

IT i projekty

Do czego służy ten szablon

Specyfikacja integracji API opisuje połączenie dwóch systemów: cel, przepływ danych, punkty końcowe, uwierzytelnianie, błędy, limity, testy i odpowiedzialność.

Wypełnisz go bezpłatnie online, bez konta, a pobierzesz jako dokument Word lub PDF. Zobacz wszystkie wzory w kategorii IT i projekty

IT i projekty

Co wypełniasz

Formularz pyta o następującą liczbę szczegółów: 16. Dokument uzupełnia się sam, gdy piszesz.

  • Nazwa integracji

    Na przykład: Zamówienia ze sklepu do księgowości

  • Wersja dokumentu

    Na przykład: 1.0

  • Autor

    Na przykład: Hamza Idrissi

  • Data

    Na przykład: 5 kwietnia 2029

  • Cel

    Na przykład: Wysyłaj każde opłacone zamówienie ze sklepu internetowego do systemu księgowego jako fakturę sprzedaży, aby dział finansów nie musiał go przepisywać.

  • System wysyłający dane

    Na przykład: Sklep internetowy (API v2)

  • System odbierający dane

    Na przykład: System księgowy (REST API)

  • Przepływ danych

    Na przykład: 1. Klient płaci za zamówienie. 2. Sklep wysyła webhook do usługi integracyjnej. 3. Usługa zamienia zamówienie na fakturę i wywołuje API systemu księgowego. 4. System księgowy zwraca numer faktury, który usługa zapisuje przy zamówieniu.

  • Endpointy i komunikaty

    Jeden wiersz na punkt końcowy lub wiadomość.

    Na przykład: POST /invoices | Utwórz fakturę | Treść: klient, pozycje, podatek, suma | Zwraca: id i numer faktury GET /customers?email= | Znajdź klienta | Zwraca: id klienta lub puste POST /customers | Utwórz klienta | Treść: nazwa, e-mail, adres

  • Mapowanie pól

    Które pole w źródle trafia do którego pola w systemie docelowym. Opisz, jak konwertowane są wartości.

    Na przykład: order.total_paid → invoice.total order.billing_email → customer.email order.items[].sku → line.product_code

  • Uwierzytelnianie i bezpieczeństwo

    Na przykład: OAuth 2.0 client credentials. Tokeny są ważne godzinę. Sekrety są przechowywane w sejfie, nigdy w kodzie. Wszystkie wywołania używają HTTPS. Webhooki są podpisywane, a podpis jest sprawdzany.

  • Błędy i ponowne próby

    Na przykład: Ponawiaj próby przy 429 i 5xx do 5 razy z rosnącymi opóźnieniami. Nie ponawiaj prób przy błędach 4xx; zapisuj je w logach i alarmuj finanse. Każda faktura ma unikalny klucz, więc ponowna próba nie może utworzyć duplikatu.

  • Limity i wolumeny (opcjonalne)opcjonalnie

    Na przykład: API systemu księgowego pozwala na 60 wywołań na minutę. Oczekiwane 400 zamówień dziennie, do 2 000 w dni wyprzedaży.

  • Testowanie

    Na przykład: Użyj środowiska testowego systemu księgowego. Przetestuj zwykłe zamówienie, zamówienie z rabatem, zwrot, istniejącego klienta i awarię API.

  • Właściciele i wsparcie

    Na przykład: Właściciel: zespół e-commerce. Wsparcie: Hamza Idrissi. Eskalacja: pomoc techniczna dostawcy systemu księgowego.

  • Zmiany i wersjonowanie (opcjonalne)opcjonalnie

    Na przykład: Każda ze stron zgłasza zmianę niekompatybilną z 30-dniowym wyprzedzeniem.

IT i projekty

Co zawiera

Części tego dokumentu, po kolei.

  1. 11. Cel
  2. 22. Systemy
  3. 33. Przepływ danych
  4. 44. Endpointy i komunikaty
  5. 55. Mapowanie pól
  6. 66. Uwierzytelnianie i bezpieczeństwo
  7. 77. Błędy i ponowne próby
  8. 88. Limity i wolumeny
  9. 99. Testowanie
  10. 1010. Właściciele i wsparcie
  11. 1111. Zmiany i wersjonowanie

Wzory dokumentów

Jak to działa

  1. 01

    Wypełnij

    Wpisz swoje dane w formularzu. Dokument uzupełnia się na bieżąco. Kliknij dowolne puste miejsce, aby przejść do odpowiedniego pola.

  2. 02

    Sprawdź

    Przeczytaj cały dokument. Niewypełnione miejsca pozostają oznaczone, aby nie wysłać niegotowego dokumentu.

  3. 03

    Pobierz

    Zapisz dokument w formacie Word, aby dalej go edytować, lub w formacie PDF, aby go wysłać albo wydrukować.

Dostosuj dokument z pomocą AI

Otwórz dokument na czacie i poproś o zmiany: krótszą wersję, bardziej stanowczy ton, dopasowanie do innej sytuacji lub inny język.

Dostosuj z nerix

IT i projekty

Pytania, które zadają ludzie

Jakich danych wymaga ten szablon?

Formularz pyta o następującą liczbę szczegółów: 16, zaczynając od: Nazwa integracji, Wersja dokumentu, Autor, Data, Cel. Kolejne (2) są opcjonalne.

Czy mogę pobrać ten szablon jako Word lub PDF?

Tak. Po wypełnieniu formularza zapisz go jako dokument Word, aby dalej edytować, lub jako PDF, aby wysłać albo wydrukować. Jest bezpłatnie i bez konta.

Czy to, co wpisuję, jest gdzieś wysyłane?

Nie. To, co wpisujesz, zostaje w Twojej przeglądarce podczas wypełniania dokumentu. Do nerix trafia tylko wtedy, gdy zdecydujesz się otworzyć wzór na czacie.

Czy te wzory dla IT i projektów są darmowe?

Większość tak. Wypełnij i pobierz je za darmo jako Word lub PDF, bez konta. Kilka dłuższych dokumentów to wersje premium: wypełnienie jest darmowe, pobranie płatne jednorazowo, a cena jest oznaczona.

Czy polityka bezpieczeństwa daje nam bezpieczeństwo?

Żaden dokument nie zrobi tego sam. Polityka pomaga, gdy odpowiada temu, co ludzie naprawdę robią: niech będzie krótka, wyjaśnij ją zespołowi i przeglądaj co roku.

Czy karta projektu jest tylko dla dużych projektów?

Nie. Mały projekt też na niej zyskuje, bo jedna strona z celem, granicami i osobą decyzyjną zapobiega większości późniejszych sporów.

Wzory dokumentów

Zobacz wszystkie wzory w kategorii IT i projekty

Wzory dokumentów

Inne rodzaje dokumentów

Każda kategoria ma własną stronę, dzięki czemu widzisz wszystkie jej wzory naraz.

Użyj w nerix

Dowiedz się więcej