Skip to main content
Az API-kulcsok hitelesítik a /v1 nyilvános API-hoz küldött kéréseket. Minden kulcs egy szolgáltatásfiókhoz tartozik, és annak a fióknak a részletek oldaláról hozható létre a Developer Hubban. Használjon hatókörrel ellátott API-kulcsot egy privát háttérrendszer-integrációhoz, ha a titkos kulcs biztonságos tárolása és forgatása megfelel az Ön követelményeinek. Nincs szükség OAuth-kliensre vagy tokencserére. Ha a szervezete rövid élettartamú OAuth-hozzáférési tokeneket ír elő, tekintse meg a Hitelesítés című részt.

A kulcs felépítése

  • Azonosító — ak_ előtaggal kezdődik. Biztonsággal hivatkozhat rá hibajegyekben, naplókban és konfigurációban; önmagában semmilyen jogosultságot nem biztosít.
  • Titkos kulcs — lsk_live_ előtaggal kezdődik. Ezt a hitelesítő adatot mutatja be az integráció. Csak egyszer jelenik meg, a létrehozáskor vagy a forgatáskor, később nem kérdezhető le. A kulcslista csak az utolsó négy karaktert mutatja (például lsk_live_…xQc4), így egy sort összepárosíthat a hívó birtokában lévő hitelesítő adattal.
  • Engedélyek — a kulcsot birtokló szolgáltatásfiók engedélyeinek egy részhalmaza, amelyet a létrehozáskor választ ki. Egy kulcs sosem tehet többet, mint amennyit a fiókja megenged.
  • Lejárat — kötelező. Minden kulcsnak van lejárati dátuma.
A titkos kulcsokat még megjelenésük pillanatában mentse el egy titokkezelő rendszerbe. Soha ne vegye fel őket verziókezelőbe, ne ágyazza be őket kliensoldali kódba, és ne ossza meg őket csevegésben. A titkos kulcs birtokosa a kulcs engedélyeivel járhat el.

Kulcs létrehozása

A szolgáltatásfiók részletek oldalán a kulcs létrehozása négy lépésből áll: nevezze el, válassza ki az adott kulcshoz szükséges engedélyeket, válasszon lejáratot — 30, 90 vagy 365 napot, illetve legfeljebb egy évig terjedő egyéni időszakot —, majd tekintse át a beállításokat. A titkos kulcs a befejezéskor jelenik meg, egyszer. Minden kulcs hatókörét a hívója számára szükséges legszűkebb engedélykészletre korlátozza, akkor is, ha a fiók többet engedélyez. Ha egy kulcs kiszivárog, az engedélyei határozzák meg a kár kiterjedését.

Forgatás állásidő nélkül

A forgatás új titkos kulcsot állít ki, és elindít egy átfedési időszakot — 1 órát, 24 órát vagy 7 napot —, amely alatt a régi titkos kulcs továbbra is működik. Így az új titkos kulcsot a saját tempójában juttathatja el a telepítéseibe:
1

A kulcs forgatása

Válasszon olyan átfedési időszakot, amely lefedi a leglassabb telepítési útvonalat. Az új titkos kulcs egyszer jelenik meg — azonnal mentse el.
2

Az integrációk frissítése

Cserélje le a régi titkos kulcsot mindenhol, ahol be van állítva. A kulcs állapota az időszak végéig átfedésben lévőként jelenik meg.
3

Ellenőrzés az időszak lezárulta előtt

A kérésnaplók segítségével győződjön meg arról, hogy a forgalom áttért az új titkos kulcsra. Az átfedés végén a régi titkos kulcs már nem hitelesít.
A lejárat előtt is érdemes forgatni: a lejárati dátumukhoz közeledő kulcsokat a kulcslista lejáróként jelöli. A lejárt kulcs már nem hitelesít — a vele küldött kérések 401 választ adnak credential_expired kóddal.

Azonnali visszavonás

A visszavonás azonnal érvénybe lép, és végleges — nincs átfedési időszak, és nem vonható vissza. Vonja vissza a kulcsot, amint azt gyanítja, hogy a titkos kulcsa illetéktelen kezekbe került; ha ellenben egy ép hitelesítő adatot cserél le, használja inkább a forgatást. A visszavont kulccsal küldött kérések 401 választ adnak credential_revoked kóddal. Ha egy integráció összes kulcsát egyszerre kell leállítania, inkább tiltsa le az adott szolgáltatásfiókot.