hu
Fintech

API dokumentáció

Az ügyféloldal, a háttériroda és az összes platformmodul az API-n keresztül működik adatbázis-fájlokkal, nem közvetlenül. Az API szabályozza a bejövő adatok hozzáférését, integritását és helyességét.

Általános leírása

Hogyan működik az API?

API - a platform kulcscsomópontja

Ez a dokumentáció leírja az összes API-módszert a következő műveletekhez:

  • objektumlisták lekérése (lista módszer)
  • listaszűrés (listamódszer szűrőadatokkal)
  • részletes információk megszerzése egy objektumról (metódus megjelenítése)
  • adatok lekérése az objektum hozzáadása űrlaphoz (hozzáadási módszer)
  • adatok mentése új objektumként (tárolási módszer)
  • adatok lekérése az objektumfrissítési űrlaphoz (szerkesztési módszer)
  • a frissített objektum adatainak mentése (frissítési módszer)

Ellenőrzés IP cím alapján

Az API csak az IP-címek korlátozott listájáról fogadja el a kéréseket (például egy ügyfélfiók webhelyéről vagy egy háttérirodai webhelyről).

Az engedélyezett listán nem szereplő IP-címekről érkező API-kérések elutasításra kerülnek.

Ennek célja az API-t ért DDoS-támadások, a kérések meghamisítására irányuló kísérletek és a hackerkísérletek megakadályozása.

A felhasználók mindig elérik a platform nyilvános oldalát (ügyfélirodát vagy háttérirodát), és ez az oldal maga kéri le a szükséges adatokat a platform API-jától. Mivel a webhely IP-címe rögzített, az engedélyezett listán lesz.

URL és módszer

Minden API-kérelem a következő HTTP-módszerekkel történik:

  • GET listázáshoz, megjelenítéshez, hozzáadáshoz és szerkesztéshez
  • POST bolthoz
  • PUT frissítéshez
  • DELETE törléshez

Az API minden szakasza tartalmaz egy URL-t, amelyre a vonatkozó adatok beszerzésére irányuló kérés érkezik.

A HTTP-kérés módszere minden URL előtt meg van adva.

Kérelem küldése

Minden API-kérelemnek mindig 4 változót kell tartalmaznia:

  1. data (json karakterlánc adattömbbel az API-hoz)
  2. user (json karakterlánc az aktuális felhasználóra vonatkozó adatok tömbjével)
  3. time (jelenlegi idő UTC időzónában)
  4. hash (digitális aláírás hash formájában annak ellenőrzésére, hogy az API-hoz intézett kérés határozottan engedélyezett forrásból származik)

Válasz az API-tól

Ha a kérés sikeres, az API mindig két változót ad vissza:

  1. status = true (sikeres állapot)
  2. data (json karakterlánc adattömbbel az API-ból)

Ha a kérés sikertelen, az API megjeleníti a változókat:

  1. status = false (hiba állapot)
  2. error (a hibát leíró szöveges karakterlánc)

Digitális aláírás

Minden API kérésnek tartalmaznia kell egy hash változót, amely a kérelem digitális aláírása.

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

  • md5, sha256, bcrypt — elérhető titkosítási algoritmusok
  • $json — json karakterlánc kérési adatokkal
  • $time — időt a következő formátumban: "DD.MM.YYYY ÓÓ:PP:SS"
  • $salt — rögzített egyedi érték ("salt") a platform API-hoz

Fintech

A dokumentáció példákat tartalmaz valós API-kérésekre