Cerințe de business
Produse, piețe, roluri ale utilizatorilor, reguli financiare, restricții și rezultatul așteptat.
Documentație / Cerințe API
Ce trebuie pregătit înainte de conectarea unui API
Colectați informații despre proiect, acces, date, securitate și scenariile de testare înainte de începerea integrării. Acest lucru ajută la definirea din timp a domeniului și la evitarea refacerilor.
Domeniu
produse și piețe
Acces
chei și medii
Date
formate și stări
Acceptare
testarea scenariilor
Pachet de cerințe
Ce trebuie convenit înainte de începerea lucrărilor
01
Cerințele proiectului
Produse, piețe, monede, furnizori, utilizatori și procese operaționale.
02
Reguli de schimb de date
Solicitări, câmpuri, identificatori, stări, erori și evenimente.
03
Acces și securitate
Chei de acces, semnături ale solicitărilor, adrese IP permise, roluri și jurnal de activitate.
04
Testare și acceptare
Date de testare, scenarii reușite și de eroare, verificarea rezultatelor și criteriile de lansare.
Prezentare generală
Cerințele convenite reduc timpul de livrare și refacerile
Înainte de începerea lucrărilor, ambele părți trebuie să înțeleagă la fel obiectivele proiectului, sursele de date, stările operațiunilor, responsabilitățile sistemelor, regulile de securitate și criteriile de acceptare. Integrarea poate urma astfel o schemă convenită, nu presupuneri.
Reguli de integrare
Metode de schimb de date, structuri de solicitări și răspunsuri, identificatori, stări, notificări, erori și limite.
Criterii de acceptare
Scenarii de testare, date așteptate, rapoarte, monitorizarea operațională și criteriile pentru trecerea la lansare.
Datele proiectului
Informații despre proiect și sistemele conectate
Mai întâi se stabilește contextul general: ce produse sunt conectate, ce sisteme participă, unde sunt stocate datele principale și cine este responsabil pentru fiecare proces.
Domeniul și obiectivele proiectului
Produse: cazinou, pariuri sportive, plăți, KYC, CRM, bonusuri, raportare sau back office.
Țări, licențe, monede, limbi, branduri și canale de utilizare.
Tipuri de utilizatori, roluri, limite, stări și scenarii operaționale principale.
Priorități, etape de lansare, funcții critice și restricții comerciale.
Sisteme și responsabilitatea asupra datelor
Lista sistemelor interne și externe implicate în proces.
Sistemul principal pentru datele despre jucător, sold, tranzacție, pariu, bonus sau verificarea KYC.
API-uri disponibile, baze de date, cozi de mesaje, notificări, fișiere și interfețe legacy.
Responsabili pentru actualizarea profilului, soldului, stării operațiunii și raportării finale.
Cerințe de integrare
Cerințe tehnice pentru integrare
Descrierea API trebuie să fie suficientă pentru implementare fără presupuneri: ce metodă se apelează, ce date se transmit, ce răspuns se așteaptă și cum sunt tratate erorile.
Endpointuri și metode
Adresele API, metodele HTTP, versiunile, mediile și restricțiile pentru fiecare operațiune.
Câmpuri și formate de date
Câmpuri obligatorii și opționale, tipuri, lungimi, formate de dată, monedă, precizia sumelor și valori permise.
Identificatori
Identificatorii jucătorului, operațiunii, comenzii, sesiunii, rundei, furnizorului și legăturile dintre acestea.
Stări și tranziții
Coduri de eroare, motive clare, posibilitatea repetării și acțiunea necesară din partea sistemului receptor.
Notificări despre evenimente
Structura evenimentului, semnarea, livrarea, confirmarea recepției, relivrarea și ordinea procesării.
Protecție împotriva duplicatelor
Identificator unic al operațiunii, recunoașterea solicitărilor repetate și recuperarea sigură după o defecțiune.
Limite și încărcare
Frecvența solicitărilor, timpii de așteptare, operațiunile simultane, dimensiunea răspunsului și încărcarea maximă estimată.
Schimbări de versiune
Versiunea API, compatibilitatea cu integrările vechi, perioada de notificare și procedura de gestionare a modificărilor.
Securitate și acces
Cerințe de securitate și gestionare a accesului
Înainte de transferul datelor de producție, sunt convenite metodele de autentificare, semnarea solicitărilor, restricțiile de rețea, permisiunile utilizatorilor, stocarea cheilor și jurnalizarea acțiunilor.
Acces API
Chei API, OAuth, JWT, conturi de serviciu, durata tokenurilor și rotirea lor programată.
Semnarea solicitărilor
Verificarea HMAC, momentul solicitării și o valoare unică pentru protecția împotriva reluării.
Acces la rețea
Adrese IP și domenii permise, conexiuni securizate, VPN, reguli de rețea și separarea mediilor de testare și producție.
Roluri și permisiuni
Permisiunile serviciilor și angajaților sunt atribuite conform principiului accesului minim necesar.
Protecția datelor
Criptare, mascarea valorilor sensibile, perioade de păstrare, ștergere și reguli de lucru cu datele personale.
Jurnal de activitate
Identificatorul solicitării, participantul, timpul, modificările, erorile și istoricul operațiunilor critice.
Testare și acceptare
Cerințe de testare și acceptare
Mediul de testare trebuie să reproducă nu doar operațiuni reușite, ci și erori, întârzieri, repetări, limite și raportarea finală.
Mediu de testare
Endpointuri separate, chei de acces, puncte de recepție a notificărilor, restricții și reguli de resetare a datelor.
Date de test
Jucători, monede, metode de plată, furnizori, stări și valori pentru scenarii repetabile.
Scenarii reușite
Fluxul complet, de la prima solicitare până la starea finală și reflectarea acesteia în raportare.
Scenarii de eroare
Date nevalide, depășirea timpului de așteptare, operațiune repetată, sold insuficient, refuz și eroare a furnizorului.
Jurnale și diagnosticare
Identificatorul solicitării, ora exactă, starea inițială și datele necesare pentru analiza comună.
Acceptare
Lista convenită de scenarii, rezultate așteptate și responsabili pentru confirmare.
Listă de verificare a pregătirii
Lista minimă de verificare înainte de începerea dezvoltării
Planificarea integrării poate începe după ce au fost convenite domeniul, regulile de schimb de date, accesul, mediul de testare și părțile responsabile.
Domeniul integrării aprobat
Au fost documentate produsele, piețele, sistemele, funcțiile și etapele de lansare.
Documentația API este disponibilă
Sunt documentate endpointurile, formatele de date, stările, erorile, notificările și exemplele.
Acces de testare emis
Cheile sunt active, iar adresele IP permise și endpointurile pentru notificări au fost convenite.
Securitatea a fost convenită
Au fost definite metodele de autentificare, semnarea, rolurile, stocarea cheilor și jurnalizarea.
Scenariile de testare sunt pregătite
Sunt disponibile scenarii reușite, de eroare, repetate și de avarie.
Responsabilii au fost desemnați
Au fost identificați responsabilii pentru produs, dezvoltare, testare, securitate și suport.
Trebuie verificată pregătirea cerințelor?
Transmiteți documentația, lista sistemelor, descrierea proceselor și mediile disponibile. APIACE va ajuta la identificarea informațiilor lipsă înainte de începerea dezvoltării.