Klucze API
Uwierzytelniaj Bob na potrzeby automatyzacji bez logowania przez przeglądarkę. Dostępne dla użytkowników planu trial i płatnych. Zarządzaj kluczami indywidualnie lub jako administrator całej instancji.
Własność i administracja
Klucze API są przypisane zarówno do użytkownika, jak i instancji subskrypcji. Indywidualni użytkownicy mogą tworzyć, listować i unieważniać własne klucze API. Administratorzy instancji subskrypcji mogą listować i unieważniać klucze API wszystkich użytkowników w swojej instancji.
Typy kluczy API
Możesz tworzyć dwa rodzaje kluczy API:
| Typ | Zakres i zastosowanie |
|---|---|
| Ogólny | Przypisany do instancji subskrypcji i używany w wielu serwisach. Do żądań inference musisz również podać nagłówek z identyfikatorem zespołu. |
| Inference | Przypisany do konkretnej instancji subskrypcji i zespołu, ograniczony wyłącznie do żądań inference. Dodatkowe nagłówki instancji ani zespołu nie są wymagane. |
Kiedy używać kluczy API
Używaj kluczy API, gdy potrzebujesz:
- Uwierzytelniać Bob Shell w sesjach nieinteraktywnych
- Uruchamiać Bob w pipeline'ach CI/CD lub zaplanowanej automatyzacji
- Unikać logowania przez przeglądarkę w skryptowanych przepływach pracy
- Uwierzytelniać żądania inference ogólnym lub inference kluczem API
Tworzenie klucza API
Przejdź do bob.ibm.com i zaloguj się.
Otwórz swoją instancję subskrypcji i przejdź do sekcji zarządzania kluczami API.
Utwórz nowy klucz API i wybierz typ klucza, który chcesz utworzyć.
Skopiuj wartość klucza API i przechowaj ją w bezpiecznym miejscu.
Nie możesz ponownie wyświetlić wartości klucza API po jego utworzeniu.
Zarządzanie kluczami API
Sekcja zarządzania kluczami API umożliwia:
- Listowanie kluczy API
- Wyszukiwanie i filtrowanie kluczy
- Wyświetlanie szczegółów klucza API
- Unieważnianie aktywnych kluczy
- Wyświetlanie unieważnionych kluczy obok aktywnych i wygasłych
Możliwości administratora
Administratorzy instancji subskrypcji mogą zarządzać kluczami API w całej instancji. Możliwości administratora obejmują:
- Listowanie kluczy API wszystkich użytkowników w instancji
- Unieważnianie kluczy API dowolnego użytkownika w instancji
- Wyświetlanie aktywnych, unieważnionych i wygasłych kluczy
Używanie klucza API z Bob Shell
Aby użyć klucza API z Bob Shell, zapoznaj się z dokumentacją Instalacja i konfiguracja Bob Shell oraz Uruchamianie sesji nieinteraktywnej.