Authenticatie
Ovellan heeft een kleine REST API voor developers die verder willen dan het embed-script. Die gebruikt drie aparte credentials, elk voor een andere taak, en de chatwidget op je site heeft er geen enkele van nodig.
De drie credentials
Houd deze uit elkaar en de rest is simpel. De Bot ID is publiek; de API key en sync key zijn geheimen die je op je eigen server houdt.
- Bot ID, de publieke id van één chatbot. Die gaat mee in de request body als
bot_iden mag veilig in front-end-code staan. - API key (
awk_…), een geheime Bearer-token voor de Chat API. Stuur die mee alsAuthorization: Bearer awk_…. - Sync key (
awsk_…), een geheim voor productsync en Zapier. Stuur die mee in deX-Sync-Key-header.
Een API key aanmaken
Open Customer API onder je account, klik op Create key, geef de key een naam en kies met welke bot die mag praten. De key wordt één keer getoond, dus kopieer die meteen. Je kunt de key altijd intrekken, en de Chat API is beschikbaar op de Business- en Enterprise-abonnementen.
Authorization: Bearer awk_YOUR_KEYEen sync key genereren
Open je bot, ga naar de Integrations-pagina en genereer daar de sync key. Als je die opnieuw genereert, vervalt de oude meteen, dus werk hem overal bij waar je hem gebruikt.
X-Sync-Key: awsk_YOUR_SYNC_KEYDe Bot ID mag prima in een browser staan. De API key en sync key niet: die kunnen berichten sturen en je catalogus overschrijven, dus houd ze in server-side code of environment variables, nooit op een publieke pagina.