Ez a dokumentáció leírja az összes API-módszert a következő műveletekhez:
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.
Minden API-kérelem a következő HTTP-módszerekkel történik:
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.
Minden API-kérelemnek mindig 4 változót kell tartalmaznia:
Ha a kérés sikeres, az API mindig két változót ad vissza:
Ha a kérés sikertelen, az API megjeleníti a változókat:
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)