Skip to main content
GET
Utwórz krótkotrwałe żądanie autoryzacji i przekieruj użytkownika na stronę logowania oraz zgody na uprawnienia VoiceCheap.

Uwierzytelnianie

Brak na tej trasie. Dalszy proces wyrażania zgody w przeglądarce wymaga zalogowania użytkownika, a zatwierdzenie wymaga dostępu do kwalifikującego się płatnego konta.

Parametry zapytania

string
wymagane
client_id zwrócony przez rejestrację dynamiczną lub dokładny publiczny adres HTTPS dokumentu metadanych klienta.Minimalna długość: 1. Maksymalna długość: 2048. Wzorzec: ^[^\u0000-\u001F\u007F]+$.
string
wymagane
Musi być dokładnie zgodny z jednym z redirect_uris zarejestrowanych dla tego klienta.Minimalna długość: 1. Maksymalna długość: 2048. Wzorzec: ^[^\u0000-\u001F\u007F]+$.
field
wymagane
Wartość określona w pełnym schemacie danych wejściowych.Wymagana wartość: “code”.
field
Wartość określona w pełnym schemacie danych wejściowych.Wymagana wartość: “query”. Wartość domyślna: “query”.
string
wymagane
Skrót SHA-256 oryginalnego code_verifier zakodowany jako Base64url, bez dopełnienia.Minimalna długość: 43. Maksymalna długość: 43. Wzorzec: ^[A-Za-z0-9_-]{43}$.
field
wymagane
Wartość określona w pełnym schemacie danych wejściowych.Wymagana wartość: “S256”.
string
wymagane
Wymagana jest dokładna wartość odbiorcy zasobu: użyj wartości resource z metadanych chronionego zasobu tego środowiska. W produkcji jest to https://api.voicecheap.ai/mcp. Inny adres bazowy, ścieżka lub końcowy ukośnik są odrzucane.Format: “uri”.
string
Uprawnienia z scopes_supported rozdzielone spacjami, opcjonalnie z offline_access. Nieobsługiwane nazwy i wartości zawierające wyłącznie białe znaki są odrzucane; duplikaty są usuwane. Pominięcie scope lub brak uprawnień produktu, na przykład samo openid lub samo offline_access, wybiera część wspólną domyślnych zakresów odczytu i zakresów produktu zarejestrowanych dla tego klienta. email wymaga openid; samo email jest odrzucane. Żądane uprawnienia produktu muszą być zarejestrowane dla tego klienta. Uprawnienia tożsamości muszą być jawnie zażądane i zatwierdzone przez użytkownika; pominięcie scope nie żąda uprawnień tożsamości.Minimalna długość: 1. Maksymalna długość: 2048. Wzorzec: ^ *(?:account:read|usage:read|settings:read|settings:write|team:read|team:write|projects:read|projects:write|projects:delete|translations:write|transcription:read|transcription:write|subtitles:read|subtitles:write|tts:read|tts:write|voices:read|voices:write|images:read|images:write|thumbnails:read|thumbnails:write|folders:read|folders:write|glossary:read|glossary:write|webhooks:read|webhooks:write|publishing:read|publishing:write|offline_access|openid|email)(?: +(?:account:read|usage:read|settings:read|settings:write|team:read|team:write|projects:read|projects:write|projects:delete|translations:write|transcription:read|transcription:write|subtitles:read|subtitles:write|tts:read|tts:write|voices:read|voices:write|images:read|images:write|thumbnails:read|thumbnails:write|folders:read|folders:write|glossary:read|glossary:write|webhooks:read|webhooks:write|publishing:read|publishing:write|offline_access|openid|email))* *$.
string
Opcjonalna nieprzezroczysta wartość zwracana bez zmian w końcowym wywołaniu zwrotnym. Użyj nowej, nieprzewidywalnej wartości i zweryfikuj ją po stronie klienta.Minimalna długość: 1. Maksymalna długość: 2048. Wzorzec: ^[^\u0000-\u001F\u007F]+$.
string
Opcjonalna nieprzezroczysta wartość nonce zwracana w tokenie ID po przyznaniu openid. Zweryfikuj ją w kliencie.Minimalna długość: 1. Maksymalna długość: 2048. Wzorzec: ^[^\u0000-\u001F\u007F]+$.
string
Wartość tekstowa.Wymagana wartość: “consent”.

