Skip to main content
API atslēgas autentificē pieprasījumus /v1 Public API. Katra atslēga pieder pakalpojuma kontam un tiek izveidota no šī konta informācijas lapas Developer Hub. Izmantojiet ierobežota tvēruma API atslēgu privātai aizmugursistēmas integrācijai, ja slepenās vērtības droša glabāšana un nomaiņa atbilst jūsu prasībām. OAuth klients vai pilnvaras apmaiņa nav nepieciešama. Ja jūsu organizācijai tā vietā ir nepieciešamas īslaicīgas OAuth piekļuves pilnvaras, skatiet sadaļu Authentication.

Atslēgas uzbūve

  • Identifier — sākas ar ak_. Droši atsaukties uz to pieteikumos, žurnālos un konfigurācijā; pati par sevi tā nepiešķir nekādas tiesības.
  • Secret — sākas ar lsk_live_. Tie ir akreditācijas dati, ko jūsu integrācija uzrāda. Tā tiek parādīta vienu reizi — izveides vai nomaiņas brīdī — un vēlāk to nevar atgūt. Atslēgu sarakstā tiek rādīti tikai pēdējie četri rakstzīmes (piemēram, lsk_live_…xQc4), lai varētu saskaņot rindu ar akreditācijas datiem, kas ir pieprasījuma veicējam.
  • Permissions — pakalpojuma konta atļauju apakškopa, kas izvēlēta izveides brīdī. Atslēga nekad nevar darīt vairāk, nekā atļauj tās konts.
  • Expiration — obligāts. Katrai atslēgai ir derīguma termiņš.
Uzglabājiet slepenās vērtības slepeno datu pārvaldniekā uzreiz pēc to parādīšanas. Nekad neiekļaujiet tās versiju vadībā, neievietojiet klienta puses kodā un nedalieties ar tām tērzēšanā. Ikviens, kam ir slepenā vērtība, var darboties ar atslēgas atļaujām.

Atslēgas izveide

Pakalpojuma konta informācijas lapā atslēgu izveidojiet četros soļos: piešķiriet nosaukumu, izvēlieties atļaujas, kas nepieciešamas tieši šai atslēgai, izvēlieties derīguma termiņu — 30, 90 vai 365 dienas, vai pielāgotu periodu līdz vienam gadam — un pārskatiet iestatījumus. Slepenā vērtība tiek parādīta pēc pabeigšanas, vienu reizi. Ierobežojiet katras atslēgas tvērumu līdz šaurākajam atļauju kopumam, kas nepieciešams tās lietotājam, pat ja konts atļauj vairāk. Ja atslēga noplūst, tās atļaujas nosaka iespējamo seku apjomu.

Nomaiņa bez dīkstāves

Nomaiņas laikā tiek izsniegta jauna slepenā vērtība un sākas pārklāšanās periods — 1 stunda, 24 stundas vai 7 dienas —, kura laikā vecā slepenā vērtība turpina darboties. Tas ļauj ieviest jauno slepeno vērtību jūsu izvietojumos jums piemērotā tempā:
1

Nomainiet atslēgu

Izvēlieties pārklāšanās periodu, kas aptver jūsu lēnāko izvietošanas ceļu. Jaunā slepenā vērtība tiek parādīta vienu reizi — nekavējoties to saglabājiet.
2

Atjauniniet savas integrācijas

Aizstājiet veco slepeno vērtību visur, kur tā ir konfigurēta. Atslēgas statuss tiek rādīts kā in-overlap, līdz periods beidzas.
3

Pārbaudiet, pirms periods beidzas

Izmantojiet pieprasījumu žurnālus, lai pārliecinātos, ka datplūsma ir pārgājusi uz jauno slepeno vērtību. Kad pārklāšanās periods beidzas, vecā slepenā vērtība vairs nenodrošina autentifikāciju.
Nomainiet atslēgu arī pirms derīguma termiņa beigām: atslēgas, kuru derīguma termiņš tuvojas beigām, atslēgu sarakstā tiek atzīmētas kā expiring. Atslēga ar beigušos termiņu vairs nenodrošina autentifikāciju — pieprasījumi, kas veikti ar to, atgriež 401 ar kodu credential_expired.

Tūlītēja atsaukšana

Atsaukšana stājas spēkā nekavējoties un ir neatgriezeniska — nav ne pārklāšanās perioda, ne atsaukšanas iespējas. Atsauciet atslēgu tajā pašā brīdī, kad aizdomas, ka tās slepenā vērtība ir atklāta; savukārt nomainiet atslēgu, ja aizstājat darbspējīgus akreditācijas datus. Pieprasījumi, kas veikti ar atsauktu atslēgu, atgriež 401 ar kodu credential_revoked. Ja nepieciešams vienlaikus apturēt visas integrācijas atslēgas, tā vietā atspējojiet tās pakalpojuma kontu.