Tovább a tartalomhoz

Hitelesítés és API kulcsok

Hozzon létre egy sk_ API kulcsot az API központban . A teljes kulcs csak egyszer jelenik meg, amikor létrehozzák vagy újra generálják.

Használjon külön kulcsot minden alkalmazáshoz, környezethez és automatizált feladathoz, hogy mindegyiknek saját költségvetése legyen, és önállóan lehessen letiltani, cserélni és ellenőrizni.

Ajánlott:

X-API-Key: sk_your_key

A standard Bearer form is also works:

Authorization: Bearer sk_your_key

Kérésben csak az egyiket küldje el a kettő közül.

Terminál
curl https://omnidoc.top/api/v1/jobs \
-H "X-API-Key: $OMNIDOC_API_KEY"

A kulcs az azt létrehozó fiók számára érvényes: a fiók által használható és elérhető szolgáltatásokat hívhatja meg, és csak a fiók erőforrásait érheti el. Egy kulcs nem képes módosítani a bejelentkezési e-mail-címet, jelszót, telefonszámot vagy profiladatokat, valamint nem hozhat létre, forgathat fel vagy vonhat vissza API-kulcsokat.

Opcionális határok:

  • allowed_engines: csak a felsorolt fordítási beállítások; az üres tömb nem ad hozzá kulcs-szintű korlátozást.
  • expires_at: lejárati idő.
  • quota_limit: a kulcs élettartam-büdzséje teljes mili-kreditben; 0 nem állít be kulcs-szintű büdzsét, és a fiók kreditjei a szokásos módon kerülnek elszámolásra.

Kulcsok létrehozása, korlátok módosítása, forgatása vagy visszavonása az API központban . Amint egy kulcs visszavonásra kerül, letiltásra vagy lejár, vagy a hozzá tartozó fiók letiltásra kerül, az új kérések azonnal sikertelenek lesznek.

A forgatás egy új titkot hoz létre, és azonnal leállítja a régit; az új kulcs megtartja az eredeti korlátokat és a már felhasznált költségkeretet. A lejárt kulcs nem forgatható; hozzon létre egy újat. A zökkenőmentes váltás érdekében hozzon létre egy új kulcsot, helyezze üzembe, győződjön meg róla, hogy a hívások sikeresek, majd vonja vissza a régi kulcsot.

  • Tartsa a kulcsokat kizárólag a szerveren vagy egy ellenőrzött futásidejű környezetben.
  • Használjon környezeti változókat vagy titkosított adatkezelőt; soha ne tároljon kulcsokat a forráskódban, naplófájlokban, böngésző-csomagokban vagy nyilvános külső tárhelyeken.
  • Soha ne küldje el a kulcsot az API által visszaadott feltöltési vagy letöltési címekhez.
  • Regisztrálja a kulcsazonosítót, a kérésazonosítót és a műveletazonosítót; soha ne regisztrálja a teljes kulcsot.
  • Ha egy kulcs szivárog, azonnal cserélje ki, és ellenőrizze a hozzá tartozó munkafolyamatokat és díjakat.