Przejdź do treści

Pobierz kontekst klienta API ​

Sprawdź, do którego konta i aplikacji API należy bieżący token oraz jakie ma uprawnienia.

GET/api/v1/meWersja API: v1operationId: getApiClientContextOtwórz w Markdown

Działanie metody ​

Sprawdź, do którego konta i aplikacji API należy bieżący token oraz jakie ma uprawnienia.

Uwierzytelnianie ​

Przekaż krótkotrwały token w Authorization: Bearer <access_token>.

Wystarczy dowolny ważny token dostępu CloudPrint; dodatkowe uprawnienia nie są wymagane.

Żądanie ​

Podstawowy adres API: https://public-api.cloudprint.me/api/v1/me

Parametry ​

NazwaPołożenieTypWymaganeOpisOgraniczenia
X-Request-IdheaderstringnieOpcjonalny identyfikator do śledzenia żądania; CloudPrint zwróci bezpieczną wartość w nagłówku odpowiedzi.maxLength: 128; example: "order-100045-attempt-1"

Treść żądania ​

Metoda nie ma treści żądania.

Przykładowe żądania ​

cURL ​

bash
curl -sS https://public-api.cloudprint.me/api/v1/me \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Odpowiedź ​

Status HTTP: 200 — Żądanie zostało wykonane.

Pola odpowiedzi ​

NazwaTypWymaganeOpisOgraniczenia
account_idstring (uuid)takStabilny UUID konta CloudPrint, do którego należy zasób.—
account_namestringtakCzytelna nazwa konta CloudPrint.example: "Acme Print Ops"
client_app_idstring | null (uuid)takStabilny identyfikator danych API reprezentowanych przez bieżący token.—
client_app_namestring | nulltakNazwa danych API używana w diagnostyce konta.—
application_idstring | null (uuid)nieStabilny identyfikator Developer Application reprezentowanej przez token instalacji.—
application_namestring | nullnieNazwa Developer Application widoczna dla operatorów konta.—
authorization_modestringtakModel autoryzacji tokenu: dane konta albo instalacja aplikacji.enum: client_credentials
installation_idstring | null (uuid)takStabilny UUID App Installation, która autoryzowała token.—
scopesarraytakUprawnienia przyznane bieżącemu tokenowi dostępu.example: ["agents:read","printers:read","documents:write","print_jobs:write","print_jobs:read"]
permissionsarraynieUprawnienia instalacji zawarte w tym tokenie.—

Przykładowa odpowiedź ​

json
{
  "account_id": "11111111-1111-4111-8111-111111111111",
  "account_name": "Acme Print Ops",
  "authorization_mode": "client_credentials",
  "installation_id": "11111111-1111-4111-8111-111111111111",
  "client_app_id": "11111111-1111-4111-8111-111111111111",
  "client_app_name": "string",
  "scopes": [
    "agents:read",
    "printers:read",
    "documents:write",
    "print_jobs:write",
    "print_jobs:read"
  ]
}

Błędy ​

Status HTTPOpis
401Brak uwierzytelnienia albo jest ono nieprawidłowe.
429Przekroczono limit żądań; zastosuj Retry-After.
500Wewnętrzny błąd CloudPrint.

Wskazówki integracyjne ​

  • Używaj tego sprawdzenia podczas konfiguracji i diagnostyki konta oraz przyznanych uprawnień.
  • Nie wywołuj metody przed każdym żądaniem biznesowym; token już reprezentuje kontekst klienta.

Powiązana dokumentacja ​

Przewodniki dotyczące integracji CloudPrint, podłączania lokalnego agenta i obsługi procesów drukowania.