Autoryzacja

Dwa sposoby uwierzytelnienia: klucz API w HTTP Basic albo token OAuth 2.1 w nagłówku Bearer.

Na tej stronie

Każde zapytanie do API musi mieć nagłówek Authorization. Hypris przyjmuje dwa schematy: Basic z kluczem API i Bearer z tokenem OAuth 2.1.

Który sposób wybrać

SytuacjaSposób
Własny skrypt, integracja serwer z serwerem, automatyzacja w n8nKlucz API (Basic)
Aplikacja, do której użytkownicy logują się kontem HyprisOAuth 2.1 (Bearer)
Asystent AI przez MCPOAuth 2.1, klient załatwia to sam
Integracja, która ma działać jako aplikacja, a nie jako TyKlucz aplikacji (Basic)

Klucz API: HTTP Basic

Klucz składa się z identyfikatora i sekretu. Połącz je dwukropkiem, zakoduj w base64 i wyślij w nagłówku:

Nagłówek
Authorization: Basic base64(keyId:secret)

Większość narzędzi zrobi to za Ciebie:

curl "https://api.staging.hypris.com/v1/me" -u "$KEY_ID:$SECRET"

Hypris sprawdza najpierw klucze użytkowników, a potem klucze aplikacji. Różnice między nimi opisuje przewodnik Klucze API.

Token OAuth: Bearer

Aplikacja, która przeszła przepływ OAuth 2.1, wysyła token dostępu:

Nagłówek
Authorization: Bearer <access_token>

Token dostępu jest ważny godzinę. Potem odśwież go tokenem odświeżania, bez ponownego logowania użytkownika.

Workspace w zapytaniu

Nie ma osobnego nagłówka z workspace. Identyfikator workspace albo zasobu zawsze jest w ścieżce, na przykład /workspace/:workspaceId/databases albo /database/:databaseId. Token OAuth jest dodatkowo przypisany do workspace wybranego na ekranie zgody.

Gdy autoryzacja się nie uda

KodCo oznacza
401Brak nagłówka, zły klucz, wyłączony albo wygasły klucz, wygasły token.
403Uwierzytelnienie się udało, ale brakuje uprawnień do zasobu.

Szczegóły i przykładowe odpowiedzi znajdziesz w przewodniku Błędy i limity.