Tworzenie interfejsów

Podwójne wprowadzanie danych generuje koszty każdego dnia.

Gdy systemy ERP, CRM, portale i aplikacje specjalistyczne przechowują różne wersje prawdy, powstają błędy i konieczność poprawek. Łączymy Państwa systemy za pomocą udokumentowanych interfejsów, ustalamy wiodące źródło danych i dbamy o to, by transfery danych pozostawały możliwe do prześledzenia także w przypadku zakłóceń.

Zobacz zakres usługi Omówmy przedsięwzięcie

Od sformułowania zadania po udokumentowane przekazanie.

Kiedy ta usługa pomaga

Tworzenie interfejsów: co mogą nam Państwo zlecić.

Łączenie systemów ERP, CRM i aplikacji specjalistycznych
Umożliwienie dostępu partnerom przez API
Ograniczenie eksportów plików i ręcznego podwójnego wprowadzania danych

Łączymy systemy ERP, CRM, maszyny i aplikacje partnerskie za pomocą odpowiednio dobranych interfejsów. Obejmuje to udokumentowane kontrakty API, zabezpieczony dostęp i kontrolowane zmiany wersji. W zależności od procesu w grę wchodzą bezpośrednie zapytania, zdarzenia lub zaplanowane przesyłanie plików. Decydujące znaczenie mają poprawne dane, rozpoznawalne błędy i eksploatacja, którą można sprawnie zarządzać.

Co może wchodzić w zakres zlecenia

Projektowanie API jako kontraktu z użyciem OpenAPI lub GraphQL, przegląd ze wszystkimi konsumentami
Uwierzytelnianie i autoryzacja z użyciem OAuth 2.0 i OpenID Connect w Keycloak
Brama API (API Gateway) z ograniczaniem liczby żądań, zarządzaniem kluczami i rejestrowaniem zdarzeń dla każdego konsumenta
Integracja sterowana zdarzeniami z użyciem Apache Kafka, ponawianie i identyfikowalność każdej wiadomości
Testy kontraktowe i wersjonowanie z udokumentowanym wycofywaniem starych wersji

Konkretny zakres, odbiory i zaangażowanie Państwa strony ustalamy w ofercie.

Powiązania na pierwszy rzut oka

Łączenie danych to łączenie odpowiedzialności.

01
Źródło
Określenie danych wiodących i zakresu odpowiedzialności
02
Kontrakt
Zdefiniowanie znaczenia, uprawnień i błędów
03
Przesyłanie
Obsługa ponownych prób i kolejności
04
Uzgadnianie
Sprawdzanie wyników i obsługa rozbieżności

Planowanie, realizacja i decyzje

Tworzenie interfejsów: co jest najważniejsze.

Najpierw odpowiedzialność za dane, potem ich przesyłanie

Połączenie techniczne można nawiązać szybko; trudniejsze jest pytanie, który system ma rację w przypadku sprzecznych danych. Określamy wiodące źródła, klucze i stany biznesowe. Pola obowiązkowe, strefy czasowe, jednostki oraz znaczenie operacji usunięcia danych są uzgadniane między zaangażowanymi zespołami.

Kontrakt interfejsu zawiera przykłady i przypadki błędów, a nie tylko nazwy pól. Dzięki temu działy biznesowe mogą sprawdzić, czy zdarzenie faktycznie ma zamierzone znaczenie. Przed wdrożeniem ustalamy również, jak migrowane są dane historyczne i jak nowe zmiany są przetwarzane oddzielnie od nich.

Synchronicznie, w oparciu o zdarzenia lub jako zaplanowane uzgadnianie danych

Bezpośrednie zapytanie do API sprawdza się, gdy odpowiedź jest potrzebna natychmiast. Zdarzenia rozprzęgają procesy, ale wymagają starannego podejścia do kolejności, ponawiania i opóźnionych wiadomości. Dla niektórych systemów istniejących bardziej opłacalnym rozwiązaniem pozostaje kontrolowany import wsadowy. Wzorzec integracji dobieramy odpowiednio do procesu i możliwości systemów.

Zdublowane wiadomości nie mogą na przykład wywoływać podwójnych zamówień. Dlatego uwzględniamy jednoznaczne identyfikatory operacji, możliwość bezpiecznego powtarzania oraz uzgadnianie merytoryczne. Wiadomości, których nie można przetworzyć, wymagają widocznej ścieżki obsługi błędów z przypisaną odpowiedzialnością, zamiast niezauważonej utraty danych.

Interfejsy jako usługa gotowa do eksploatacji

Dostęp jest rozgraniczany dla każdej aplikacji lub partnera osobno. Uprawnienia, ograniczanie liczby żądań, rejestrowanie zdarzeń i sposób postępowania z danymi dostępowymi są częścią koncepcji integracji. Brama API może łączyć te reguły w jednym miejscu, ale nie zastępuje weryfikacji merytorycznej w aplikacji.

