Dokumentacja CloudPrint/Dokumentacja API

Pobierz Agent Enrollment

Sprawdź konkretne jednorazowe podłączenie klienta i pobierz identyfikator podłączonego agenta.

GET/partner-api/v1/accounts/{relationshipId}/agent-enrollments/{enrollmentId}Wersja API: v1operationId: getPartnerAgentEnrollmentOtwórz w Markdown

Działanie metody

Sprawdź konkretne jednorazowe podłączenie klienta i pobierz identyfikator podłączonego agenta.

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/{enrollmentId}

Parametry

Nazwa	Położenie	Typ	Wymagane	Opis	Ograniczenia
relationshipId	path	string (uuid)	tak	Stabilny UUID relacji partnera z zarządzanym klientem.	—
enrollmentId	path	string (uuid)	tak	Stabilny UUID Agent Enrollment wskazanego w ścieżce.	—
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/$ENROLLMENT_ID" \
  -H "Authorization: Bearer $APPLICATION_ASSERTION"

Odpowiedź

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

Pola odpowiedzi

Nazwa	Typ	Wymagane	Opis	Ograniczenia
agent_enrollment_id	string (uuid)	tak	Stabilny identyfikator Agent Enrollment.	—
name	string	tak	Czytelna nazwa zasobu widoczna dla operatorów konta.	—
status	string	tak	Bieżący stan zasobu lub procesu; użyj wartości dozwolonych dla danej metody.	enum: pending, claimed, expired, revoked
expires_at	string (date-time)	tak	Znacznik czasu CloudPrint w formacie ISO 8601.	—
created_at	string (date-time)	tak	Znacznik czasu CloudPrint w formacie ISO 8601.	—
agent_id	string | null (uuid)	tak	Stabilny UUID połączonego agenta CloudPrint.	—
claimed_at	string | null (date-time)	tak	Znacznik czasu CloudPrint w formacie ISO 8601.	—
revoked_at	string | null (date-time)	tak	Znacznik czasu CloudPrint w formacie ISO 8601.	—

Przykładowa odpowiedź

{
  "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"
}

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.

Wskazówki integracyjne

• Zapisz agent_enrollment_id podczas tworzenia linku i sprawdzaj dokładnie ten zasób. Nie wnioskuj o zakończeniu na podstawie innego agenta, który został wcześniej podłączony do konta.
• Kontynuuj przy statusie pending. Gdy zmieni się na claimed, zapisz zwrócony agent_id; zakończ przy expired lub revoked.

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.Odwołaj Agent EnrollmentOdwołaj niewykorzystany Enrollment, aby jego poufnego kodu nie można było użyć do podłączenia 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