Denne dokumentation beskriver alle API-metoder til følgende handlinger:

• få lister over objekter (listemetode)
• listefiltrering (listemetode med filterdata)
• få detaljerede oplysninger om et objekt (vis metode)
• hente data til tilføjelsesobjektformularen (tilføj metode)
• gemme data som et nyt objekt (lagringsmetode)
• hente data til objektopdateringsformularen (redigeringsmetode)
• lagring af data for det opdaterede objekt (opdateringsmetode)

API'en accepterer kun anmodninger fra en begrænset liste over IP-adresser (f.eks. fra en klients kontoside eller et backoffice-websted).

Enhver anmodning til API'et fra en IP-adresse, der ikke er på den tilladte liste, vil blive afvist.

Dette gøres for at forhindre DDoS-angreb på API'et, forsøg på at forfalske anmodninger og hackereksperimenter.

Brugere tilgår altid platformens offentlige side (kundens kontor eller backoffice), og denne side anmoder selv om de nødvendige data fra platformens API. Da sidens IP-adresse er fast, vil den være på den tilladte liste.

Alle API-anmodninger foretages ved hjælp af følgende HTTP-metoder:

• GET for at liste, vise, tilføje og redigere
• POST til butik
• PUT til opdatering
• DELETE til sletning

Hver sektion af API'en indeholder en URL, hvortil der anmodes om at få de relevante data.

HTTP-anmodningsmetoden er angivet foran hver URL.

Hver API-anmodning skal altid indeholde 4 variabler:

1. data (json-streng med dataarray til API)
2. user (json-streng med en række data om den aktuelle bruger)
3. time (aktuel tid i UTC tidszone)
4. hash (digital signatur i form af en hash for at bekræfte, at anmodningen til API'en definitivt er fra en autoriseret kilde)

Hvis anmodningen lykkes, returnerer API'en altid to variable:

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

Hvis anmodningen mislykkes, viser API'en variablerne:

1. status = false (fejlstatus)
2. error (tekststreng, der beskriver fejlen)

Hver API-anmodning skal indeholde en hash-variabel, der er anmodningens digitale signatur.

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

• md5, sha256, bcrypt — tilgængelige krypteringsalgoritmer
• $json — json-streng med anmodningsdata
• $time — tid i formatet "DD.MM.ÅÅÅÅ TT:MM:SS"
• $salt — fast unik værdi ("salt") for platform API