Przykłady żądań

Stosuj udokumentowany sposób kodowania i uwierzytelniania dla tej ścieżki. Struktura odpowiedzi i reguły idempotencji API akcji dotyczą wyłącznie wywołań akcji.

Odpowiedź

Przekierowanie HTTP na stronę zgody VoiceCheap. Brak treści wyniku JSON. Location zawiera nieprzezroczystą wartość request; następnie użytkownik loguje się i wybiera uprawnienia.

Nagłówki odpowiedzi

Uwagi do operacji

  • Rozpoznawane parametry skalarne muszą być podane jednokrotnie jako niepuste ciągi znaków bez znaków sterujących ASCII ani DEL. Powtórzone pola zapytania lub formularza są dekodowane jako tablice i odrzucane przy odczycie jako wartości skalarne.
  • Zakoduj każdą wartość zapytania w formacie URL. redirect_uri musi mieć dokładnie taki zapis, jaki został zarejestrowany dla tego klienta.
  • Używaj wyłącznie S256; plain PKCE i odpowiedzi implicit/token nie są obsługiwane. Zachowaj pierwotny code_verifier o długości 43–128 znaków do wymiany tokenu.
  • Parametr resource jest obowiązkowy i musi być dokładnie równy adresowi URL zasobu MCP wybranego środowiska.
  • Domyślny zestaw zakresów uprawnień produktu to account:read usage:read projects:read transcription:read subtitles:read tts:read voices:read images:read thumbnails:read. Żądanie korzystające z wartości domyślnych jest zawężane do zakresów zarejestrowanych przez klienta; jeśli nie pozostanie żaden zakres uprawnień produktu, autoryzacja kończy się niepowodzeniem.
  • Zakres składający się wyłącznie z offline_access korzysta z domyślnego wyboru zakresów produktu. offline_access jest usuwany przed wyświetleniem lub przyznaniem uprawnień do produktu.
  • Prośby o zgodę wygasają po 10 minutach i można na nie odpowiedzieć raz. Użytkownik może zatwierdzić tylko niepusty podzbiór żądanych uprawnień produktu.
  • Po zatwierdzeniu wywołanie zwrotne klienta otrzymuje code, iss oraz pierwotne state, jeśli zostało podane. Kod autoryzacyjny wygasa po 2 minutach i można go wymienić tylko raz.
  • Po odmowie adres wywołania zwrotnego klienta otrzymuje error=access_denied, error_description, iss oraz oryginalne state, jeśli zostało podane; kod nie jest wydawany.
  • Nieprawidłowe metadane klienta, niezgodności przekierowań, PKCE, zakresów lub resource powodują bezpośrednie błędy JSON OAuth; nie są przekierowywane do niezweryfikowanego adresu wywołania zwrotnego.
  • Publiczny limit autoryzacji wynosi 30 żądań na minutę na adres IP klienta i jest współdzielony przez procesy robocze.
  • openid i email to uprawnienia tożsamości, niezależne od uprawnień produktu, akceptowane tylko wtedy, gdy są ogłaszane. email wymaga openid. Podczas pierwszej autoryzacji żądanie zawierające wyłącznie zakresy tożsamości używa domyślnych uprawnień produktu pokazanych na ekranie zgody.
  • client_id zwrócony przez rejestrację dynamiczną lub dokładny publiczny adres HTTPS dokumentu metadanych klienta.
  • OpenID Connect obsługuje prompt=consent. Inne wartości prompt i max_age są odrzucane; cicha autoryzacja i wymuszone ponowne logowanie nie są obsługiwane.

Błędy