Dokumentacja CloudPrint/Dokumentacja API

Pobierz listę Agent Enrollment

Pobierz Agent Enrollment o statusach `pending`, `claimed`, `expired` i `revoked` bez poufnych kodów.

GET/partner-api/v1/accounts/{relationshipId}/agent-enrollmentsWersja API: v1operationId: listPartnerAgentEnrollmentsOtwórz w Markdown

Działanie metody

Pobierz Agent Enrollment o statusach pending, claimed, expired i revoked bez poufnych kodów.

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/partner-api/v1/accounts/{relationshipId}/agent-enrollments

Parametry

Nazwa	Położenie	Typ	Wymagane	Opis	Ograniczenia
relationshipId	path	string (uuid)	tak	Stabilny UUID relacji partnera z zarządzanym klientem.	—
limit	query	integer	nie	Maksymalna liczba zasobów zwracanych na jednej stronie.	min: 1; max: 100; default: 50
cursor	query	string	nie	Nieprzezroczysty kursor strony wyników; przekazuj go bez zmian.	—
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

Metoda nie ma treści żądania.

Przykładowe żądania

cURL

curl -sS "https://public-api.cloudprint.me/partner-api/v1/accounts/$RELATIONSHIP_ID/agent-enrollments" \
  -H "Authorization: Bearer $APPLICATION_ASSERTION"

Odpowiedź

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

Pola odpowiedzi

Nazwa	Typ	Wymagane	Opis	Ograniczenia
data	array	tak	Zasoby zwrócone na bieżącej stronie wyników.	—
next_cursor	string | null	tak	Nieprzezroczysty kursor następnej strony; przekaż go bez zmian.	—

Przykładowa odpowiedź

{
  "data": [
    {
      "agent_enrollment_id": "11111111-1111-4111-8111-111111111111",
      "name": "string",
      "status": "pending",
      "expires_at": "2026-08-06T12:00:00Z",
      "created_at": "2026-08-06T12:00:00Z",
      "agent_id": "11111111-1111-4111-8111-111111111111",
      "claimed_at": "2026-08-06T12:00:00Z",
      "revoked_at": "2026-08-06T12:00:00Z"
    }
  ],
  "next_cursor": "string"
}

Błędy

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

Powiązana dokumentacja

Utwórz Agent EnrollmentUtwórz jednorazowe podłączenie agenta, które można bezpiecznie ponowić przed pierwszym podłączeniem klienta lub po nim.Pobierz Agent EnrollmentSprawdź konkretne jednorazowe podłączenie klienta i pobierz identyfikator podłączonego agenta.Konfiguracja agenta dla konta zarządzanegoUtwórz jednorazowy link i połącz CloudPrint Agent z właściwym kontem klienta bez logowania do panelu.

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