Zmień stan zarządzanego klienta
Wstrzymaj, wznów lub trwale zamknij relację z klientem należącą do aplikacji partnerskiej.
POST
/partner-api/v1/accounts/{relationshipId}/{action}Wersja API: v1operationId: changePartnerManagedAccountStateOtwórz w MarkdownDziałanie metody
Wstrzymaj, wznów lub trwale zamknij relację z klientem należącą do aplikacji partnerskiej.
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}/{action}
Parametry
| Nazwa | Położenie | Typ | Wymagane | Opis | Ograniczenia |
|---|---|---|---|---|---|
relationshipId | path | string (uuid) | tak | Pole kontraktu API; uwzględnij podany typ i ograniczenia. | — |
action | path | string | tak | Pole kontraktu API; uwzględnij podany typ i ograniczenia. | enum: suspend, resume, close |
Treść żądania
Metoda nie ma treści żądania.
Przykładowe żądania
cURL
bash
curl -sS -X POST "https://public-api.cloudprint.me/partner-api/v1/accounts/$RELATIONSHIP_ID/suspend" \
-H "Authorization: Bearer $APPLICATION_ASSERTION"Odpowiedź
Status HTTP: 200 — Żądanie zostało wykonane.
Pola odpowiedzi
| Nazwa | Typ | Wymagane | Opis | Ograniczenia |
|---|---|---|---|---|
relationship_id | string (uuid) | tak | Stabilny identyfikator tego zasobu. | — |
developer_account_id | string (uuid) | tak | Stabilny identyfikator tego zasobu. | — |
cloudprint_account_id | string (uuid) | tak | Stabilny identyfikator tego zasobu. | — |
external_customer_id | string | tak | Stabilny identyfikator tego zasobu. | maxLength: 160 |
name | string | tak | Pole kontraktu API; uwzględnij podany typ i ograniczenia. | maxLength: 120 |
application_id | string (uuid) | tak | Stabilny identyfikator Developer Application reprezentowanej przez token instalacji. | — |
installation_id | string | null (uuid) | tak | Stabilny UUID App Installation, która autoryzowała token. | — |
agent_enrollment_id | string | null (uuid) | tak | Stabilny identyfikator tego zasobu. | — |
agent_onboarding_expires_at | string | null (date-time) | tak | Znacznik czasu CloudPrint w formacie ISO 8601. | — |
agent_onboarding_url | string | null (uri) | tak | Pole kontraktu API; uwzględnij podany typ i ograniczenia. | example: "https://connect.cloudprint.me/setup#token=cpat_example" |
onboarding_status | string | tak | Pole kontraktu API; uwzględnij podany typ i ograniczenia. | enum: provisioning, waiting_for_agent, ready, failed |
status | string | tak | Bieżący stan zasobu lub procesu; użyj wartości dozwolonych dla danej metody. | enum: provisioning, active, suspended, closed |
created_at | string (date-time) | tak | Znacznik czasu CloudPrint w formacie ISO 8601. | — |
updated_at | string (date-time) | tak | Znacznik czasu CloudPrint w formacie ISO 8601. | — |
Przykładowa odpowiedź
json
{
"relationship_id": "11111111-1111-4111-8111-111111111111",
"developer_account_id": "11111111-1111-4111-8111-111111111111",
"cloudprint_account_id": "11111111-1111-4111-8111-111111111111",
"external_customer_id": "string",
"name": "string",
"application_id": "11111111-1111-4111-8111-111111111111",
"installation_id": null,
"agent_enrollment_id": null,
"agent_onboarding_expires_at": null,
"agent_onboarding_url": "https://connect.cloudprint.me/setup#token=cpat_example",
"onboarding_status": "provisioning",
"status": "provisioning",
"created_at": "2026-08-06T12:00:00Z",
"updated_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
Powiązana dokumentacja
Pobierz zarządzane konta klientówPobierz konta klientów utworzone przez aplikację partnerską wraz ze stanem agentów i drukarek.Utwórz zarządzane konto klientaUtwórz odizolowane konto CloudPrint, App Installation i jednorazową rejestrację agenta bez rejestracji klienta.Błędy i ponowienia CloudPrint APIObsługuj statusy HTTP, błędy maszynowe, limity, identyfikatory żądań i bezpieczne ponowienia.