API (1.12.4)

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:

1. Limitaties op het aantal requests:

   • 100,000 requests per dag
   • 5 requests per seconden

2. Limitaties op de grootte van het request:

   • De body mag niet groter zijn dan 45 MB
   • Documenten die toegevoegd worden mogen niet groter zijn dan 30 MB, dit is de waarde na base64 decode

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”:“47185920 bytes”,“ontvangen”:“50000000 bytes”}"

Authenticatie van API request ¶

Bij elk API request dient de bearer token meegestuurd te worden in de Autorisatie header.
Voor het ophalen van een bearer token moet een call gemaakt worden naar: ‘https://{domein}/oauth/access_token’
Response:

• Response 200 (application/json)

  {
      "access_token": "5db1cf97f8fd66f295c33eae616227e69de4d",
      "expires_in": 3600,
      "token_type": "Bearer",
      "scope": "{SCOPES}",
      "refresh_token": "6ebffce35d81e24463336fc2a8c8cc9d23b8c"
    }

Wordt er via Postman een request gestuurd dan moet in de Authorization header het type ‘Bearer token’ worden geselecteerd en de access token moet in het veld ‘Token’ komen te staan. Bijvoorbeeld: een geldige Authorisatie header is ‘Bearer test_a9113c8b18d9e38aa230c5194317a988d13b69e0’.