Denne dokumentasjonen beskriver alle API-metoder for følgende handlinger:

• hente lister over objekter (listemetode)
• listefiltrering (listemetode med filterdata)
• få detaljert informasjon om et objekt (vis metode)
• hente data for legg til objekt-skjemaet (legg til-metoden)
• lagre data som et nytt objekt (lagringsmetode)
• hente data for objektoppdateringsskjemaet (redigeringsmetode)
• lagre dataene til det oppdaterte objektet (oppdateringsmetode)

API-en godtar kun forespørsler fra en begrenset liste over IP-adresser (for eksempel fra en kundes kontoside eller et backoffice-nettsted).

Enhver forespørsel til API fra en IP-adresse som ikke er på den tillatte listen vil bli avvist.

Dette gjøres for å forhindre DDoS-angrep på API, forsøk på å forfalske forespørsler og hackereksperimenter.

Brukere har alltid tilgang til plattformens offentlige side (kundens kontor eller backoffice), og denne siden ber selv om nødvendig data fra plattformens API. Siden nettstedets IP-adresse er fast, vil den være på den tillatte listen.

Alle API-forespørsler gjøres ved å bruke følgende HTTP-metoder:

• GET for liste, vis, legg til og rediger
• POST for butikk
• PUT for oppdatering
• DELETE for sletting

Hver del av API-en inneholder en URL som det sendes en forespørsel til for å få de relevante dataene.

HTTP-forespørselsmetoden er spesifisert foran hver URL.

Hver API-forespørsel må alltid inneholde 4 variabler:

1. data (json-streng med dataarray for API)
2. user (json-streng med en rekke data om gjeldende bruker)
3. time (gjeldende tid i UTC tidssone)
4. hash (digital signatur i form av en hash for å bekrefte at forespørselen til API-en definitivt kommer fra en autorisert kilde)

Hvis forespørselen er vellykket, returnerer API alltid to variabler:

1. status = true (suksessstatus)
2. data (json-streng med dataarray fra API)

Hvis forespørselen mislykkes, viser API-en variablene:

1. status = false (feilstatus)
2. error (tekststreng som beskriver feilen)

Hver API-forespørsel må inneholde en hash-variabel som er den digitale signaturen til forespørselen.

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

• md5, sha256, bcrypt — tilgjengelige krypteringsalgoritmer
• $json — json-streng med forespørselsdata
• $time — tid i formatet "DD.MM.ÅÅÅÅ TT:MM:SS"
• $salt — fast unik verdi ("salt") for plattform-API