Spring til indhold
AurionAI

Udvikler-API: brug og webhooks

3 min. læsningAf Emmanuel Yazbeck

Developer API-siderne viser, hvordan programmer bruger AurionAI API, og giver dig mulighed for at sende AurionAI-hændelser til dine egne systemer med webhooks.

Tilgængelighed: alle profiler. Kun administratorer.

Forudsætninger

  • Du har rollen Ejer eller Administrator. Andre roller kan ikke åbne disse sider.
  • For webhooks: en HTTPS-adresse på din side, der accepterer POST-anmodninger med en JSON-body.

Åbn developer API-siderne

  1. I den øverste bjælke skal du vælge dit navn eller billede for at åbne brugermenuen.
  2. Vælg Lejerindstillinger.
  3. Gå til kortet Udvikler-API.
  4. Vælg API-forbrugsoversigt eller Webhook-administration.

Developer API-kortet på siden Lejerindstillinger.

Gennemgå API-brug

Siden "API Usage Dashboard" viser trafikken for AurionAI API i din organisation.

  1. Under "Window" skal du vælge "Last 1 day", "Last 7 days" eller "Last 30 days". Standardindstillingen er syv dage.
  2. Læs de fire totaler: "Total Requests", "Error Rate", "Rate-Limit Hits" og "Webhook Success".
  3. Læs "Top API Paths" for at se, hvilke adresser der kaldes oftest, med deres fejl.
  4. Læs "Daily Trend" for at se trafikken pr. dag.
  5. Vælg "Refresh" for at indlæse de seneste tal.

Registrer en webhook

  1. På siden "Webhook Management" skal du gå til "Create Subscription".
  2. I "Target URL" skal du indtaste HTTPS-adressen på din modtager.
  3. Under "Events" skal du vælge de hændelser, du ønsker at modtage. Hændelserne er grupperet: samtaler, beskeder, kontakter, sager, opkald, vidensbase og system.
  4. Vælg "Create webhook".
  5. En dialog viser signeringshemmeligheden. Vælg "Copy secret" og gem hemmeligheden et sikkert sted. AurionAI viser den kun denne ene gang.
  6. Vælg "I have saved my secret".

Den nye webhook vises under "Subscriptions" med status "Active".

Bekræft en webhook-signatur

Hver levering er en POST-anmodning med en JSON-body og disse headere:

  • X-Webhook-Event: navnet på hændelsen, for eksempel ticket.created.
  • X-Webhook-Timestamp: tidspunktet for leveringen.
  • X-Webhook-Signature: signaturen for leveringen.

Sådan kontrollerer du, at en levering kommer fra AurionAI:

  1. Tag værdien af X-Webhook-Timestamp, et punktum og den rå body i anmodningen, i denne rækkefølge.
  2. Beregn en HMAC-SHA256 af denne tekst med din signeringshemmelighed.
  3. Skriv resultatet i hexadecimal og sammenlign det med X-Webhook-Signature. Accepter kun leveringen, når de er ens.

Test, sæt på pause eller slet en webhook

  • Vælg "Send test" for at sende en testlevering. En webhook på pause kan ikke modtage en test.
  • Vælg "Pause" for at stoppe leveringer i en periode, og "Resume" for at starte dem igen.
  • Vælg "Delete" og bekræft for at fjerne webhookken.
  • Siden viser de seneste leveringer med deres status, antal forsøg og HTTP-status fra din modtager.

Resultat

AurionAI sender hver valgt hændelse til din adresse. En levering tæller som vellykket, når din modtager svarer med en 2xx-status. Ellers forsøger AurionAI igen senere, op til fem forsøg i alt.

Hvis noget går galt

  • "Webhook URL is required." Indtast adressen på din modtager.
  • "Select at least one event to subscribe to." Vælg mindst én hændelse.
  • En besked siger, at webhook-URL'en skal starte med https. AurionAI sender kun webhooks til HTTPS-adresser.
  • En besked siger, at adressen er blokeret eller ikke kan løses. AurionAI afviser private, lokale og ukendte adresser. Brug en offentlig adresse, der kan løses i DNS.
  • Signaturen stemmer ikke overens. Brug den rå body som modtaget, inden nogen parsing. Brug hemmeligheden for denne webhook. Hvis du har mistet hemmeligheden, skal du slette webhookken og oprette den igen.
  • Leveringer mislykkes. Kontrollér HTTP-status i leveringslisten. Din modtager skal svare med en 2xx-status.
  • "No webhooks configured" under "Webhook Success". Din organisation har endnu ingen developer webhook.

Relaterede artikler

Sidder du stadig fast? Send en anmodning eller .