Wersjonowanie i terminy wycofania starych wersji chronią podłączone systemy przed nieoczekiwanymi zmianami. Testy kontraktowe sprawdzają zgodne zachowanie, a monitoring uwidacznia awarie i zatory. Przekazanie obejmuje przykładowe wywołania, osoby kontaktowe oraz procedurę postępowania z błędnymi transferami.

Narzędzia dobrane do zadania

Technologia dopasowana do Państwa środowiska.

OpenAPI
GraphQL
gRPC
Apache Kafka
Keycloak
Kong

Wybór zależy od istniejących systemów, Państwa zespołu i późniejszej eksploatacji. Nie każdy projekt wymaga wszystkich wymienionych technologii.

Dla osób odpowiedzialnych merytorycznie i zespołów technicznych

Decyzje stojące za realizacją.

Ponawianie, kolejność i uzgadnianie merytoryczne

Po przekroczeniu limitu czasu interfejs nie zawsze może rozpoznać, czy druga strona zdążyła już przetworzyć zlecenie. Ślepe ponawianie może wówczas wygenerować podwójne księgowania. Dla operacji zapisujących ustalamy, w jaki sposób jednoznaczny identyfikator pozwala przyporządkować ponawiane żądania oraz jak długo ta informacja jest przechowywana. Sam identyfikator nie wystarczy: przetwarzanie i zapisywanie wyniku muszą pasować do modelu transakcyjnego.

W przypadku zdarzeń dodatkowo uwzględniamy kolejność i opóźnione doręczenie. Anulowanie może dotrzeć, zanim usługa znajdująca się dalej w łańcuchu przetworzy pierwotne zamówienie. Dopuszczalne przejścia między stanami i informacje o wersji pomagają obsłużyć takie przypadki merytorycznie. Kolejki błędów wymagają przypisanej odpowiedzialności i kontrolowanego ponownego uruchomienia. Regularne uzgadnianie ważnych zbiorów danych wykrywa różnice, których nie wychwyci samo monitorowanie poprawnych odpowiedzi HTTP.

Rozwijanie kontraktów bez zaskakiwania podłączonych zespołów

Kontrakt API opisuje oprócz typów danych również ich znaczenie, przypadki błędów i ograniczenia. Ustalamy, czy brakujące pole, pusta wartość i wyraźne usunięcie to różne operacje. Kwoty pieniężne wymagają waluty i reguł zaokrąglania, a dane czasowe jednoznacznego odniesienia. W przypadku dużych zbiorów danych do kontraktu należą paginacja, możliwości filtrowania i stabilne sortowanie. Przykładowe zapytania pozwalają konsumentom zweryfikować te reguły.

Nawet pozornie addytywne zmiany mogą być problematyczne, jeśli klient akceptuje wyłącznie znane wartości. Dlatego rejestrujemy konsumentów i sprawdzamy zmiany pod kątem ich oczekiwań. Nowe wersje otrzymują ścieżkę przejściową z dokumentacją, możliwością testowania i planem wycofania starej wersji. Dla webhooków ustalamy weryfikację pochodzenia oraz sposób postępowania z wielokrotnym doręczeniem. Możliwa do prześledzenia historia integracji pomaga wsparciu technicznemu śledzić konkretną sprawę biznesową w wielu systemach.

Ograniczanie skutków awarii i kontrola dostępu partnerów

Wolny system docelowy nie może generować dowolnej liczby oczekujących połączeń we wszystkich usługach znajdujących się wcześniej w łańcuchu. Planujemy limity czasu, ograniczoną liczbę ponownych prób i granice wydajności dopasowane do procesu biznesowego. Niektóre zadania można buforować, inne muszą kończyć się niepowodzeniem ze zrozumiałą informacją zwrotną. Wartość zastępcza niedziałającej usługi nie może sprawiać wrażenia informacji aktualnej lub zatwierdzonej.

Dostęp dla partnerów i aplikacji jest przyznawany oddzielnie i zaprojektowany tak, by można go było odwołać. Samo ograniczanie liczby żądań nie zapobiega niedozwolonemu dostępowi do danych; dodatkowo sprawdzane są uprawnienia merytoryczne. Dzienniki zdarzeń mają umożliwiać analizę błędów bez ujawniania danych dostępowych ani pełnych, wrażliwych danych użytkowych. Do przekazania należą dlatego również odnawianie dostępu, alarmowanie w przypadku zatorów oraz procedura celowego ponownego przetwarzania błędnych wiadomości.

Przejrzyste rezultaty prac

Co trafia w Państwa ręce.

Rezultat 01

Kontrakty API z dokumentacją i przykładowymi wywołaniami

Rezultat 02

Konfiguracja bramy API z koncepcją uprawnień

Rezultat 03

Testy kontraktowe i zasady wersjonowania

Przykładowy przebieg projektu

Tak może wyglądać realizacja.

