API Beeyond - Toegang

Inleiding

Deze pagina beschrijft de procedure voor het verkrijgen van toegang tot Beeyond API. Voor het verkrijgen van toegang tot Beeyond API is benodigd:

 

1. Beeyond-domein

Het Beeyond domein betreft het domein waarop in Beeyond ingelogt kan worden. In deze help-pagina betreft dit het domein: demo-api.com. Zie ook de printscreen bij punt 2.

2. Beeyond-API gebruiker aanmaken

Bij het gebruik van de Beeyond API dient in het betreffende domein een API gebruiker aangemaakt te worden. Deze gebruiker dient aangevraagd te worden bij BZTRS Agency.

Aanmaken kan als volgt in het domein:

  • Ga naar https://demo.beeyond.nl/ en log in op het domein demo-api.com.

  • Kies voor Configuratie, API toegang

  • Voeg een Nieuwe API gebruiker toe. in het voorbeeld wordt API gebruiker DEMO-API01 aangemaakt, deze wordt gekoppeld aan de admin gebruiker die in Beeyond is aangemaakt. De Key kan vervolgens gegenereert worden door op het icoontje achter dit veld te klikken. In dit voorbeeld is dit:  bl5JeMYI0WKnt4/iQgj1r3PUAZskOymxCygt395JuHs=

 

3. Beeyond-hash berekenen

Bereken nu de Beeyond-Hash. Deze code is benodigd voor het opvragen / schrijven van data van en naar Beeyond. De code wordt als volgt berekend:

  • Formule: Api toegang ID+domeinnaam+Sleutel 

Voorbeeld: 

Omschrijving

Waarde

Omschrijving

Waarde

API Username

DEMO-API01

Domeinnaam

demo-api.com

Sleutel

bl5JeMYI0WKnt4/iQgj1r3PUAZskOymxCygt395JuHs=

Hash code

DEMO-API01demo-api.combl5JeMYI0WKnt4/iQgj1r3PUAZskOymxCygt395JuHs=

 

Als resultaat krijg je nu terug: 4db3d0774947d37a9fb9a0169514ae668b034d71cdc494b9e7957ca5a50030a3

 

4. API Software: Postman

Voor testdoeleinden kan gebruik worden gemaakt van Postman https://www.getpostman.com/product/api-client. Deze software is geschikt voor Mac, Linux en Windows.

 

5. API Controle

Om te controleren of de API actief is kun je gaan naar: