Hoppa till innehåll
AurionAI

Utvecklar-API: användning och webhooks

3 min läsningAv Emmanuel Yazbeck

Sidorna för utvecklar-API visar hur program använder AurionAI API, och låter dig skicka AurionAI-händelser till dina egna system med webhooks.

Tillgänglighet: alla profiler. Endast administratörer.

Förutsättningar

  • Du har rollen Ägare eller Administratör. Andra roller kan inte öppna dessa sidor.
  • För webhooks: en HTTPS-adress på din sida som accepterar POST-förfrågningar med en JSON-kropp.

Öppna sidorna för utvecklar-API

  1. I det övre fältet väljer du ditt namn eller din bild för att öppna användarmenyn.
  2. Välj Klientinställningar.
  3. Gå till kortet Utvecklar-API.
  4. Välj API-användningsöversikt eller Webhook-hantering.

Kortet Developer API på sidan Tenant Settings.

Granska API-användning

Sidan "API Usage Dashboard" visar trafiken för AurionAI API för din organisation.

  1. Under "Window" väljer du "Last 1 day", "Last 7 days" eller "Last 30 days". Standardvärdet är sju dagar.
  2. Läs de fyra summorna: "Total Requests", "Error Rate", "Rate-Limit Hits" och "Webhook Success".
  3. Läs "Top API Paths" för att se vilka adresser som anropas mest, med deras fel.
  4. Läs "Daily Trend" för att se trafiken per dag.
  5. Välj "Refresh" för att läsa in de senaste siffrorna.

Registrera en webhook

  1. På sidan "Webhook Management" går du till "Create Subscription".
  2. I "Target URL" skriver du HTTPS-adressen till din mottagare.
  3. Under "Events" väljer du de händelser du vill ta emot. Händelserna är grupperade: konversationer, meddelanden, kontakter, ärenden, samtal, kunskapsbas och system.
  4. Välj "Create webhook".
  5. En dialogruta visar signeringshemligheten. Välj "Copy secret" och förvara hemligheten på ett säkert ställe. AurionAI visar den bara denna ena gång.
  6. Välj "I have saved my secret".

Den nya webhooken visas under "Subscriptions" med statusen "Active".

Verifiera en webhook-signatur

Varje leverans är en POST-förfrågan med en JSON-kropp och dessa huvuden:

  • X-Webhook-Event: händelsens namn, till exempel ticket.created.
  • X-Webhook-Timestamp: tidpunkten för leveransen.
  • X-Webhook-Signature: signaturen för leveransen.

För att kontrollera att en leverans kommer från AurionAI:

  1. Ta värdet av X-Webhook-Timestamp, en punkt och förfrågans råa kropp, i denna ordning.
  2. Beräkna en HMAC-SHA256 av denna text med din signeringshemlighet.
  3. Skriv resultatet i hexadecimalt format och jämför det med X-Webhook-Signature. Acceptera leveransen endast när de är lika.

Testa, pausa eller ta bort en webhook

  • Välj "Send test" för att skicka en testleverans. En pausad webhook kan inte ta emot ett test.
  • Välj "Pause" för att stoppa leveranser ett tag, och "Resume" för att starta dem igen.
  • Välj "Delete" och bekräfta för att ta bort webhooken.
  • Sidan listar de senaste leveranserna med deras status, antal försök och HTTP-status från din mottagare.

Resultat

AurionAI skickar varje vald händelse till din adress. En leverans räknas som lyckad när din mottagare svarar med en 2xx-status. Annars försöker AurionAI igen senare, upp till fem försök totalt.

Om något går fel

  • "Webhook URL is required." Ange adressen till din mottagare.
  • "Select at least one event to subscribe to." Välj minst en händelse.
  • Ett meddelande säger att webhook-URL:en måste börja med https. AurionAI skickar webhooks endast till HTTPS-adresser.
  • Ett meddelande säger att adressen är blockerad eller inte kan lösas upp. AurionAI avvisar privata, lokala och okända adresser. Använd en offentlig adress som kan lösas upp i DNS.
  • Signaturen stämmer inte. Använd den råa kroppen som mottogs, innan någon tolkning. Använd hemligheten för denna webhook. Om du har tappat bort hemligheten tar du bort webhooken och skapar den på nytt.
  • Leveranser misslyckas. Kontrollera HTTP-statusen i leveranslistan. Din mottagare måste svara med en 2xx-status.
  • "No webhooks configured" under "Webhook Success". Din organisation har ännu ingen utvecklar-webhook.

Relaterade artiklar

Behöver du fortfarande hjälp? Skicka en förfrågan eller .