Om de API-koppeling te beheren, ga naar 'Admin' → 'Koppelingen' → 'API'.
1. API's
De API-koppeling maakt het mogelijk om Bloxs te integreren met andere systemen om op deze manier gegevens met andere applicaties uit te wisselen. De beschikbare API's worden hieronder verder besproken.
2. API configureren
Om te koppelen met de API van Bloxs wordt er gebruik gemaakt van:
- API secret:
Met deze optie kunt u uw Bloxs omgeving identificeren met betrekking tot een API-koppeling.
- API key:
Geeft de gebruiker toegang tot een API. Middels de profielpagina van de gebruiker kan de API key worden aangemaakt. Via het 'rollenbeheer' kan de gebruiker toegang krijgen tot de API.
- URL:
Via de URL kunt u de API's bereiken die door uw Bloxs omgeving worden gebruikt.
3. API secret
Samen met de API key, wordt de API secret gebruikt om een Bloxs omgeving te authentiseren wanneer deze verbinding maakt met een ander systeem. Het aanmaken van een API secret kan op deze plek. Mocht je de API secret al hebben aangemaakt, kun je deze ook inzien middels de grijze knop (oog icoontje).
4. Beschikbare API's
- OData:
Met deze optie geeft u uw Bloxs omgeving toegang tot de OData feed. Met deze data kunt u gebruik maken van BI-tools van derden zoals Microsoft PowerBI. Wanneer de OData feed is ingeschakeld en de gebruiker via 'Rolbeheer' toegang heeft gekregen tot de OData feed, kan de gebruiker op zijn profielpagina een specifiek wachtwoord voor BI-tools aanmaken.
- Publiceren:
Met deze optie kunt u een API-koppeling tot stand brengen met uw website. Objecten die u verhuurt in uw Bloxs omgeving, kunt u ook te huur aanbieden op uw website. Hiernaast is het ook mogelijk automatisch vanaf bijvoorbeeld uw website een huurder en een concept huurcontract aan te laten maken.
- Bloxs API:
Met deze optie kan verbinding worden gemaakt met verschillende API's, zoals die voor relaties, objecten en contracten. Een gebruikersaccount kan echter alleen verbinding maken met een API als het via 'Rolbeheer' toegang heeft gekregen tot de desbetreffende API.