Doel

Om toegang te verkrijgen tot de REOBtimaal API, dient u eerst ‘in te loggen’ met behulp van een beveiligde webservice aanroep.
Hiermee verkrijgt u een token. Deze token gebruikt u bij verdere aanroepen naar de API.
Als u zonder token aanroepen doet naar de API, zal deze u een foutmelding geven in de vorm van een “HTTP 401 Access Denied”.

Verkrijgen van de token

Het verkrijgen van een token kan op twee manieren:

Handmatig (voor testen en gebruik van Swagger)
  1. Ga naar deze pagina: https://api.reobtimaal-diensten.nl/Manage/System/API
    (Als u nog niet ingelogd was, ziet u eerst het inlogscherm van REOBtimaal. Log in.)
  2. Lees de pagina zorgvuldig, er staan belangrijke opmerkingen in over de eigenschappen en het gebruik van de token.
  3. Voer daarna in het gereedschap ‘Maak een token’ de inloggegevens in van de gebruiker onder welke naam de API opdrachten uitgevoerd moeten worden.
    Wij raden altijd aan daar een aparte gebruiker (en rol) voor aan te maken.
  4. Klik op ‘Token aanvragen’. Als de inloggegevens correct waren, wordt de token getoond in het nieuwe tekstvlak onder de knop.
Geautomatiseerd (voor gebruik in koppelingen zonder tussenkomst van mensen en inlogscherm)
  1. Voer een POST aanroep uit naar https://api.reobtimaal-diensten.nl/api/Token
    Geef hierbij drie UrlEncoded FORM velden mee in de body:

    • “grant-type”, moet “password” zijn
    • “username” moet de inlognaam zijn van een aangemaakte gebruiker, door middel van de in REOBtimaal website (UI).
    • “Password” moet het wachtwoord zijn voor diezelfde gebruiker.
  2. Als de inloggegevens correct waren, krijgt u een JSON bericht terug met één sleutel: access_token.
    Deze sleutel bevat de token.

LET OP:

  • Let op hoofdletters/kleine letters
  • U kunt de API alleen aanspreken over een beveiligde SSL verbinding, dat wil zeggen, alleen met “https://”.
  • De gebruiker waarvan de inloggegevens worden gebruikt, dient rechten te hebben tot de API én tot de gebruikte onderdelen van de API.
    Ook de toegang tot de verschillende onderdelen van de API kunt u beheren met het rechtensysteem in REOBtimaal.
    Om gebruikers, rollen en rechten te beheren, logt u in bij REOBtimaal met de internetbrowser en kiest u rechts bovenin beeld het tandwieltje.

Swagger

Gebruikt u Swagger? Kopieer de token dan geheel en plak deze in het veld waarin “api_key” staat (bovenaan in de groene balk). Zet er dan “bearer[spatie]” voor.
Hierna kunt u gemakkelijk de verschillende mogelijkheden van de API gebruiken voordat u software (laat) ontwikkelen.
Let op: als u het scherm ververst (niet nodig), dan dient u opnieuw het token te plakken. U hoeft echter niet een nieuw token aan te vragen, tenzij deze is verlopen.
Tokens verlopen 60 minuten na aanvraag.

Links