Skip to main content
API-avaimet todentavat pyynnöt /v1 Public API -rajapintaan. Jokainen avain kuuluu palvelutilille, ja se luodaan kyseisen tilin tietosivulta Developer Hubissa. Käytä rajattua API-avainta yksityisessä taustajärjestelmäintegraatiossa, kun salaisuuden turvallinen tallennus ja kierrätys täyttää organisaatiosi vaatimukset. OAuth-asiakasta tai tunnisteen vaihtoa ei tarvita. Katso Todennus, jos organisaatiosi edellyttää sen sijaan lyhytikäisiä OAuth-käyttöoikeustunnuksia.

​
Avaimen rakenne

  • Tunniste — alkaa merkkijonolla ak_. Sitä voi turvallisesti käyttää viittauksena tiketeissä, lokeissa ja määrityksissä; se ei yksinään myönnä mitään oikeuksia.
  • Salaisuus — alkaa merkkijonolla lsk_live_. Tämä on tunnistetieto, jonka integraatiosi esittää. Se näytetään vain kerran, luonnin tai kierrätyksen yhteydessä, eikä sitä voi hakea myöhemmin. Avainluettelossa näkyvät vain neljä viimeistä merkkiä (esimerkiksi lsk_live_…xQc4), joten rivin voi yhdistää kutsujan hallussa olevaan tunnistetietoon.
  • Käyttöoikeudet — osajoukko omistavan palvelutilin käyttöoikeuksista, valitaan luonnin yhteydessä. Avain ei voi koskaan tehdä enempää kuin sen tili sallii.
  • Vanheneminen — pakollinen. Jokaisella avaimella on vanhenemispäivä.
Tallenna salaisuudet salaisuuksien hallintaan heti, kun ne näytetään. Älä koskaan vie niitä versionhallintaan, upota niitä asiakaspuolen koodiin äläkä jaa niitä chatissa. Jokainen, jolla on salaisuus, voi toimia avaimen käyttöoikeuksilla.

​
Avaimen luominen

Luo avain palvelutilin tietosivulla neljässä vaiheessa: anna sille nimi, valitse juuri tälle avaimelle tarvittavat käyttöoikeudet, valitse vanheneminen — 30, 90 tai 365 päivää tai mukautettu enintään vuoden jakso — ja tarkista tiedot. Salaisuus näytetään lopuksi, vain kerran. Rajaa jokaisen avaimen käyttöoikeudet suppeimpaan joukkoon, jota sen kutsuja tarvitsee, vaikka tili sallisi enemmän. Jos avain vuotaa, sen käyttöoikeudet määrittävät vahinkojen laajuuden.

​
Kierrätys ilman käyttökatkoa

Kierrätys luo uuden salaisuuden ja käynnistää päällekkäisyysjakson — 1 tunti, 24 tuntia tai 7 päivää — jonka aikana vanha salaisuus toimii edelleen. Näin voit ottaa uuden salaisuuden käyttöön käyttöönotoissasi omaan tahtiisi:
1

Kierrätä avain

Valitse päällekkäisyysjakso, joka kattaa hitaimman käyttöönottopolkusi. Uusi salaisuus näytetään vain kerran — tallenna se heti.
2

Päivitä integraatiosi

Korvaa vanha salaisuus kaikkialla, missä se on määritetty. Avaimen tilana näkyy päällekkäisyys, kunnes jakso päättyy.
3

Tarkista ennen jakson päättymistä

Varmista pyyntölokeista, että liikenne on siirtynyt uuteen salaisuuteen. Kun päällekkäisyysjakso päättyy, vanha salaisuus ei enää todenna pyyntöjä.
Kierrätä avain myös ennen sen vanhenemista: vanhenemispäivää lähestyvät avaimet merkitään avainluettelossa vanhenevaksi. Vanhentunut avain ei enää todenna pyyntöjä — sillä tehdyt pyynnöt palauttavat virheen 401 koodilla credential_expired.

​
Peruutus välittömästi

Peruutus tulee voimaan välittömästi ja on pysyvä — päällekkäisyysjaksoa ei ole eikä peruutusta voi kumota. Peruuta avain heti, kun epäilet sen salaisuuden paljastuneen; kierrätä sen sijaan, kun korvaat toimivan tunnistetiedon. Peruutetulla avaimella tehdyt pyynnöt palauttavat virheen 401 koodilla credential_revoked. Jos haluat pysäyttää kaikki integraation hallussa olevat avaimet kerralla, poista sen palvelutili käytöstä.