Portal klienta ma łączyć statusy zamówień z systemów ERP i logistyki. Jednoznaczne identyfikatory zamówień łączą te dane. Spóźnione komunikaty o wysyłce są przetwarzane po ich nadejściu; użytkownicy widzą spójny, możliwy do prześledzenia status zamiast sprzecznych informacji.

Scenariusz poglądowy, nie referencja klienta ani gwarancja rezultatu.

To ułatwia start

Dokumentacja API i dostępy testowe do zaangażowanych systemów
Przykładowe zbiory danych z objaśnieniem merytorycznym
Osoby odpowiedzialne za każde źródło danych i interfejs

Brak dokumentów nie wyklucza rozpoczęcia współpracy. Wspólnie ustalamy, jakie informacje należy pozyskać w pierwszej kolejności.

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

Łączenie oprogramowania bez utraty reguł biznesowych.

Tworzymy interfejsy w ramach Państwa przedsięwzięć programistycznych, a także interfejsy do istniejących systemów dziedzinowych. Chodzi przede wszystkim o to, aby proces biznesowy pozostawał kompletny i możliwy do prześledzenia również wtedy, gdy przebiega przez wiele aplikacji.

Wyjaśnianie znaczenia biznesowego przed przypisaniem pól

Pola o tej samej nazwie mogą zawierać różne treści. Uzgadniamy statusy, identyfikatory, strefy czasowe i jednostki z zaangażowanymi zespołami. Dla każdego przepływu danych określane jest, który system jest źródłem wiążącej informacji i w jaki sposób przekazywane są późniejsze korekty.

Kontrakt interfejsu opisuje również błędy i przypadki szczególne. Brakujące dane obowiązkowe, niedostępne systemy docelowe oraz niedozwolone zmiany stanu wymagają różnych reakcji. Przykłady i testy sprawiają, że te reguły można zweryfikować jeszcze przed ukończeniem całej aplikacji specjalistycznej.

Uwzględnianie ponownych prób, kolejności i diagnostyki

Przerwy w sieci mogą pozostawiać niejasność co do tego, czy dana czynność zakończyła się już powodzeniem. Stosujemy odpowiednie identyfikatory operacji i mechanizmy uzgadniania, aby ponowna próba nie spowodowała niezamierzenie drugiego zamówienia lub księgowania. To, jaki poziom gwarancji jest osiągalny, zależy od obu zaangażowanych systemów.

Na potrzeby bieżącej eksploatacji umożliwia się korelowanie procesów ponad granicami systemów. Zespół wsparcia ma być w stanie rozpoznać, na jakim etapie znajduje się przetwarzanie, bez zapisywania w logach pełnych poufnych danych użytkowych. Zmiany kontraktu podlegają uzgodnionemu wersjonowaniu i są testowane względem znanych konsumentów interfejsu.

Poglądowy scenariusz projektu

Jak usługa pomaga w codziennej pracy.

Przykład: nowa aplikacja tworzy zamówienia w systemie ERP. Po przekroczeniu limitu czasu sprawdza na podstawie jednoznacznego numeru referencyjnego, czy zamówienie już istnieje. Użytkownik otrzymuje zrozumiały status, zamiast przypadkowo generować kolejne zamówienia przez ponowne kliknięcie.

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

Przed zleceniem

Tworzenie interfejsów: Państwa pytania.

Czy mogą Państwo zintegrować systemy bez nowoczesnego API?

W zależności od systemu możliwy jest import plików, zastosowanie adaptera lub zatwierdzony dostęp do bazy danych. Sprawdzamy przy tym zgody producenta, ryzyko związane ze zmianami oraz późniejsze utrzymanie. Bezpośredni dostęp do wewnętrznych struktur danych może być niestabilny i nie jest traktowany jako pełnoprawny zamiennik stabilnego API.

Jak obsługiwane są zdublowane lub nieudane transfery danych?

Planujemy identyfikatory operacji, kontrolowane ponawianie oraz merytoryczne uzgadnianie danych. Przypadki, których nie da się rozwiązać automatycznie, trafiają do widocznego procesu obsługi błędów. To, która ponowna próba jest bezpieczna, zależy od przypadku biznesowego: odczyt danych i zainicjowanie płatności wymagają innych reguł.

Czy czas rzeczywisty jest zawsze konieczny?

Nie. Decydujące jest to, jak aktualna musi być informacja dla danego procesu pracy. Zaplanowane uzgadnianie danych może być wystarczające i prostsze w eksploatacji. W przypadku decyzji krytycznych czasowo wyraźnie uzgadniamy opóźnienie, zachowanie w razie awarii i spójność danych.

Kolejny krok

Prosimy powiedzieć nam, gdzie dziś pojawiają się trudności.

Do rozpoczęcia wystarczy krótki opis Państwa aplikacji, problemu i celu. Wybrana usługa zostanie uwzględniona w Państwa zapytaniu kontaktowym.

Zapytaj o tę usługę

Menu

Podwójne wprowadzanie danych generuje koszty każdego dnia.