Przewodniki

Szybki start

Twórz standardowe klucze API i zarządzaj nimi oraz stosuj mechanizmy zabezpieczające przy użyciu klucza zarządzającego RunAPI.

Zobacz Markdown

Zarządzanie platformą umożliwia administratorom kont tworzenie, przeglądanie, aktualizowanie i unieważnianie standardowych kluczy API oraz zabezpieczeń bez konieczności korzystania z panelu podczas każdej zmiany.

Tworzenie klucza zarządzania

Postępuj zgodnie z Przewodnikiem po uwierzytelnianiu, aby się zalogować, a następnie otwórz stronę Kluczy zarządzających i utwórz klucz zarządzający. Przechowuj go oddzielnie od standardowych kluczy aplikacji. Wysyłaj go jako token Bearer wyłącznie do endpointów zarządzania platformą.

HTTP

Authorization: Bearer YOUR_MANAGEMENT_KEY

Standardowy klucz API nie może wywoływać punktów końcowych zarządzania kluczami ani barierami ochronnymi. Prawidłowy klucz zarządzający może nadal otrzymywać odpowiedź 403 Forbidden, gdy jego właściciel nie posiada już wymaganej roli na koncie.

Wyświetl listę standardowych kluczy API

Użyj GET /api/v1/keys, aby sprawdzić klucze widoczne dla konta klucza zarządzającego:

SHELL

curl "https://runapi.ai/api/v1/keys" \
  -H "Authorization: Bearer YOUR_MANAGEMENT_KEY"

Używaj zwróconych publicznych identyfikatorów do późniejszych żądań pobrania, aktualizacji, odwołania lub przypisania guardrail. Nigdy nie wywnioskuj dostępu na podstawie nazwy klucza ani zamaskowanego tokenu.

Utwórz i rotuj klucz

Utwórz klucz aplikacji za pomocą POST /api/v1/keys. Pełny tajny klucz jest zwracany tylko w odpowiedzi na tworzenie, więc zapisz go w swoim menedżerze tajnych kluczy przed odrzuceniem tej odpowiedzi. Rotacja powinna polegać na utworzeniu zamiennika, wdrożeniu go w aplikacji, weryfikacji ruchu, a następnie unieważnieniu starego klucza.

SHELL

curl -X POST "https://runapi.ai/api/v1/keys" \
  -H "Authorization: Bearer YOUR_MANAGEMENT_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Production worker"}'

credit_limit_windows akceptuje dowolną kombinację 1h, 1d i 7d kroczących limitów wydatków. Jeśli jakiekolwiek skonfigurowane okno zostanie wyczerpane, wywołania z tym kluczem zwracają 429 Too Many Requests do czasu, gdy użycie opuści okno. Wyślij pusty obiekt podczas aktualizowania klucza, aby wyczyścić wszystkie kroczące limity.

Zastosuj bariery ochronne (guardrails)

Guardrails to wielokrotnego użytku zasady konta dotyczące kontroli modelu, dostawcy i wydatków. Zarządzaj zasadami za pomocą /api/v1/guardrails, a następnie używaj /api/v1/guardrail_assignments do ich dołączania lub usuwania. Traktuj odrzucone przypisanie jako błąd zasad lub własności zamiast po cichu kontynuować bez guardrail.

Obsługa błędów zarządzania

401 Unauthorized oznacza, że poświadczenie jest brakujące, nieprawidłowo sformułowane, unieważnione lub nieważne.
403 Forbidden oznacza, że klasa poświadczeń lub rola konta nie pozwala na wykonanie tej operacji.
404 Not Found oznacza, że żądany zasób nie jest widoczny dla uwierzytelnionego konta.
422 Unprocessable Content oznacza, że co najmniej jedna z przesłanych wartości narusza regułę zasobu.