See dokumentatsioon kirjeldab kõiki API meetodeid järgmiste toimingute jaoks.

• objektide loendite hankimine (loendimeetod)
• loendi filtreerimine (loendimeetod filtriandmetega)
• objekti kohta üksikasjaliku teabe saamine (näita meetodit)
• andmete hankimine objekti lisamise vormi jaoks (lisamismeetod)
• andmete salvestamine uue objektina (salvestamise meetod)
• andmete hankimine objekti värskendusvormi jaoks (redigeerimismeetod)
• uuendatud objekti andmete salvestamine (värskendamise meetod)

API aktsepteerib ainult piiratud IP-aadresside loendi päringuid (näiteks kliendi konto saidilt või tagakontori saidilt).

Kõik taotlused API-le IP-aadressilt, mis pole lubatud loendis, lükatakse tagasi.

Seda tehakse selleks, et vältida DDoS-i rünnakuid API-le, taotluste võltsimise katseid ja häkkerite eksperimente.

Kasutajad pääsevad alati platvormi avalikule saidile (kliendikontor või back office) ning see sait ise küsib vajalikke andmeid platvormi API-lt. Kuna saidi IP-aadress on fikseeritud, on see lubatud loendis.

Kõik API päringud tehakse järgmiste HTTP-meetodite abil:

• GET loetlemiseks, kuvamiseks, lisamiseks ja muutmiseks
• POST poe jaoks
• PUT värskendamiseks
• DELETE kustutamiseks

API iga jaotis sisaldab URL-i, millele esitatakse taotlus asjakohaste andmete hankimiseks.

HTTP päringu meetod on määratud iga URL-i ees.

Iga API päring peab alati sisaldama 4 muutujat:

1. data (Json-string API andmemassiiviga)
2. user (json string praeguse kasutaja andmete massiiviga)
3. time (praegune kellaaeg UTC ajavööndis)
4. hash (digitaalne allkiri räsi kujul, et kontrollida, kas API päring on kindlasti pärit volitatud allikast)

Kui päring on edukas, tagastab API alati kaks muutujat:

1. status = true (edu olek)
2. data (json string koos API andmemassiiviga)

Kui taotlus ebaõnnestub, näitab API muutujaid:

1. status = false (vea olek)
2. error (tõrke kirjeldav tekstistring)

Iga API päring peab sisaldama räsimuutujat, mis on päringu digitaalallkiri.

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

• md5, sha256, bcrypt — saadaolevad krüpteerimisalgoritmid
• $json — json string päringuandmetega
• $time — kellaaeg vormingus "DD.MM.YYYY HH:MM:SS"
• $salt — platvormi API fikseeritud kordumatu väärtus ("sool").