Om te kunnen communiceren, dient u namens de organisatie waaronder u geregistreerd bent, een API-key te genereren. Onder het juiste abonnement kunt u een private- en public key genereren, of desnoods opvragen bij een accounthouder van de organisatie namens wie u API verzoeken wilt kunnen doen.

Goedkeuring vanuit gebruikersaccount

Na een API call namens een gebruiker, wordt de API koppeling bekend gemaakt in het profiel behorende bij de gebruiker. Via deze weg dient toestemming te worden gegeven om middels een api key namens de betreffende gebruiker met onze API te mogen communiceren. Op deze wijze houden de volgende partijen de mogelijkheid om toegang op te heffen:

• de API key verstrekker;
• de hoofd accounthouder van de organisatie waar registers en datalekken onder vallen;
• de accounthouder van de profielgegevens welke gebruikt worden om mee te communiceren.

Indien er nog geen goedkeuring gegeven is, zal de response na een poging om via de API in te loggen, als volgt zijn:

{
"status": 401,
"error": "Not approved by user"
}

Elk opvolgende request zonder juiste toegang (en dus zonder verkregen token-code), zal de volgende melding opleveren:

{
"status": 401,
"error": "Missing user/token"
}

U zult gaan communiceren met een REST API over een versleutelde verbinding. Enkel wanneer u over een geldigde API sleutel beschikt, kunt u namens bedrijven API requests uitvoeren. De API is gebaseerd op één van de eerdere versies van Amazon's API.

Voorbeeld code is binnen uw abonnementsomgeving terug te vinden indien u de API geactiveerd heeft en bijbehorende keys ontvangen heeft.

Liever een SOAP koppeling? Laat het ons weten.

De lees en schrijfrechten van een API sleutel, zijn afhankelijk van de gebruiker namens wie een sleutel is aangemaakt. Dit heeft als gevolg dat iemand die over een sleutel beschikt, dezelfde (beperkende) mogelijkheden heeft als dat de gekoppelde gebruiker zou hebben indien diegene is ingelogd.

Op die manier is door een organisatie-beheerder c.q. accounthouder van de organisatie, de rechten en overzichtelijk en duidelijk in te stellen vanuit de eigen omgeving. Maak desnoods een apart gebruikersaccount aan voor de API koppeling, om niet eigen gegevens te hoeven delen met een technisch team voor de implementatie.

JSON of XML zijn de twee formaten waarin de API response terug kan geven. Standaard zal de API als response JSON retourneren, indien op basis van onderstaand geen content type vastgesteld kan worden.

Indien er in een api-call een file-extension is meegegeven, wordt hier naar geluisterd. Als backup, wordt door de AVG Cloud Register API gekeken naar de Accept-Headers, welke op text/xml gezet kan worden. Dit kan via Curl bereikt worden.