SłownikAPI
API definiuje ustrukturyzowany sposób wymiany danych lub żądania operacji między systemami. W programie może łączyć zakupy, uprawnienia, punkty lub zamówienia. Kontrakt, uwierzytelnianie, błędy, limity i poprawki muszą być udokumentowane, aby integracja była użyteczna.
Konkretny przykład
Interfejs API może odbierać zweryfikowane zamówienie i zwracać jego identyfikator przetwarzania. Unikalny identyfikator zapobiega dwukrotnemu uznaniu tej samej transakcji.
Kwestia do rozważenia
Samo zatwierdzenie przypadku nominalnego jest niewystarczające. Uwierzytelnianie dokumentów, duplikaty, błędy, ponowne próby i limity częstotliwości.
Przygotuj umowę, z której mogą korzystać oba zespoły
Dla każdej wymiany podaj zaakceptowany przykład, odrzucony przykład, wymagane pola oraz reguły wznawiania. Zdefiniuj identyfikator korelacji, aby śledzić transakcję między systemami. Przetestuj przerwanie po przetworzeniu, ale przed otrzymaniem odpowiedzi: wznowienie musi pobrać wynik bez tworzenia drugiego kredytu. Zaplanuj również śledzenie odrzuceń i zapewnienie zgodności wersji.
Pytania do zespołu
- Czy możemy ustalić, czy transakcja została przetworzona po awarii?
- Czy tymczasowe błędy i nieprawidłowe dane są obsługiwane w inny sposób?
Rozwijaj swoją sieć kontaktów.
Białe księgi