Authenticatie op de ReflexBlue Externe API
Elk HTTP-verzoek aan de ReflexBlue Externe API moet vergezeld zijn van een geldig autorisatietoken. Je krijgt zo’n token via een speciaal API-eindpunt. Hiervoor log je in met een gebruikersnaam en wachtwoord van een ReflexBlue gebruiker die is gekoppeld aan een Externe seat en een rol met de juiste gebruikersrechten. De benodigde rechten kunnen verschillen per versie van de API. Hieronder lees je hoe je dit regelt.
Wil je weten hoe je gebruikers en rollen aanmaakt en instelt in ReflexBlue? Kijk dan op Gebruikers en rollen in ReflexBlue.
Als je niet beschikt over het External Seats / API plangebruik in je ReflexBlue plan, dan kan je geen Externe seats aanmaken via het Reflex Cloud Portal. Neem in dat geval contact op met ReflexSystems.
Authenticatie eindpunten
De volgende eindpunten kunnen worden gebruikt om in- en uit te loggen.
| Http-methode | Eindpunt | Omschrijving |
|---|---|---|
| POST | /api/security/login | Login met gebruikersnaam en wachtwoord die een token voor authenticatie aan toonder terugstuurt. |
| POST | /api/security/logout | Doet effectief niets. |
Het uitvoeren van het login verzoek
Gebruik een HTTP POST verzoek naar het login eindpunt met de volgende JSON payload:
{
"username": "string",
"password": "string"
}De server zal antwoorden met de volgende JSON gegevens:
{
"token": "string"
}De waarde van het token bevat een JWT autorisatietoken dat kan worden gebruikt in de Authorization HTTP-verzoekheader bij al je volgende API-verzoeken.
Authenticatie voor versie 1 van de API
Vereisten voor de ReflexBlue API-gebruiker
Om te kunnen authenticeren en versie 1 van de integratie API te gebruiken, heb je een ReflexBlue gebruiker nodig die aan de volgende eisen voldoet:
-
De gebruiker is gekoppeld aan een Externe seat.
-
De gebruiker heeft een rol met deze rechten:
Module Applicatie Recht Administraties Externe API Toegang tot administratie Integraties Externe API Externe API-toegang Zorg ervoor dat de rol is aangemaakt in de ReflexBlue administratie waarmee je koppelt.
Een autorisatietoken verkrijgen
Log in met de hierboven beschreven ReflexBlue gebruiker via het login-eindpunt van de Externe API. Het autorisatietoken dat je ontvangt, stuur je vervolgens mee in de HTTP-verzoekheaders bij al je volgende API-verzoeken.
Authenticatie voor versie 2 van de API
Vereisten voor de ReflexBlue API-gebruiker
Om te kunnen authenticeren en versie 2 van de Externe API te gebruiken, heb je een ReflexBlue gebruiker nodig die aan de volgende eisen voldoet:
-
De gebruiker is gekoppeld aan een Externe seat.
-
De gebruiker heeft een rol met deze rechten:
Module Applicatie Recht Administraties Externe API Toegang tot administratie En een of meerdere van de onderstaande rechten:
Module Applicatie Recht Integraties API V2 Externe API Toegang tot artikelen Integraties API V2 Externe API Toegang tot artikelgroepen Integraties API V2 Externe API Toegang tot bestelpatronen Integraties API V2 Externe API Toegang tot betaalcondities Integraties API V2 Externe API Toegang tot contactpersonen Integraties API V2 Externe API Toegang tot dynamische velden Integraties API V2 Externe API Toegang tot facturen Integraties API V2 Externe API Toegang tot integraties Integraties API V2 Externe API Toegang tot orders Integraties API V2 Externe API Toegang tot pakbonnen Integraties API V2 Externe API Toegang tot relaties Integraties API V2 Externe API Toegang tot relatiegroepen Integraties API V2 Externe API Toegang tot talen Integraties API V2 Externe API Toegang tot webhooks Zorg ervoor dat de rol is aangemaakt in de ReflexBlue administratie waarmee je koppelt.
Een autorisatietoken verkrijgen
Log in met de hierboven beschreven ReflexBlue gebruiker via het login-eindpunt van de Externe API. Het autorisatietoken dat je ontvangt, stuur je vervolgens mee in de HTTP-verzoekheaders bij al je volgende API-verzoeken.
Geldigheid van autorisatietokens
Een autorisatietoken voor ReflexBlue is beperkt geldig, meestal één dag. Houd er rekening mee dat je externe systeem tijdig opnieuw moet authenticeren met de ReflexBlue Applicatie Server om een nieuw token op te halen zodra het oude niet meer geldig is.
Als een autorisatietoken is verlopen, krijg je bij een verzoek naar de Externe API van de ReflexBlue Applicatie Server een HTTP-statuscode 401 (Unauthorized) terug. Vraag in dat geval een nieuw token aan om verder te kunnen werken.