Deze documentatie beschrijft alle API-methoden voor de volgende acties:

• lijsten met objecten ophalen (lijstmethode)
• lijstfiltering (lijstmethode met filtergegevens)
• gedetailleerde informatie over een object krijgen (methode tonen)
• gegevens ophalen voor het formulier object toevoegen (methode toevoegen)
• gegevens opslaan als een nieuw object (winkelmethode)
• gegevens ophalen voor het object-updateformulier (bewerkingsmethode)
• opslaan van de gegevens van het bijgewerkte object (updatemethode)

De API accepteert alleen verzoeken van een beperkte lijst met IP-adressen (bijvoorbeeld van de accountsite van een klant of een backoffice-site).

Elk verzoek aan de API vanaf een IP-adres dat niet op de toegestane lijst staat, wordt afgewezen.

Dit wordt gedaan om DDoS-aanvallen op de API, pogingen om verzoeken te vervalsen en hacker-experimenten te voorkomen.

Gebruikers hebben altijd toegang tot de openbare site van het platform (kantoor van de klant of backoffice), en deze site vraagt zelf de nodige gegevens op bij de API van het platform. Aangezien het IP-adres van de site vast is, staat het op de toegestane lijst.

Alle API-verzoeken worden gedaan met behulp van de volgende HTTP-methoden:

• GET voor lijst, tonen, toevoegen en bewerken
• POST voor winkel
• PUT voor update
• DELETE voor verwijderen

Elke sectie van de API bevat een URL waarnaar een verzoek wordt gedaan om de relevante gegevens te verkrijgen.

De HTTP-verzoekmethode wordt vóór elke URL gespecificeerd.

Elk API-verzoek moet altijd 4 variabelen bevatten:

1. data (json-tekenreeks met gegevensarray voor API)
2. user (json-tekenreeks met een reeks gegevens over de huidige gebruiker)
3. time (huidige tijd in UTC-tijdzone)
4. hash (digitale handtekening in de vorm van een hash om te verifiëren dat het verzoek aan de API zeker afkomstig is van een geautoriseerde bron)

Als de aanvraag succesvol is, retourneert de API altijd twee variabelen:

1. status = true (successtatus)
2. data (json-tekenreeks met gegevensarray van API)

Als het verzoek mislukt, toont de API de variabelen:

1. status = false (foutstatus)
2. error (tekstreeks die de fout beschrijft)

Elk API-verzoek moet een hash-variabele bevatten die de digitale handtekening van het verzoek is.

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

• md5, sha256, bcrypt — beschikbare coderingsalgoritmen
• $json — json-tekenreeks met verzoekgegevens
• $time — tijd in het formaat "DD.MM.YYYY UU:MM:SS"
• $salt — vaste unieke waarde ("salt") voor platform-API