Dokumentacja CloudPrint/Dokumentacja API

Wydaj token instalacji aplikacji

Potwierdź Developer Application jednorazowym JWT podpisanym algorytmem RS256 i pobierz krótkotrwały token dla jednej App Installation.

POST/developer-api/v1/app-installations/{installationId}/access-tokensWersja API: v1operationId: issueInstallationAccessTokenOtwórz w Markdown

Działanie metody

Potwierdź Developer Application jednorazowym JWT podpisanym algorytmem RS256 i pobierz krótkotrwały token dla jednej App Installation.

Uwierzytelnianie

Przekaż jednorazowe potwierdzenie JWT Developer Application podpisane algorytmem RS256 w Authorization: Bearer <application_assertion>. Nie jest to token dostępu do Public API.

Żądanie

Podstawowy adres API: https://public-api.cloudprint.me/developer-api/v1/app-installations/{installationId}/access-tokens

Parametry

Nazwa	Położenie	Typ	Wymagane	Opis	Ograniczenia
installationId	path	string (uuid)	tak	Stabilny UUID App Installation przechowywany w mapowaniu integratora.	—
X-Request-Id	header	string	nie	Opcjonalny identyfikator do śledzenia żądania; CloudPrint zwróci bezpieczną wartość w nagłówku odpowiedzi.	maxLength: 128; example: "order-100045-attempt-1"

Treść żądania

Typ zawartości: application/json

Nazwa	Typ	Wymagane	Opis	Ograniczenia
permissions	array	nie	Uprawnienia instalacji zawarte w tym tokenie.	—

Przykładowe żądania

cURL

curl -sS https://public-api.cloudprint.me/developer-api/v1/app-installations/$INSTALLATION_ID/access-tokens \
  -H "Authorization: Bearer $APPLICATION_ASSERTION" \
  -H 'Content-Type: application/json' \
  -d '{"permissions":["documents:write","print_jobs:write"]}'

Odpowiedź

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

Pola odpowiedzi

Nazwa	Typ	Wymagane	Opis	Ograniczenia
access_token	string	tak	Krótkotrwały token OAuth2 Bearer używany w żądaniach Public API.	example: "eyJ..."
token_type	string	tak	Typ tokenu OAuth2; Public API używa Bearer.	enum: Bearer
expires_in	integer	tak	Czas ważności tokenu dostępu w sekundach od wydania.	min: 1; example: 3600
installation_id	string (uuid)	tak	Stabilny UUID App Installation, która autoryzowała token.	—
account_id	string (uuid)	tak	Stabilny UUID konta CloudPrint, do którego należy zasób.	—
permissions	array	tak	Uprawnienia instalacji zawarte w tym tokenie.	—

Przykładowa odpowiedź

{
  "access_token": "eyJ...",
  "token_type": "Bearer",
  "expires_in": 3600,
  "installation_id": "11111111-1111-4111-8111-111111111111",
  "account_id": "11111111-1111-4111-8111-111111111111",
  "permissions": [
    "agents:read"
  ]
}

Błędy

Status HTTP	Opis
401	Brak uwierzytelnienia albo jest ono nieprawidłowe.
403	Brak uprawnień wymaganych do tej operacji.
422	Pola żądania nie przeszły walidacji.
429	Przekroczono limit żądań; zastosuj Retry-After.
500	Wewnętrzny błąd CloudPrint.

Wskazówki integracyjne

• Dla każdego żądania utwórz nowe jednorazowe potwierdzenie JWT: RS256, kid aktywnego klucza, client_id aplikacji w iss i sub, dokładny URL metody w aud, ważność do pięciu minut oraz unikalny jti.
• Powiąż stały installation_id z identyfikatorem klienta we własnym systemie. Metoda przyjmuje wyłącznie installation_id, a nie zewnętrzny identyfikator klienta.
• Refresh token nie jest wydawany. Przechowuj token instalacji niemal do końca expires_in, a potem wydaj nowy bez ponownej instalacji aplikacji przez użytkownika.

Powiązana dokumentacja

Instalacje i tokeny dostępuInstaluj aplikację na kontach klientów, zapisuj installation_id i wydawaj krótkotrwałe Installation Access Tokens.Pobierz kontekst klienta APISprawdź, do którego konta i aplikacji API należy bieżący token oraz jakie ma uprawnienia.Błędy i ponowienia CloudPrint APIObsługuj statusy HTTP, błędy maszynowe, limity, identyfikatory żądań i bezpieczne ponowienia.

Status usługiOpenAPIDeveloper PortalOtwórz panelPolityka prywatnościRegulaminDPAService Level Agreement