Dokumentacja CloudPrint/Dokumentacja API

Pobierz Agents klienta

Pobierz wszystkie Agents zarządzanego klienta, w tym odwołane.

GET/partner-api/v1/accounts/{relationshipId}/agentsWersja API: v1operationId: listPartnerManagedAgentsOtwórz w Markdown

Działanie metody

Pobierz wszystkie Agents zarządzanego klienta, w tym odwołane.

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}/agents

Parametry

Nazwa	Położenie	Typ	Wymagane	Opis	Ograniczenia
relationshipId	path	string (uuid)	tak	Pole kontraktu API; uwzględnij podany typ i ograniczenia.	—
limit	query	integer	nie	Pole kontraktu API; uwzględnij podany typ i ograniczenia.	min: 1; max: 100; default: 50
cursor	query	string	nie	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/agents" \
  -H "Authorization: Bearer $APPLICATION_ASSERTION"

Odpowiedź

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

Pola odpowiedzi

Nazwa	Typ	Wymagane	Opis	Ograniczenia
data	array	tak	Pole kontraktu API; uwzględnij podany typ i ograniczenia.	—
next_cursor	string | null	tak	Nieprzezroczysty kursor następnej strony; przekaż go bez zmian.	—

Przykładowa odpowiedź

{
  "data": [
    {
      "agent_id": "11111111-1111-4111-8111-111111111111",
      "name": "string",
      "status": "online",
      "agent_instance_id": null,
      "hostname": null,
      "version": null,
      "last_seen_at": null,
      "created_at": null,
      "revoked_at": null
    }
  ],
  "next_cursor": 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

Powiązana dokumentacja

Odwołaj Agent klientaOdwołaj utracony lub wymieniony Agent i przełącz jego drukarki offline.Pobierz zarządzane konto klientaPobierz jednego zarządzanego klienta według stabilnego relationship ID.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