Przejdź do głównej zawartości

Uwierzytelnianie i klucze API

Utwórz klucz API sk_ w /centrum API . Pełny klucz jest wyświetlany tylko raz, podczas jego utworzenia lub rotacji.

Używaj osobnego klucza dla każdej aplikacji, środowiska i zadania automatycznego, aby każde z nich mogło mieć własne ograniczenie budżetu oraz być samodzielnie wyłączane, wymieniane i audytowane.

Zalecane:

X-API-Key: sk_your_key

Standardowa forma Bearer również działa:

Authorization: Bearer sk_your_key

W żądaniu należy przesłać tylko jeden z tych dwóch.

Okno terminala
curl https://omnidoc.top/api/v1/jobs \
-H "X-API-Key: $OMNIDOC_API_KEY"

Klucz działa w kontekście konta, które go utworzyło: może wywoływać usługi dostępne dla tego konta i uzyskiwać dostęp wyłącznie do zasobów tego konta. Klucz nie może zmieniać adresu e-mail logowania, hasła, numeru telefonu ani profilu użytkownika, a także nie może tworzyć, obracać ani unieważniać kluczy API.

Opcjonalne limity:

  • allowed_engines: tylko wymienione ustawienia tłumaczenia; pusty tablicy nie dodaje żadnego ograniczenia na poziomie klucza.
  • expires_at: czas wygaśnięcia.
  • quota_limit: budżet na życie klucza w całościowym milicredytach; 0 nie ustawia żadnego budżetu na poziomie klucza, a kredyty konta są rozliczane standardowo.

Utwórz klucze, zmień ich limity, obróć je lub unieważnij w centrum API . Gdy klucz zostanie unieważniony, wyłączony lub wygasł, albo gdy konto użytkownika zostanie wyłączone, nowe żądania natychmiast zawiodą.

Operacja rotacji tworzy nowy klucz tajny i jednocześnie dezaktywuje stary; nowy klucz zachowuje pierwotne limity oraz zużyty już budżet. Klucza wygasłego nie można poddać rotacji – należy utworzyć nowy. Aby zapewnić płynną migrację, utwórz nowy klucz i wdroż go, upewnij się, że wszystkie wywołania są udane, a następnie unieważnij stary klucz.

  • Przechowuj klucze wyłącznie na serwerze lub w kontrolowanym środowisku wykonawczym.
  • Używaj zmiennych środowiskowych lub menedżera tajemnic; nigdy nie umieszczaj kluczy w kodzie źródłowym, logach, paczkach przeglądarki ani w publicznych repozytoriach.
  • Nigdy nie przesyłaj klucza do adresów upload lub download zwracanych przez API.
  • Zapisuj identyfikator klucza, identyfikator żądania i identyfikator operacji; nigdy nie zapisuj pełnego klucza.
  • Jeśli klucz ulegnie wycieczce, natychmiast go wymień i sprawdź przypisane mu zadania oraz obciążenia.