Tässä dokumentaatiossa kuvataan kaikki API-menetelmät seuraaville toimille:

• objektiluetteloiden hakeminen (luettelomenetelmä)
• luettelosuodatus (luettelomenetelmä suodatindatan kanssa)
• saada yksityiskohtaista tietoa kohteesta (näytä menetelmä)
• tietojen hakeminen objektin lisäyslomakkeelle (lisäysmenetelmä)
• tietojen tallentaminen uutena objektina (tallennusmenetelmä)
• tietojen hakeminen objektin päivityslomakkeelle (muokkausmenetelmä)
• päivitetyn objektin tietojen tallentaminen (päivitysmenetelmä)

API hyväksyy pyynnöt vain rajoitetulta IP-osoitteiden luettelolta (esimerkiksi asiakkaan tilisivustolta tai back office -sivustolta).

Kaikki API-pyynnöt IP-osoitteesta, joka ei ole sallittujen luettelossa, hylätään.

Tämä tehdään estämään DDoS-hyökkäykset API:a vastaan, väärentämisyritykset ja hakkerikokeilut.

Käyttäjät pääsevät aina alustan julkiselle sivustolle (asiakastoimisto tai back office), ja tämä sivusto itse pyytää tarvittavat tiedot alustan API:lta. Koska sivuston IP-osoite on kiinteä, se on sallittujen luettelossa.

Kaikki API-pyynnöt tehdään seuraavilla HTTP-menetelmillä:

• GET luetteloa, näyttämistä, lisäämistä ja muokkaamista varten
• POST myymälää varten
• PUT päivitystä varten
• DELETE poistamista varten

Jokainen API-osio sisältää URL-osoitteen, johon pyydetään tarvittavia tietoja.

HTTP-pyyntömenetelmä on määritetty jokaisen URL-osoitteen edessä.

Jokaisen API-pyynnön tulee sisältää aina 4 muuttujaa:

1. data (json-merkkijono datataulukon kanssa API:lle)
2. user (json-merkkijono, jossa on joukko tietoja nykyisestä käyttäjästä)
3. time (nykyinen aika UTC-aikavyöhykkeellä)
4. hash (digitaalinen allekirjoitus hajautusmuodossa sen varmistamiseksi, että API-pyyntö tulee varmasti valtuutetusta lähteestä)

Jos pyyntö onnistuu, API palauttaa aina kaksi muuttujaa:

1. status = true (menestystila)
2. data (json-merkkijono datataulukon kanssa API:sta)

Jos pyyntö epäonnistuu, API näyttää muuttujat:

1. status = false (virhetila)
2. error (virhettä kuvaava tekstimerkkijono)

Jokaisen API-pyynnön tulee sisältää hash-muuttuja, joka on pyynnön digitaalinen allekirjoitus.

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

• md5, sha256, bcrypt — käytettävissä olevia salausalgoritmeja
• $json — json-merkkijono pyyntötiedoilla
• $time — aika muodossa "PP.KK.VVVV HH:MM:SS"
• $salt — kiinteä yksilöllinen arvo ("suola") alustan API:lle