HTTP-verzoeken naar de ReflexBlue Externe API

Je bereikt de ReflexBlue Externe API via de url van je eigen ReflexBlue Applicatie Server. Voeg het pad van het gewenste API-eindpunt toe aan deze url om een verzoek te sturen.

Je vindt de juiste url van je ReflexBlue Applicatie Server op deze pagina.

Elk verzoek aan de ReflexBlue Externe API moet verplichte HTTP-verzoekheaders en padvariabelen bevatten. Hieronder lees je wat je nodig hebt.

Vereiste padvariabelen

• administrationNumber
  Dit is het nummer van de administratie waar je het verzoek voor doet.
  Het pad van het API-eindpunt begint met het administratienummer, gevolgd door /api/ en daarna het bronpad van het eindpunt. Meestal is het administratienummer 1 (hoofdadministratie) of 2 (testadministratie).

  Je vindt het juiste administratienummer linksonder in het menu van de ReflexBlue Desktop Client of in het Administraties overzichtsscherm.

• version
  Dit is het versienummer van de integratie API.

Vereiste HTTP-verzoekheaders

Gebruik altijd de onderstaande HTTP-headers bij elk verzoek aan de ReflexBlue Externe API.

HTTP-responses van de ReflexBlue Externe API

Dit overzicht beschrijft de meest voorkomende HTTP-statuscodes die je ontvangt bij het gebruik van de ReflexBlue Externe API. Zo weet je snel wat een response betekent en wat je kunt doen bij een foutmelding.

HTTP-statuscodes

200 (OK) / 204 (No Content)

• Het verzoek is succesvol verwerkt.
• Afhankelijk van het gekozen eindpunt ontvang je data in de response, of blijft deze leeg.

302 (Found)

• Het verzoek is succesvol verwerkt.
• Je ontvangt een redirect-URL in de response, afhankelijk van het eindpunt.

401 (Unauthorized)

• Het verzoek is niet succesvol.
• Mogelijke oorzaken:
  • Er is geen autorisatietoken meegegeven of het token is verlopen. Vraag een nieuw token aan.
  • Er is een ongeldige gebruikersnaam en/of wachtwoord gebruikt voor ReflexBlue.
  • De seat of rol van de ReflexBlue gebruiker heeft onvoldoende rechten.
• De response bevat een object met details over de foutmelding.

403 (Forbidden)

• Het verzoek is niet succesvol.
• De response bevat een object met details over de foutmelding.

409 (Conflict)

• Het verzoek is niet succesvol.
• De response bevat een object met details over de foutmelding.

500 (Internal Server Error)

• Het verzoek is niet succesvol door een interne fout.
• De response bevat een object met details over de foutmelding.
• Neem contact op met ReflexSystems als dit probleem blijft optreden.

Foutmeldingen in de API-response

Wanneer een HTTP-verzoek naar de ReflexBlue Externe API resulteert in een fout, ontvang je in de response body een JSON-object met details over de foutmelding. Dit object bevat altijd een of meer foutmeldingen.

Een voorbeeld van het JSON-object:

{
    "messageKey": "",
    "translatedMessageKey": "",
    "messageParams": [],
    "messages": [
        {
            "messageKey": "",
            "translatedMessageKey": "",
            "messageParams": []
        }
    ]
}