Skip to main content
Public API:n käyttö ei edellytä OAuthia. Yksityisessä, palvelinpuolen integraatiossa kannattaa aloittaa rajatulla API-avaimella ja noudattaa pikaopasta. Valitse OAuth-asiakastunnistetiedot, kun tietoturvakäytäntösi edellyttää lyhytikäisiä käyttöoikeustunnisteita tai integraatioalustasi tukee jo kyseistä kulkua. Molemmat vaihtoehdot käyttävät palvelutiliä. Palvelutili on integraation identiteetti, ei kolmas todennustapa.

Miten osat liittyvät toisiinsa

Luo yksi palvelutili kutakin integraatiota kohden. Valitse kyseiselle tilille joko API-avain tai OAuth-asiakas; molempia tapoja ei tarvita jokaisessa API-pyynnössä. Kumpikaan tunniste ei voi ylittää tilin nykyisiä käyttöoikeuksia. Pikaopas käyttää Basic-todennusta. API-avaimille tuetaan myös Bearer-otsaketta; tämän otsakkeen käyttö ei tarkoita, että tarvitsisit OAuth-asiakkaan.

Valitse API-avain yksinkertaiseen integraatioon

Käytä API-avainta omiin ajastettuihin ajoihisi, raportointiskripteihisi, datavirtoihisi tai muihin taustapalveluihisi, kun salaisuuden tallentaminen salaisuuksienhallintaan täyttää tietoturvavaatimuksesi.
  • Lähetä todennetut pyynnöt suoraan; tunnisteen vaihtoa ei tarvita.
  • Valitse vain työkuorman tarvitsemat käyttöoikeudet ja aseta vanhenemisaika.
  • Vaihda avain käyttämällä sen päällekkäisyysaikaa tai peruuta se heti, jos se on paljastunut.
API-avainta käyttävä integraatio ei tarvitse OAuth-asiakasta. Aloita pikaoppaasta ja katso luonti ja vaihto ohjeesta API-avaimet.

Valitse OAuth lyhytikäisiä käyttöoikeustunnisteita varten

Käytä OAuth-asiakastunnistetietoja luottamukselliseen taustapalveluun, kun organisaatiosi edellyttää vanhenevia käyttöoikeustunnisteita tai integraatiotyökalu odottaa client_credentials-myöntötyyppiä.
  1. Luo palvelutilille rajattu OAuth-asiakas.
  2. Todenna asiakas alueelliseen tunnuspalvelun päätepisteeseesi käyttämällä asennuksen yhteydessä annettua asiakkaan todennustapaa.
  3. Lähetä saatu käyttöoikeustunniste API-pyyntöjesi mukana. Hanki uusi tunniste ennen kuin nykyinen vanhenee.
OAuth lisää integraatioosi tunnisteiden hankinnan ja vanhenemisen käsittelyn. Asiakkaan salaisuus on edelleen tallennettava turvallisesti ja vaihdettava säännöllisesti; lyhytikäiset tunnisteet eivät poista tätä vastuuta. Client credentials -kulku ei käytä päivitystunnisteita: todenna asiakas uudelleen saadaksesi uuden käyttöoikeustunnisteen. OAuth-käyttö on otettava käyttöön organisaatiollesi. Jos sitä ei ole otettu käyttöön, käytä API-avainta tai ota yhteyttä Living Securityn tukeen vaatimuksistasi. Katso asiakkaan luonti, kertaluonteiset salaisuudet, peruuttaminen ja palautus ohjeesta OAuth-asiakastunnistetiedot.

Pidä tunnistetiedot taustajärjestelmässäsi

Palvelutilin API-avaimet ja OAuth-asiakkaan salaisuudet kuuluvat palvelinpuolen salaisuuksien tallennukseen. Älä sijoita niitä selaimessa suoritettavaan koodiin, mobiilisovelluksiin, versionhallintaan tai lokeihin. Palvelutilin tunniste toimii työkuormana; se ei kirjaa henkilöä sisään eikä tarjoa asiakkaan suostumuskulkua. Käytä kummassakin tavassa organisaatiosi alueellista API-isäntää. Todennustavan vaihtaminen ei muuta resurssin URL-osoitetta, API-versiota eikä toiminnon vaatimia käyttöoikeuksia.