Twoje funkcje biznesowe. Kontrakt, który je udostępnia.
Projektujemy API REST udostępniające potrzebne operacje przez czytelne zasoby, kontrole serwerowe i przewidywalne odpowiedzi.
Wybierz pola, uprawnienia, błędy i reguły, które porządkują wymianę.
Zrozumiałe trasy. Reguły we właściwym miejscu.
Każda operacja opisuje wejścia, uprawnienia, rezultat i błędy, zanim stanie się trasą.
Dla aplikacji, portalu lub partnera potrzebującego dostępu do funkcji serwera.
Czytelna wymiana. Ustalona odpowiedzialność.
Modelować zasoby
Nazywać obiekty, relacje i operacje według zastosowań, a nie tylko struktury bazy.
Walidować żądania
Kontrolować formaty, tożsamość i uprawnienia na każdej udostępnionej granicy.
Dokumentować odpowiedzi
Opisać statusy, błędy i przykłady ułatwiające integrację oraz odbiór.
Przepływy. I narzędzia do ich nadzorowania.
- 01
Trasy REST i kontrakty w uzgodnionym zakresie
- 02
Walidacja i uprawnienia po stronie serwera
- 03
Dokumentacja i scenariusze integracyjne
Stała dostępność, nieograniczona skalowalność i przyszli odbiorcy nie są automatycznie objęci zakresem.
Każdy system ma swój kontekst.
Używane narzędzia, właściciele danych, przykładowe komunikaty, dokumentacja i dozwolone dostępy: ustalamy dostępne materiały oraz decyzje do podjęcia.
- 01
Obserwacja
Źródła, odbiorcy i istotne zdarzenia.
- 02
Ustalenie kontraktu
Dane, błędy, uprawnienia i kryteria odbioru.
- 03
Połączenie
Wymiana prezentowana i sprawdzana w trakcie prac.
- 04
Przekazanie
Scenariusze kontroli, dokumentacja i wdrożenie użytkowników.
Przepływ do ponownego sprawdzenia. Odchylenia do rozpoznania.
Odtwarzamy uzgodnione scenariusze na odpowiednich danych, obserwujemy oczekiwane błędy i ustalamy warunki przekazania. Dalsze prace mają osobny zakres.
Przydatne pytania.
Czy API musi udostępniać wszystko?+
Nie. Udostępniamy tylko operacje potrzebne w uzgodnionym procesie i niezbędne minimum danych.
Czy trzeba mieć całą dokumentację?+
Zaczynamy od dostępnych kontraktów, przykładów i środowisk. Niewiadome oraz potwierdzenia wymagane od dostawcy zapisujemy przed integracją.
Czy można zacząć od jednego przepływu?+
Tak. Pierwszy etap może połączyć jedno źródło z jednym odbiorcą, z określonymi błędami, uprawnieniami i kryteriami odbioru.
Twoje narzędzia mogą pracować razem.
Opisz, jakie informacje mają przepływać, kto za nie odpowiada i jaka czynność ma stać się prostsza.
Opisać mój projekt