Een Voxbi API-sleutel aanmaken

Met API-sleutels kunnen je eigen tools en externe integraties veilig met Voxbi communiceren. Je maakt ze zelf aan in de Voxbi Cockpit, en elke sleutel heeft zijn eigen rechten en vervaldatum. Zo geef je elke integratie precies de toegang die nodig is, en niet meer. Deze handleiding doorloopt het proces in vier stappen. Zie het overzicht van de Voxbi API en webhooks voor het bredere plaatje van wat de API allemaal kan.

Je kunt meerdere sleutels tegelijk actief houden, waardoor het eenvoudig is om integraties van elkaar te scheiden of toegang te rouleren zonder uitvaltijd.

Voordat je begint

Je hebt een beheerdersaccount nodig op je Voxbi-telefoonsysteem. API-sleutels worden beheerd in de Voxbi Cockpit via Configuratie > Integraties.

Stap 1: open Integraties

Klik in het zijmenu van de Cockpit onder Configuratie op Integraties. Op deze pagina staan alle integraties en API-sleutels van je telefoonsysteem.

Stap 2: voeg een nieuwe API-sleutel toe

Klik op + Nieuwe integratie, open het keuzemenu Type en kies API-sleutel.

Stap 3: geef de sleutel een naam en stel rechten en vervaldatum in

Geef de sleutel een beschrijvende naam zodat je hem later herkent (bijvoorbeeld de naam van de integratie waarvoor hij bedoeld is). Stel daarna het volgende in:

• Vervaldatum. De dag waarop de sleutel stopt met werken. Laat leeg voor een sleutel die nooit verloopt, of stel een datum in voor tijdelijke integraties en tests zodat de sleutel zichzelf opruimt.

• Rechten. Vink alleen de resources en bevoegdheden aan die deze sleutel nodig heeft, zoals Contacten, Gesprekshistorie of Telefoonnummers. Gebruik Alles selecteren alleen wanneer een integratie echt alles nodig heeft.

Klik vervolgens op Opslaan.

Door alleen de benodigde rechten te verlenen, beperk je de schade als de sleutel ooit uitlekt. Als een integratie later meer toegang nodig heeft, maak dan een tweede sleutel aan met de extra rechten in plaats van de bestaande sleutel breder te maken.

Stap 4: kopieer je sleutel

De nieuwe sleutel verschijnt in het veld API-sleutel. Gebruik het oogpictogram om hem zichtbaar te maken en het kopieericon om hem over te nemen. Dit is de waarde die je als Bearer-token meestuurt.

Behandel de sleutel als een wachtwoord. Het zichtbaar maken of kopiëren wordt vastgelegd in het auditlogboek, en als je hem kwijtraakt verwijder je de sleutel en maak je een nieuwe aan in plaats van te proberen hem terug te halen.

Je sleutel gebruiken

Richt je verzoek op de basis-URL van de Voxbi API, https://cockpit.voxbi.com/v1/api, en stuur je sleutel mee in de Authorization-header als Bearer-token:

# Vervang YOUR_API_KEY door de sleutel die je hebt gekopieerd.
curl https://cockpit.voxbi.com/v1/api/contacts \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

De volledige lijst van endpoints, parameters en antwoordformaten staat in de Voxbi API-documentatie.

Je sleutels veilig houden

• Codeer een sleutel nooit rechtstreeks in. Houd sleutels buiten versiebeheer en buiten client-side code. Gebruik omgevingsvariabelen of een secrets manager.

• Eén sleutel per integratie. Aparte sleutels maken het mogelijk om één service in te trekken of te rouleren zonder de rest te verstoren.

• Stel een vervaldatum in voor tijdelijke sleutels en testsleutels, zodat ze zichzelf opruimen.

• Bekijk het auditlogboek. Elke keer dat de sleutel zichtbaar wordt gemaakt of gekopieerd, wordt dat vastgelegd. Zo kun je controleren of een sleutel is gedeeld of misbruikt.

Veelgestelde vragen

Kan ik meer dan één API-sleutel hebben?

Ja. Je kunt meerdere sleutels tegelijk actief houden, elk met een eigen naam, rechten en vervaldatum. Elke integratie zijn eigen sleutel geven is de aanbevolen aanpak.

Wat gebeurt er als een sleutel verloopt?

Hij stopt met werken op de vervaldatum en verzoeken die die sleutel gebruiken worden geweigerd. Maak een nieuwe sleutel aan en update je integratie voordat de oude verloopt.

Ik ben mijn sleutel kwijt. Kan ik hem opnieuw bekijken?

Je kunt hem opnieuw bekijken via de pagina Integraties met het oogpictogram. Als je er geen toegang meer toe hebt, verwijder je die sleutel en genereer je een nieuwe. Het bekijken van een sleutel wordt vastgelegd in het auditlogboek.

Hoe wijzig ik de rechten van een sleutel?

Open de integratie en pas de rechten aan. Om toegang te beperken zonder een lopende integratie te onderbreken, maak je een nieuwe sleutel aan met strakkere rechten en schakel je daarop over.

Hulp nodig?

Kom je er niet uit, stuur ons dan een e-mail via hello@voxbi.com. Lees het overzicht van de Voxbi API en webhooks of koppel elke CRM via de API om te zien wat je kunt bouwen zodra je een sleutel hebt.