Uwierzytelnianie
Klucze API konta, pełny i niestandardowy dostęp oraz gdzie utworzyć klucz.
Każde wywołanie CPI niesie klucz API. Nie ma osobnego identyfikatora klienta, handshaku OAuth ani podpisu do obliczenia, jest jeden klucz wysyłany razem z żądaniem.
Tworzenie klucza
Klucze są w panelu, na ekranie Deweloperzy w menu konta, na karcie Klucze API. Projekt ma
własną kartę API, która tworzy ten sam rodzaj klucza już ograniczony do tego projektu, więc
nigdy nie wpisujesz app_id ręcznie. Interaktywna piaskownica dokumentacji API
też może utworzyć klucz od razu, żebyś mógł wypróbować metodę, zanim cokolwiek podłączysz do własnego
kodu.
Utworzenie klucza API wymaga weryfikacji tożsamości, tej samej kontroli poziomu 2, o którą Xuda prosi przed wydaniem numeru telefonu, skrzynki pocztowej albo przenośnego IP. Konto, na którym nic nie jest zweryfikowane, widzi monit o weryfikację, zanim otworzy się formularz klucza.
Zakres: jako jakie konto działa klucz
Klucz powstaje z jednym z trzech zakresów i zawsze działa na koncie lub aplikacji, dla której został utworzony:
- Konto: działa bezpośrednio na Twoim koncie, tak jak z zalogowanej sesji panelu. Dosięga każdej metody, do której dosięga zwykły klucz konta.
- Aplikacja: tworzony z własnej karty API projektu, przypięty do
app_idtego projektu. - Full Stack VPS: wystawiany automatycznie przy przydzielaniu Full Stack VPS, ograniczony do grup uprawnień wybranych przy tworzeniu. Co to obejmuje, opisuje Full Stack VPS.
Dostęp: pełny albo niestandardowy
Każdy klucz wybiera też, ile z publicznej powierzchni może osiągnąć:
- Pełny dostęp: wszystko, co konto może robić przez API, także metody dodane po utworzeniu klucza.
Metody prywatne pozostają wykluczone bez względu na wszystko:
private: trueto twardy mur, sprawdzany przy każdym wywołaniu, a nie wartość domyślna, którą pełny dostęp nadpisuje. - Dostęp niestandardowy: jawna lista dozwolonych, którą budujesz, zaznaczając metody w formularzu
klucza, pogrupowane według mikroserwisu, z polami każdej metody pokazanymi w wierszu. Metoda dodana
później nie jest uwzględniona, dopóki nie wrócisz i jej nie dopuścisz. Metoda z
clearancepublicjest zawsze dostępna, nawet dla klucza niestandardowego bez niczego zaznaczonego, bo metoda publiczna nie wymaga sesji ani wpisu na liście dozwolonych.
Metody, które tworzą, aktualizują i wyświetlają klucze API (create_account_api_key,
get_app_api_keys i reszta api_module), nigdy nie są dostępne z kluczem API, taki jest zamysł:
poświadczenie nie może tworzyć ani edytować poświadczeń konta, które uwierzytelnia. Zarządzaj kluczami
z panelu albo z zalogowanej sesji.
Wysyłanie klucza
W zwykłym REST klucz to jeszcze jeden parametr żądania o nazwie api_key: pole w treści JSON w
POST, parametr ciągu zapytania w GET. Obie formy opisuje
Wywoływanie metody.
Przez MCP ten sam klucz idzie w nagłówku Authorization: Bearer, nie ma pola api_key. Zobacz
MCP.
Klucz API to poświadczenie na okaziciela: kto go ma, działa jako Twoje konto. Nigdy nie umieszczaj go w kodzie po stronie klienta, nie commituj go i nie wklejaj do udostępnianego zrzutu ekranu. Zamień klucz od razu, jeśli kiedykolwiek pojawi się w którymś z tych miejsc, bo zamiana zachowuje nazwę i tryb dostępu i w tym samym kroku cofa starą wartość.