Przejdź do treści

Pobierz listę agentów druku

Pobierz agentów CloudPrint konta oraz sprawdź ich status, wersję i stan aktualizacji.

GET/api/v1/agentsWersja API: v1operationId: listAgentsOtwórz w Markdown

Działanie metody

Pobierz agentów CloudPrint konta oraz sprawdź ich status, wersję i stan aktualizacji.

Uwierzytelnianie

Przekaż krótkotrwały token w Authorization: Bearer <access_token>.

Wymagane uprawnienia: agents:read

Żądanie

Podstawowy adres API: https://public-api.cloudprint.me/api/v1/agents

Parametry

NazwaPołożenieTypWymaganeOpisOgraniczenia
limitqueryintegerniePole kontraktu API; uwzględnij podany typ i ograniczenia.min: 1; max: 100; default: 50
cursorquerystring | nullniePole kontraktu API; uwzględnij podany typ i ograniczenia.

Treść żądania

Metoda nie ma treści żądania.

Przykładowe żądania

cURL

bash
curl -sS 'https://public-api.cloudprint.me/api/v1/agents?limit=50' \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Odpowiedź

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

Pola odpowiedzi

NazwaTypWymaganeOpisOgraniczenia
agentsarraytakAgenci zarejestrowani na bieżącym koncie CloudPrint.
next_cursorstring | nulltakNieprzezroczysty kursor następnej strony; przekaż go bez zmian.

Przykładowa odpowiedź

json
{
  "agents": [
    {
      "agent_id": "11111111-1111-4111-8111-111111111111",
      "name": "Warehouse PC agent",
      "status": "online",
      "agent_instance_id": null,
      "hostname": null,
      "version": null,
      "update": {
        "status": "available",
        "current_version": "0.1.0",
        "latest_version": "0.1.1",
        "minimum_supported_version": "0.1.0",
        "channel": "stable",
        "required": false
      },
      "last_seen_at": null
    }
  ],
  "next_cursor": null
}

Błędy

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

Wskazówki integracyjne

  • Status agenta jest informacją operacyjną, a nie kluczem routingu drukarki.
  • Sprawdź stan aktualizacji agenta przed diagnozowaniem drukarki lub dokumentu.

Powiązana dokumentacja

Przewodniki dotyczące integracji CloudPrint, podłączania lokalnego agenta i obsługi procesów drukowania.