ro
Fintech

Documentația API

Site-ul client, back office și toate modulele platformei funcționează cu fișiere de bază de date prin API și nu direct. API-ul controlează accesul, integritatea și corectitudinea datelor primite.

Descriere generala

Cum funcționează API-ul?

API - nodul cheie al platformei

Această documentație descrie toate metodele API pentru următoarele acțiuni:

  • obținerea listelor de obiecte (metoda listă)
  • filtrare listă (metoda listă cu date de filtrare)
  • obținerea de informații detaliate despre un obiect (metoda arată)
  • obținerea datelor pentru formularul de adăugare a obiectului (metoda de adăugare)
  • salvarea datelor ca obiect nou (metoda de stocare)
  • obținerea datelor pentru formularul de actualizare a obiectului (metoda de editare)
  • salvarea datelor obiectului actualizat (metoda de actualizare)

Verificarea după adresa IP

API-ul acceptă numai solicitări de la o listă limitată de adrese IP (de exemplu, de pe site-ul de cont al unui client sau de la un site de back office).

Orice solicitare către API de la o adresă IP care nu se află în lista permisă va fi respinsă.

Acest lucru se face pentru a preveni atacurile DDoS asupra API-ului, încercările de falsificare a solicitărilor și experimentele hackerilor.

Utilizatorii accesează întotdeauna site-ul public al platformei (biroul clientului sau back office), iar acest site însuși solicită datele necesare de la API-ul platformei. Deoarece adresa IP a site-ului este fixă, aceasta va fi pe lista permisă.

URL și metodă

Toate solicitările API sunt făcute folosind următoarele metode HTTP:

  • GET pentru listare, afișare, adăugare și editare
  • POST pentru magazin
  • PUT pentru actualizare
  • DELETE pentru ștergere

Fiecare secțiune a API-ului conține o adresă URL la care se solicită obținerea datelor relevante.

Metoda de solicitare HTTP este specificată în fața fiecărei adrese URL.

Trimiterea unei cereri

Fiecare solicitare API trebuie să conțină întotdeauna 4 variabile:

  1. data (șir json cu matrice de date pentru API)
  2. user (șir json cu o matrice de date despre utilizatorul curent)
  3. time (ora curentă în fusul orar UTC)
  4. hash (semnătură digitală sub formă de hash pentru a verifica dacă solicitarea către API este cu siguranță dintr-o sursă autorizată)

Obține răspuns de la API

Dacă solicitarea are succes, API-ul returnează întotdeauna două variabile:

  1. status = true (starea de succes)
  2. data (șir json cu matrice de date din API)

Dacă solicitarea eșuează, API-ul arată variabilele:

  1. status = false (starea de eroare)
  2. error (șir de text care descrie eroarea)

Semnatura digitala

Fiecare cerere API trebuie să conțină o variabilă hash care este semnătura digitală a cererii.

hash = md5($json . $time . $salt)

  • md5, sha256, bcrypt — algoritmii de criptare disponibili
  • $json — json șir cu date de solicitare
  • $time — ora în formatul „ZZ.LL.AAAA HH:LL:SS”
  • $salt — valoare unică fixă („sare”) pentru API-ul platformei

Fintech

Documentația conține exemple de solicitări API reale