Den här dokumentationen beskriver alla API-metoder för följande åtgärder:

• hämta listor med objekt (listmetod)
• listfiltrering (listmetod med filterdata)
• få detaljerad information om ett objekt (visa metod)
• hämta data för formuläret lägg till objekt (lägg till metod)
• spara data som ett nytt objekt (lagringsmetod)
• hämta data för objektuppdateringsformuläret (redigeringsmetod)
• sparar data för det uppdaterade objektet (uppdateringsmetod)

API:et accepterar endast förfrågningar från en begränsad lista med IP-adresser (till exempel från en kunds kontowebbplats eller en backoffice-webbplats).

Varje begäran till API från en IP-adress som inte finns på den tillåtna listan kommer att avvisas.

Detta görs för att förhindra DDoS-attacker på API, försök att förfalska förfrågningar och hackerexperiment.

Användare kommer alltid åt plattformens offentliga webbplats (kundens kontor eller backoffice), och denna webbplats begär själv nödvändig information från plattformens API. Eftersom webbplatsens IP-adress är fast kommer den att finnas på listan över tillåtna.

Alla API-förfrågningar görs med följande HTTP-metoder:

• GET för lista, visa, lägg till och redigera
• POST för butik
• PUT för uppdatering
• DELETE för radering

Varje sektion av API:t innehåller en URL till vilken en begäran görs för att erhålla relevant data.

HTTP-förfrågningsmetoden anges framför varje URL.

Varje API-begäran måste alltid innehålla fyra variabler:

1. data (json-sträng med dataarray för API)
2. user (json-sträng med en rad data om den aktuella användaren)
3. time (aktuell tid i UTC-tidszon)
4. hash (digital signatur i form av en hash för att verifiera att begäran till API:t definitivt kommer från en auktoriserad källa)

Om begäran lyckas returnerar API:et alltid två variabler:

1. status = true (framgångsstatus)
2. data (json-sträng med dataarray från API)

Om begäran misslyckas visar API:et variablerna:

1. status = false (felstatus)
2. error (textsträng som beskriver felet)

Varje API-begäran måste innehålla en hashvariabel som är begärans digitala signatur.

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

• md5, sha256, bcrypt — tillgängliga krypteringsalgoritmer
• $json — json-sträng med begärandata
• $time — tid i formatet "DD.MM.ÅÅÅÅ TT:MM:SS"
• $salt — fast unikt värde ("salt") för plattforms-API