Kehittäjä-API: käyttö ja webhookit

Kehittäjä-API-sivut näyttävät, miten ohjelmat käyttävät AurionAI-rajapintaa, ja antavat sinun lähettää AurionAI-tapahtumia omiin järjestelmiisi webhookien avulla.

Saatavuus: kaikki profiilit. Vain järjestelmänvalvojille.

Edellytykset

• Sinulla on Omistaja- tai Ylläpitäjä-rooli. Muut roolit eivät voi avata näitä sivuja.
• Webhookeja varten: HTTPS-osoite omalla puolellasi, joka hyväksyy POST-pyynnöt JSON-rungolla.

Avaa kehittäjä-API-sivut

1. Valitse yläpalkista nimesi tai kuvasi avataksesi käyttäjävalikon.
2. Valitse Organisaatioasetukset.
3. Siirry Kehittäjä-API-korttiin.
4. Valitse API-käyttöpaneeli tai Webhook-hallinta.

Tarkastele API-käyttöä

"API Usage Dashboard" -sivu näyttää AurionAI-rajapinnan liikenteen organisaatiollesi.

1. Valitse "Window"-kohdasta "Last 1 day", "Last 7 days" tai "Last 30 days". Oletusarvo on seitsemän päivää.
2. Lue neljä yhteenvetoa: "Total Requests", "Error Rate", "Rate-Limit Hits" ja "Webhook Success".
3. Lue "Top API Paths" nähdäksesi, mitä osoitteita kutsutaan eniten ja niiden virheet.
4. Lue "Daily Trend" nähdäksesi liikenteen päivittäin.
5. Valitse "Refresh" ladataksesi uusimmat luvut.

Rekisteröi webhook

1. Siirry "Webhook Management" -sivulla kohtaan "Create Subscription".
2. Kirjoita "Target URL" -kenttään vastaanottimesi HTTPS-osoite.
3. Valitse "Events"-kohdasta tapahtumat, jotka haluat vastaanottaa. Tapahtumat on ryhmitelty: keskustelut, viestit, yhteystiedot, tiketit, puhelut, tietopohja ja järjestelmä.
4. Valitse "Create webhook".
5. Valintaikkuna näyttää allekirjoitussalaisuuden. Valitse "Copy secret" ja tallenna salaisuus turvalliseen paikkaan. AurionAI näyttää sen vain tällä kertaa.
6. Valitse "I have saved my secret".

Uusi webhook näkyy "Subscriptions"-kohdassa tilalla "Active".

Tarkista webhookin allekirjoitus

Jokainen toimitus on POST-pyyntö JSON-rungolla ja näillä otsakkeilla:

• X-Webhook-Event: tapahtuman nimi, esimerkiksi ticket.created.
• X-Webhook-Timestamp: toimituksen aika.
• X-Webhook-Signature: toimituksen allekirjoitus.

Varmistaaksesi, että toimitus tulee AurionAI:lta:

1. Ota X-Webhook-Timestamp-arvo, piste ja pyynnön raaka runko tässä järjestyksessä.
2. Laske tästä tekstistä HMAC-SHA256 allekirjoitussalaisuudellasi.
3. Kirjoita tulos heksadesimaalimuodossa ja vertaa sitä X-Webhook-Signature-arvoon. Hyväksy toimitus vain, kun ne ovat yhtä suuret.

Testaa, keskeytä tai poista webhook

• Valitse "Send test" lähettääksesi testintoimituksen. Keskeytetty webhook ei voi vastaanottaa testiä.
• Valitse "Pause" keskeyttääksesi toimitukset hetkeksi ja "Resume" aloittaaksesi ne uudelleen.
• Valitse "Delete" ja vahvista poistaaksesi webhookin.
• Sivu listaa viimeisimmät toimitukset, niiden tilan, yritysten määrän ja vastaanottimesi HTTP-tilan.

Tulos

AurionAI lähettää jokaisen valitun tapahtuman osoitteeseesi. Toimitus lasketaan onnistuneeksi, kun vastaanottimesi vastaa 2xx-tilakoodilla. Muussa tapauksessa AurionAI yrittää uudelleen myöhemmin, yhteensä enintään viisi kertaa.

Jos jokin menee pieleen

• "Webhook URL is required." Kirjoita vastaanottimesi osoite.
• "Select at least one event to subscribe to." Valitse vähintään yksi tapahtuma.
• Viesti kertoo, että webhook-URL:n on alettava https:llä. AurionAI lähettää webhookeja vain HTTPS-osoitteisiin.
• Viesti kertoo, että osoite on estetty tai sitä ei voida ratkaista. AurionAI hylkää yksityiset, paikalliset ja tuntemattomat osoitteet. Käytä julkista osoitetta, joka ratkeaa DNS:ssä.
• Allekirjoitus ei täsmää. Käytä raakaa runkoa sellaisena kuin se on vastaanotettu, ennen jäsentämistä. Käytä tämän webhookin salaisuutta. Jos olet menettänyt salaisuuden, poista webhook ja luo se uudelleen.
• Toimitukset epäonnistuvat. Tarkista HTTP-tila toimituslistasta. Vastaanottimesi on vastattava 2xx-tilakoodilla.
• "No webhooks configured" kohdassa "Webhook Success". Organisaatiollasi ei ole vielä kehittäjäwebhookia.

Aiheeseen liittyvät artikkelit

• API-avaimet
• Ilmoituswebhookit
• Yritysprofiili ja vuokralaisen asetukset