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 API daadwerkelijk gebruikt kan worden.
Token aanmaken
Een token geeft rechten tot het ophalen van data van bepaalde onderdelen van BrynQ. Het is bijvoorbeeld mogelijk om data op te halen met alle gebruikers, of data vanuit connectoren, enz. De token die hiervoor nodig is, wordt als volgt aangemaakt:
- Navigeer naar Instellingen > Algemeen > API Toegang;
- Klik rechts bovenin het scherm op API token toevoegen;
- Geef de token een duidelijk herkenbaar en beschrijvend label;
- Geef onder "Paginarechten" aan vanuit welke pagina’s de token data kan ophalen. De token geeft alleen Read rechten op deze pagina’s. Let op: hier kunnen alleen pagina's worden gekozen waarvoor de gebruiker op dat moment toegang heeft.
- Als er meerdere klanten zijn (wat vrijwel nooit het geval zal zijn), geef dan eventueel aan voor welke klanten deze token van toepassing is;
- Voor de veiligheid kan het wenselijk zijn om het token een einddatum en tijd mee te geven wanneer het token zijn geldigheid verliest;
- Klik op "Opslaan";
- Sla de token die nu in het scherm komt ergens op. Deze is namelijk niet nogmaals op te vragen. Klik op Ok.
De token is te gebruiken in de header Authorization. De key dient voorzien te zijn van SalureToken. Als de token abcd1234 zou zijn komt de header er als volgt uit te zien: {"Authorization": "SalureToken abcd1234"}.