API (1.12.0)
De Faster Forward Elements API collectie is set van objectbeschrijvingen die het mogelijk maken om te connecteren met het Faster Forward Elements Platform. Met onze API kunt u o.a. volledige klantdossiers ophalen, zodat u andere applicaties of Faster Forward Elements kunt verrijken.
De API is opgebouwd rondom de volgende technieken en methodieken:
-
Architectuur (REST - Representational state transfer)
-
Autorisatie (OAuth 2.0)
-
Response data format (JSON - JavaScript Object Notation)
-
Response data document format (HAL - Hypertext Application Language)
-
Response data document error format (vnd.error)
Voorwaarden
Faster Forward stimuleert het gebruik en het maken van eigen toepassingen. Hierbij dient u echter wel rekening te houden met de algemene voorwaarden van Faster Forward voor het gebruik van de API.
De API voorwaarden vindt u hier.
Limitaties
De Faster Forward Elements API kent 2 soorten limitaties:
-
Limitaties op het aantal requests:
- 100,000 requests per dag
- 5 requests per seconden
-
Limitaties op de grootte van het request:
- De body mag niet groter zijn dan 25MB
Indien u over het aantal requests heen gaat, zult u een response ontvangen met HTTP method 429 (Too Many Requests)
In het geval van het overschrijden van de dagelijkse request limiet krijgt u in de reponse onderstaande body
{ ‘error’: “Limit exceeded of 100,000 request(s) in one day” }
bij het overschrijden van de limiet van het aantal requests per seconden krijgt u de volgende body
{ ‘error’: “Limit exceeded of 5 request(s) in 1 second(s)” }
In het geval u over de maximale grootte heen gaat, zult u een response ontvangen met HTTP method 400 (Bad Request) met onderstaande body:
{“error”:“Request body is groter dan toegestaan”,“toegestaan”:“26214400 bytes”,“ontvangen”:“139810386 bytes”}"