Zarządzanie API

Otwarte interfejsy. Jasne granice.

Partnerzy i aplikacje potrzebują interfejsów, na których zachowaniu mogą polegać. Projektujemy kontrakty API, konfigurujemy dostęp i zabezpieczenia na bramie API (API Gateway) oraz zarządzamy wersjami, dokumentacją i zatwierdzeniami w całym cyklu życia.

Czym się zajmujemy Omówmy przedsięwzięcie

Polityka API i katalog interfejsów · planowanie i realizacja przez OTOKO®

Państwa zlecenie dla OTOKO®

Czym się dla Państwa zajmujemy.

Zaczynamy od procesów biznesowych podłączanych systemów: jakich danych potrzebują, jakie stany mogą zmieniać i jak rozpoznają błędy? REST, GraphQL lub gRPC wybieramy w zależności od zastosowania. Opis wykorzystuje format odpowiadający danemu protokołowi, na przykład OpenAPI dla odpowiednich API HTTP. Oprócz danych właściwych ustalamy paginację, limity czasowe, odpowiedzi błędów i zachowanie przy ponawianiu żądań. Przykłady i przypadki testowe pomagają zespołom korzystającym z interfejsu zintegrować go jeszcze przed zatwierdzeniem do produkcji.

Możliwy zakres usług

Polityka API z konwencjami nazewnictwa, formatami błędów, wersjonowaniem i wymaganiami bezpieczeństwa
Katalog interfejsów ze specyfikacją OpenAPI i osobą odpowiedzialną dla każdego API
Budowa bramy z użyciem Kong, Apigee lub Azure API Management, integracja z Państwa systemem zarządzania tożsamością przez OAuth 2.0 i OpenID Connect
Portal dla partnerów i deweloperów z zarządzaniem dostępem, kluczami i raportami użycia
Cykl życia z procesem zatwierdzania, wycofywaniem starych wersji i powiadomieniami o zmianach

Konkretny zakres, Państwa udział i kryteria odbioru ustalamy przed rozpoczęciem.

Technika przedstawiona w zrozumiały sposób

Jak realizujemy to zadanie.

Brama API i aplikacja odpowiadają za różne kontrole

Brama API może zarządzać dostępem, ograniczać liczbę żądań i wymuszać reguły techniczne. To, czy konkretny użytkownik może odczytać dane konkretnego zamówienia, musi dodatkowo rozstrzygnąć właściwa usługa. Zgodnie z tym podziałem planujemy weryfikację tokenów, tożsamości usług, przypisanie do dzierżawcy oraz rejestrowanie zdarzeń. Dla wywołań zapisujących określamy sposób obsługi ponawianych żądań. Stare wersje otrzymują przejrzysty proces wycofywania, aby zmiany nie przerywały niespodziewanie integracji z partnerami.

Odbiór z udziałem konsumentów API

Testy kontraktowe sprawdzają zadeklarowaną strukturę; testy integracyjne i obciążeniowe uzupełniają obraz zachowania. Testujemy odrzucone żądania dostępu, nieprawidłowe dane wejściowe i przekroczenia czasu, podobnie jak udane wywołania. Przekazanie obejmuje specyfikację, konfigurację bramy API oraz zakresy odpowiedzialności. Na start potrzebujemy typowych konsumentów API, założeń dotyczących obciążenia oraz procesów biznesowych, które API ma umożliwiać.

Wynik możliwy do zweryfikowania

Z tym mogą Państwo dalej pracować.

Polityka API i katalog interfejsów
Gotowa do eksploatacji brama API z integracją zarządzania tożsamością
Portal dla deweloperów z dokumentacją każdego API

Przekazanie łączy realizację z dokumentacją. Wspólnie sprawdzamy uzgodnione przypadki i zapisujemy pozostałe zadania.

Państwa przedsięwzięcie w szczegółach

Eksploatacja interfejsów jako kontrolowanego dostępu do Państwa systemów.

Projektujemy interfejsy API tak, aby zespoły wewnętrzne i partnerzy zewnętrzni mogli z nich niezawodnie korzystać. Obejmuje to zrozumiały kontrakt, jasne prawa dostępu oraz eksploatację, która obsługuje błędy i przeciążenia w widoczny sposób.

Od funkcji biznesowej do stabilnego kontraktu API

Interfejs API powinien udostępniać zrozumiałą funkcję biznesową, a nie przekazywać na zewnątrz niefiltrowanych tabel systemu wewnętrznego. Wspólnie z zespołami korzystającymi z interfejsu definiujemy zasoby, akcje, pola obowiązkowe i odpowiedzi na błędy. Przykładowe dane i opis w formacie odczytywalnym maszynowo ułatwiają integrację; reguły biznesowe pozostają wyraźnie udokumentowane.

Zmiany są oceniane pod względem ich wpływu. Dodatkowe pole opcjonalne wymaga innego podejścia niż nowa wartość obowiązkowa lub zmienione znaczenie pola. Planujemy wersjonowanie, okresy przejściowe oraz informowanie znanych użytkowników. Dzięki temu wewnętrzna aktualizacja bazy danych nie musi od razu psuć wszystkich podłączonych aplikacji.

Wspólne zabezpieczanie bramy API, tożsamości i backendu

Na poziomie bramy API można wdrożyć centralne reguły uwierzytelniania, ograniczania liczby żądań i routingu. Uprawnienie biznesowe musi jednak być sprawdzane w odpowiedzialnej za to usłudze: prawidłowo zalogowany klient nie może automatycznie odczytywać rekordów innego klienta. Dlatego analizujemy cały łańcuch żądania.

Na potrzeby eksploatacji uzgadniamy budżety czasu odpowiedzi, limity czasu oraz sposób obsługi ponownych prób. Identyfikatory korelacji łączą logi z wielu systemów, bez zapisywania z zasady wrażliwych treści żądań. Dostęp dla programistów z przykładami i odpowiednim środowiskiem testowym pomaga partnerom wykryć błędy jeszcze przed produkcyjnym podłączeniem.

Poglądowy scenariusz projektu

Jak usługa pomaga w codziennej pracy.

Przykład: partnerzy biznesowi mają mieć możliwość sprawdzania statusu swoich zamówień. Udostępniamy wyodrębniony interfejs API, przypisujemy dostęp do właściwej organizacji i chronimy system ERP przed niekontrolowanym obciążeniem. Wewnętrzne zmiany statusu są przekształcane w stabilne odpowiedzi zewnętrzne.

Ten przykład opisuje możliwy przebieg i nie jest referencją klienta.

Przed pierwszym krokiem

Zarządzanie API: Państwa pytania.

Czy brama API wystarcza do zapewnienia bezpieczeństwa?

Nie. Uzupełnia ona weryfikację bezpieczeństwa aplikacji. Uprawnienia biznesowe i bezpieczne przetwarzanie danych muszą być zapewnione w usługach, które za nie odpowiadają.

Czy zewnętrzni partnerzy mogą otrzymać środowisko testowe?

Tak, jeśli zakres i dostęp do danych są uzgodnione. Planujemy odrębne środki dostępu, odpowiednie dane testowe oraz ścieżkę zatwierdzenia do produkcji.

Państwa przedsięwzięcie

Jakie zadanie chcą Państwo rozwiązać?

Proszę opisać swoją sytuację wyjściową i oczekiwany wynik. Wybrana usługa zostanie uwzględniona w zapytaniu kontaktowym.

Zapytaj o tę usługę

Menu

Otwarte interfejsy. Jasne granice.