Ga naar inhoud
AurionAI

Developer API: gebruik en webhooks

3 min leestijdDoor Emmanuel Yazbeck

De ontwikkelaars-API-pagina's laten zien hoe programma's de AurionAI API gebruiken, en stellen je in staat om AurionAI-gebeurtenissen naar je eigen systemen te sturen via webhooks.

Beschikbaarheid: alle profielen. Alleen beheerders.

Vereisten

  • Je hebt de rol Eigenaar of Beheerder. Andere rollen kunnen deze pagina's niet openen.
  • Voor webhooks: een HTTPS-adres aan jouw kant dat POST-verzoeken met een JSON-body accepteert.

Open de ontwikkelaars-API-pagina's

  1. Selecteer in de bovenste balk je naam of afbeelding om het gebruikersmenu te openen.
  2. Selecteer Huurderinstellingen.
  3. Ga naar de kaart Ontwikkelaars-API.
  4. Selecteer API-gebruiksdashboard of Webhookbeheer.

De Developer API-kaart op de pagina Tenantinstellingen.

API-gebruik bekijken

De pagina "API Usage Dashboard" toont het verkeer van de AurionAI API voor jouw organisatie.

  1. Kies onder "Window" de optie "Last 1 day", "Last 7 days" of "Last 30 days". De standaardinstelling is zeven dagen.
  2. Lees de vier totalen: "Total Requests", "Error Rate", "Rate-Limit Hits" en "Webhook Success".
  3. Lees "Top API Paths" om te zien welke adressen het meest worden aangeroepen, inclusief hun fouten.
  4. Lees "Daily Trend" om het verkeer per dag te bekijken.
  5. Selecteer "Refresh" om de meest recente cijfers te laden.

Een webhook registreren

  1. Ga op de pagina "Webhook Management" naar "Create Subscription".
  2. Typ bij "Target URL" het HTTPS-adres van je ontvanger.
  3. Selecteer onder "Events" de gebeurtenissen die je wilt ontvangen. De gebeurtenissen zijn gegroepeerd: gesprekken, berichten, contacten, tickets, oproepen, kennisbank en systeem.
  4. Selecteer "Create webhook".
  5. Een dialoogvenster toont het ondertekeningsgeheim. Selecteer "Copy secret" en sla het geheim op een veilige plek op. AurionAI toont het slechts deze ene keer.
  6. Selecteer "I have saved my secret".

De nieuwe webhook verschijnt onder "Subscriptions" met de status "Active".

Een webhookhandtekening verifiëren

Elke levering is een POST-verzoek met een JSON-body en de volgende headers:

  • X-Webhook-Event: de naam van de gebeurtenis, bijvoorbeeld ticket.created.
  • X-Webhook-Timestamp: het tijdstip van de levering.
  • X-Webhook-Signature: de handtekening van de levering.

Om te controleren of een levering afkomstig is van AurionAI:

  1. Neem de waarde van X-Webhook-Timestamp, een punt en de onbewerkte body van het verzoek, in deze volgorde.
  2. Bereken een HMAC-SHA256 van deze tekst met je ondertekeningsgeheim.
  3. Schrijf het resultaat in hexadecimaal en vergelijk het met X-Webhook-Signature. Accepteer de levering alleen wanneer ze gelijk zijn.

Een webhook testen, pauzeren of verwijderen

  • Selecteer "Send test" om een testlevering te verzenden. Een gepauzeerde webhook kan geen test ontvangen.
  • Selecteer "Pause" om leveringen tijdelijk te stoppen, en "Resume" om ze weer te hervatten.
  • Selecteer "Delete" en bevestig om de webhook te verwijderen.
  • De pagina toont de meest recente leveringen, met hun status, het aantal pogingen en de HTTP-status van je ontvanger.

Resultaat

AurionAI stuurt elke geselecteerde gebeurtenis naar jouw adres. Een levering wordt als geslaagd beschouwd wanneer je ontvanger antwoordt met een 2xx-status. Anders probeert AurionAI het later opnieuw, tot maximaal vijf pogingen in totaal.

Als er iets misgaat

  • "Webhook URL is required." Typ het adres van je ontvanger.
  • "Select at least one event to subscribe to." Selecteer ten minste één gebeurtenis.
  • Een melding geeft aan dat de webhook-URL moet beginnen met https. AurionAI verstuurt webhooks alleen naar HTTPS-adressen.
  • Een melding geeft aan dat het adres geblokkeerd is of niet kan worden omgezet. AurionAI weigert privé-, lokale en onbekende adressen. Gebruik een openbaar adres dat in DNS wordt omgezet.
  • De handtekening komt niet overeen. Gebruik de onbewerkte body zoals ontvangen, vóór enige verwerking. Gebruik het geheim van deze webhook. Als je het geheim bent kwijtgeraakt, verwijder de webhook dan en maak hem opnieuw aan.
  • Leveringen mislukken. Controleer de HTTP-status in de leveringslijst. Je ontvanger moet antwoorden met een 2xx-status.
  • "No webhooks configured" onder "Webhook Success". Je organisatie heeft nog geen ontwikkelaars-webhook.

Gerelateerde artikelen

Komt u er nog niet uit? Dien een aanvraag in of .