Cele biznesowe
Produkty, rynki, role użytkowników, zasady finansowe, ograniczenia i oczekiwany rezultat.
Dokumentacja / Wymagania API
Co przygotować przed podłączeniem API
Zbierz informacje o projekcie, dostępach, danych, bezpieczeństwie i scenariuszach testowych przed rozpoczęciem integracji. Pozwoli to wcześniej określić zakres prac i uniknąć przeróbek.
Zakres
produkty i rynki
Dostęp
klucze i środowiska
Dane
formaty i statusy
Odbiór
weryfikacja scenariuszy
Pakiet wymagań
Co uzgodnić przed rozpoczęciem prac
01
Cele projektu
Produkty, rynki, waluty, dostawcy, użytkownicy i procesy operacyjne.
02
Zasady wymiany danych
Żądania, pola, identyfikatory, statusy, błędy i zdarzenia.
03
Dostęp i bezpieczeństwo
Klucze dostępu, podpisy żądań, dozwolone adresy IP, role i dziennik działań.
04
Testy i odbiór
Dane testowe, scenariusze poprawne i błędne, kontrola wyników i warunki uruchomienia.
Przegląd
Uzgodnione wymagania skracają terminy i liczbę przeróbek
Przed rozpoczęciem prac obie strony powinny jednakowo rozumieć cele projektu, źródła danych, statusy operacji, odpowiedzialność systemów, zasady bezpieczeństwa i warunki odbioru. Wtedy podłączenie opiera się na uzgodnionym schemacie, a nie założeniach.
Zasady podłączenia
Sposoby wymiany danych, struktura żądań i odpowiedzi, identyfikatory, statusy, powiadomienia, błędy i ograniczenia.
Warunki odbioru
Scenariusze testowe, oczekiwane dane, raporty, kontrola działania i warunki przejścia do uruchomienia.
Dane projektu
Dane o projekcie i podłączanych systemach
Najpierw ustalany jest ogólny kontekst: jakie produkty są podłączane, jakie systemy uczestniczą, gdzie przechowywane są dane główne i kto odpowiada za każdy proces.
Zakres i cele projektu
Produkty: kasyno, zakłady sportowe, płatności, KYC, CRM, bonusy, raportowanie lub back office.
Kraje, licencje, waluty, języki, marki i kanały wykorzystania.
Typy użytkowników, role, limity, statusy i główne scenariusze operacyjne.
Priorytety, etapy uruchomienia, funkcje krytyczne i ograniczenia handlowe.
Systemy i właściciele danych
Lista systemów wewnętrznych i zewnętrznych uczestniczących w procesie.
Główne źródło danych o graczu, saldzie, transakcji, zakładzie, bonusie lub weryfikacji KYC.
Dostępne API, bazy danych, kolejki komunikatów, powiadomienia, pliki i starsze interfejsy.
Odpowiedzialne zespoły, kontakty robocze i zasady eskalacji trudnych kwestii.
Wymagania dotyczące podłączenia
Wymagania dotyczące wymiany danych przez API
Dokumentacja powinna umożliwiać wykonanie podłączenia bez zgadywania. Dla każdej operacji wcześniej opisuje się przeznaczenie, dane wejściowe, wynik, możliwe błędy i zasady ponownego wysyłania.
Adresy i metody żądań
Główny adres API, ścieżki żądań, metody HTTP, parametry, nagłówki i przeznaczenie każdej operacji.
Formaty żądań i odpowiedzi
Typy danych, pola wymagane, formaty dat, precyzja kwot, dozwolone wartości puste i przykłady.
Statusy operacji
Pełna ścieżka operacji od utworzenia do zakończenia, dozwolone zmiany i stany końcowe.
Błędy i działania
Kody błędów, jasne przyczyny, możliwość ponownego wysłania i działania systemu odbierającego.
Powiadomienia o zdarzeniach
Struktura zdarzenia, podpis, dostarczanie, potwierdzenie odbioru, ponowne wysyłanie i kolejność przetwarzania.
Ochrona przed duplikatami
Unikalny numer operacji, rozpoznanie ponownego żądania i bezpieczne odzyskanie po awarii.
Limity i obciążenie
Częstotliwość żądań, czas oczekiwania, operacje równoległe, rozmiar odpowiedzi i oczekiwane obciążenie szczytowe.
Zmiana wersji
Wersja API, zgodność ze starszymi integracjami, okres powiadomienia i procedura wprowadzania zmian.
Bezpieczeństwo i dostęp
Wymagania dotyczące bezpieczeństwa i zarządzania dostępem
Przed przekazaniem danych produkcyjnych uzgadnia się metody logowania, podpisywania żądań, ograniczenia sieciowe, uprawnienia użytkowników, przechowywanie kluczy i rejestrowanie działań.
Dostęp do API
Klucze API, OAuth, JWT, konta usługowe, czas ważności tokenów i ich planowa rotacja.
Podpisywanie żądań
Weryfikacja HMAC, czasu żądania i unikalnej wartości w celu ochrony przed ponownym wysłaniem.
Dostęp sieciowy
Dozwolone adresy IP i domeny, bezpieczne połączenie, VPN, reguły sieciowe oraz rozdzielenie środowiska testowego i produkcyjnego.
Role i uprawnienia
Uprawnienia usług i pracowników są nadawane zgodnie z zasadą minimalnego niezbędnego dostępu.
Ochrona danych
Szyfrowanie, maskowanie wartości wrażliwych, okresy przechowywania, usuwanie i zasady pracy z danymi osobowymi.
Dziennik działań
Numer żądania, uczestnik, czas, zmiany, błędy i historia operacji krytycznych.
Testy i odbiór
Wymagania dotyczące testów i odbioru
Środowisko testowe powinno odtwarzać nie tylko operacje poprawne, ale także błędy, opóźnienia, ponowienia, ograniczenia i raportowanie końcowe.
Środowisko testowe
Oddzielne adresy, klucze dostępu, punkty odbioru powiadomień, ograniczenia i zasady czyszczenia danych.
Dane testowe
Gracze, waluty, metody płatności, dostawcy, statusy i wartości dla powtarzalnych scenariuszy.
Scenariusze poprawne
Pełny proces produkcyjny od pierwszego żądania do statusu końcowego i odzwierciedlenia w raportowaniu.
Scenariusze błędne
Nieprawidłowe dane, timeout, ponowna operacja, niewystarczające saldo, odmowa i błąd dostawcy.
Logi i diagnostyka
Numer żądania, dokładny czas, status źródłowy i dane potrzebne do wspólnej analizy.
Odbiór
Uzgodniona lista scenariuszy, oczekiwanych wyników i osób odpowiedzialnych za potwierdzenie.
Lista kontrolna gotowości
Minimalna lista kontrolna przed rozpoczęciem developmentu
Integrację można planować po uzgodnieniu zakresu, zasad wymiany danych, dostępów, środowiska testowego i odpowiedzialności stron.
Zakres integracji został zatwierdzony
Ustalono produkty, rynki, systemy, funkcje i etapy uruchomienia.
Dokumentacja API jest dostępna
Opisano adresy żądań, formaty danych, statusy, błędy, powiadomienia i przykłady.
Wydano dostępy testowe
Klucze są aktywne, a dozwolone adresy IP i adresy odbioru powiadomień zostały uzgodnione.
Bezpieczeństwo zostało uzgodnione
Określono metody dostępu, podpisy, role, przechowywanie kluczy i rejestrowanie.
Przygotowano scenariusze testowe
Dostępne są scenariusze poprawne, błędne, ponowne i awaryjne.
Wyznaczono osoby odpowiedzialne
Wskazano właścicieli produktu oraz specjalistów ds. developmentu, testów, bezpieczeństwa i wsparcia.
Chcesz sprawdzić gotowość wymagań?
Przekaż dokumentację, listę systemów, opis procesów i dostępne środowiska. APIACE pomoże znaleźć brakujące dane przed rozpoczęciem developmentu.