REST API

REST API


Data die in BrynQ is opgeslagen, is via REST API’s op te vragen. Dit artikel bevat een beschrijving hoe de REST API’s aangeroepen kunnen worden en wat de mogelijke endpoints zijn.

Autorisatie

Voordat het mogelijk is om de REST API aan te roepen, dient de gebruiker een token te ontvangen van de applicatiebeheerder. Hoe deze token aangemaakt moet worden, staat beschreven in het artikel API Token aanmaken.
  • De base URL van de API is: https://<customer_name>.brynq.com/api/v1/;
  • Er dienen 2 tokens opgegeven te worden om de calls te autoriseren. Deze worden als header toegevoegd:
    • Authorization: SalureToken <token>;
    • salure-customer: <Klant>.
Om te weten welke klant in de header salure-customer gezet moet worden, kan de gebruiker de endpoint /customers/ aanroepen. Om deze endpoint aan te roepen hoeft de header salure-customer niet meegegeven te worden. De response op deze call geeft de mogelijke values die de gebruiker kan invullen in de salure-customer header.

Endpoints

De aan te roepen endpoints zijn in te zien via https://app.brynq.com/api/api-docs/.





    • Related Articles

    • API-token aanmaken

      De data die is opgeslagen in BrynQ is voor het grootste gedeelte ook op te halen via REST API’s. Uiteraard geldt ook hier autorisatie voor. Dit artikel beschrijft hoe een API token aangemaakt kan worden. Het artikel "REST API" beschrijft hoe de REST ...
    • Connect je Azure Entra omgeving aan BrynQ

      Step 1: Adding the BrynQ app to the app registrations in your Azure environment Sign in to your azure portal. Go to App registrations Click New registration: Add a name for this registration, you can give it a name that will help you realize that ...
    • Salureconnect python documentatie

      SalureConnect SalureConnect is a Python package that handles the credential information between other packages and the web platform SalureConnect. The package simplifies the process of fetching and refreshing authentication credentials, as well as ...
    • Bestanden uploaden

      Deze functionaliteit wordt in mei 2024 uit BrynQ verwijderd. We vervangen deze functionaliteit met Sharepoint. Soms is het handig om een Excel- of CSV-bestand in een dashboard in te laden. Op dat moment kan "Bestandsupload" uitkomst bieden. Bestand ...
    • Single Sign On met AFAS Insite

      Het is mogelijk om de BrynQ dashboard in AFAS Insite te tonen, zodat je bijvoorbeeld dashboards kunt openen in Insite zonder nog een keer apart in te hoeven loggen. Voorwaarde is dat de AFAS gebruikerscode hetzelfde is als de gebruikerscode in BrynQ. ...