API-avaimet

API-avain antaa toiselle ohjelmalle mahdollisuuden käyttää AurionAI-rajapintaa organisaatiosi puolesta. Jokaisella avaimella on luettelo käyttöoikeuksista, joita kutsutaan laajuuksiksi. Avain voi tehdä vain sen, mitä sen laajuudet sallivat.

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

Edellytykset

• Sinulla on Omistaja- tai Ylläpitäjä-rooli. Muut käyttäjät näkevät Pääsy estetty.
• Tiedät, mitä ohjelman täytyy tehdä, jotta voit antaa sille vain tarvittavat laajuudet.

Avaa API-avaimet

1. Valitse sivupalkista Asetukset.
2. Avaa Järjestelmä-kategoria.
3. Valitse API-avaimet.

Aktiiviset avaimet-taulukossa näkyvät kunkin avaimen nimi, avaimen alku, laajuudet, tila, luontipäivä, viimeisin käyttö ja vanhentumispäivä. Peruutetut avaimet on lueteltu kohdassa Mitätöidyt avaimet.

Luo avain

1. Valitse Luo avain.
2. Kirjoita Nimi-kenttään nimi, joka kertoo, mikä ohjelma käyttää avainta.
3. Valinnainen: kirjoita Kuvaus (valinnainen)-kenttään kuvaus avaimen käyttötarkoituksesta.
4. Valitse Vanheneminen-kohdassa, milloin avain vanhenee. Oletusarvo on 90 päivää. Voit myös valita Ei vanhenemista.
5. Valitse laajuudet Oikeudet-kohdasta. Ryhmän valintaruutu valitsee kaikki ryhmän laajuudet.
6. Valitse Luo avain.
7. Kopioi avain Kopioi API-avain-painikkeella. AurionAI näyttää koko avaimen vain tällä kertaa.
8. Valitse Kopioin sen — sulje.

Ohjelma lähettää avaimen jokaisen pyynnön X-API-Key-otsikossa. Avain alkaa merkkijonolla itsm_sk_live_ tai hiekkalaatikko-organisaation tapauksessa merkkijonolla itsm_sk_test_.

Laajuudet

Huomioita laajuuksista:

• Tietopohjan artikkelien julkaisemiseksi kuvineen avain tarvitsee laajuudet kb:read, kb:write ja kb:media. Pelkillä laajuuksilla kb:read ja kb:write kuvien lataaminen ei onnistu. Artikkelien poistamiseen ei ole omaa laajuutta.
• Puhelun litteraatin viemiseksi avain tarvitsee laajuudet conversations:read, conversations:write ja conversations:export; ennen conversations:export-laajuuden olemassaoloa luodut avaimet eivät voi viedä litteraatteja, ennen kuin luot korvaavan avaimen, jossa se on mukana.
• "Kaikki oikeudet" -laajuutta ei ole. Valitse kukin laajuus, jota ohjelma tarvitsee.

Kierrätä avain

Kierrätä avain, jos epäilet jonkun muun tietävän sen.

1. Valitse avaimen Toiminnot-sarakkeesta Kierrätä avain.
2. Valitse Kierrätä API-avain-valintaikkunassa Kierrätä avain.
3. Kopioi uusi avain. Vanha avain lakkaa toimimasta. Päivitä ohjelma uudella avaimella.

Uusi avain säilyttää vanhan avaimen nimen, laajuudet ja vanhentumispäivän.

Peruuta avain

1. Valitse avaimen Toiminnot-sarakkeesta Mitätöi avain.
2. Valitse Mitätöi API-avain-valintaikkunassa Mitätöi avain.

Viesti API-avain mitätöity tulee näkyviin. Avainta käyttävät ohjelmat menettävät pääsyn välittömästi. Toimintoa ei voi kumota.

Tulos

Uusi avain toimii heti, vain omilla laajuuksillaan. Tila-sarake näyttää arvon Aktiivinen, Vanhenee pian seitsemän viimeisen päivän aikana ennen vanhentumista, Vanhentunut tai Mitätöity.

Jos jokin menee pieleen

• Valitse vähintään yksi oikeus Valitse vähintään yksi laajuus.
• API-avaimen luonti epäonnistui Yritä uudelleen. Jos se epäonnistuu uudelleen, ota yhteyttä AurionAI-tukeen. Lue Hanki apua.
• Salaisuus ei ole saatavilla AurionAI ei näyttänyt avainta. Älä käytä tätä avainta. Peruuta se ja luo uusi.
• Olet hukannut avaimen. AurionAI ei voi näyttää sitä uudelleen. Kierrätä avain tai luo uusi.
• Avaimella tehty pyyntö hylätään. Avaimelta puuttuu tämän pyynnön vaatima laajuus, tai se on vanhentunut tai peruutettu. Tarkista Käyttöalueet- ja Tila-sarakkeet.
• Ohjelma ei pysty lataamaan kuvia tietopohjaan. Lisää kb:media: luo uusi avain laajuuksilla kb:read, kb:write ja kb:media.

Aiheeseen liittyvät artikkelit

• Kehittäjän API: käyttö ja webhookit
• Yhdistä ITSM- ja CS-työkalusi
• Hanki apua