Dokumentacja CloudPrint/Dokumentacja API

Pobierz jedno Agent Enrollment

Sprawdź konkretną jednorazową rejestrację zarządzanego klienta i powiąż ją z podłączonym Agentem.

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

Działanie metody

Sprawdź konkretną jednorazową rejestrację zarządzanego klienta i powiąż ją z podłączonym Agentem.

Uwierzytelnianie

Przekaż jednorazowy assertion RS256 Developer Application 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	Pole kontraktu API; uwzględnij podany typ i ograniczenia.	—
enrollmentId	path	string (uuid)	tak	Pole kontraktu API; uwzględnij podany typ i ograniczenia.	—

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 tego zasobu.	—
name	string	tak	Pole kontraktu API; uwzględnij podany typ i ograniczenia.	—
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": null,
  "claimed_at": null,
  "revoked_at": null
}

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 enrollment_id podczas tworzenia linku i sprawdzaj dokładnie ten zasób; nie wnioskuj o zakończeniu na podstawie innego Agenta wcześniej podłączonego do konta.
• Status ready oznacza udane podłączenie — zapisz zwrócony agent_id. Zakończ sprawdzanie po expired, cancelled lub failed.

Powiązana dokumentacja

Utwórz Agent EnrollmentWydaj idempotentny jednorazowy Enrollment przed lub po onboardingu klienta.Odwołaj Agent EnrollmentOdwołaj niewykorzystany Enrollment, aby jego secret nie mógł już połączyć Agent.Rejestracja agenta klientaPołącz lokalnego agenta CloudPrint z właściwym zarządzanym kontem bez logowania klienta do panelu CloudPrint.

OpenAPIOtwórz panelPolityka prywatnościRegulaminPłatności i zwrotyDPA