Zum Inhalt springen

Nutzung verwalteter Konten abrufen ​

Rufen Sie verwaltete Konten, aktive Agents und Druckaufträge für einen UTC-Kalendermonat ab.

GET/partner-api/v1/usageAPI-Version: v1operationId: getPartnerUsageAls Markdown anzeigen

Funktion dieser Methode ​

Rufen Sie verwaltete Konten, aktive Agents und Druckaufträge für einen UTC-Kalendermonat ab.

Authentifizierung ​

Senden Sie eine einmalige RS256-Assertion der Developer Application in Authorization: Bearer <application_assertion>. Sie ist kein Public-API-Zugriffstoken.

Anfrage ​

Produktions-URL: https://public-api.cloudprint.me/partner-api/v1/usage

Parameter ​

NamePositionTypErforderlichBeschreibungEinschränkungen
periodquerystringneinUTC-Kalendermonat im Format YYYY-MM für den Nutzungsbericht.example: "2026-08"
X-Request-IdheaderstringneinOptionale Kennung zur Anfrageverfolgung; CloudPrint gibt einen sicheren Wert im Antwort-Header zurück.maxLength: 128; example: "order-100045-attempt-1"

Anfrageinhalt ​

Die Methode hat keinen Anfrageinhalt.

Anfragebeispiele ​

cURL ​

bash
curl -sS 'https://public-api.cloudprint.me/partner-api/v1/usage?period=2026-08' \
  -H "Authorization: Bearer $APPLICATION_ASSERTION"

Antwort ​

HTTP-Status: 200 — Anfrage erfolgreich.

Antwortfelder ​

NameTypErforderlichBeschreibungEinschränkungen
periodstringjaUTC-Kalendermonat im Format YYYY-MM für den Nutzungsbericht.—
starts_atstring (date-time)jaVon CloudPrint erfasster ISO-8601-Zeitstempel.—
ends_atstring (date-time)jaVon CloudPrint erfasster ISO-8601-Zeitstempel.—
managed_accountsintegerjaAnzahl der verwalteten Kundenkonten im Nutzungszeitraum.min: 0
active_agentsintegerjaAnzahl der aktiven Agents im angefragten UTC-Kalendermonat.min: 0
print_jobsintegerjaDruckaufträge für das aktuelle Konto und die gewählten Filter.min: 0

Beispielantwort ​

json
{
  "period": "2026-08",
  "starts_at": "2026-08-06T12:00:00Z",
  "ends_at": "2026-08-06T12:00:00Z",
  "managed_accounts": 0,
  "active_agents": 0,
  "print_jobs": 0
}

Fehler ​

HTTP-StatusBeschreibung
401Authentifizierung fehlt oder ist ungültig.
403Das Token hat nicht die erforderlichen Berechtigungen.
422Mindestens ein Feld ist ungültig.
429Anfragelimit überschritten; beachten Sie Retry-After.
500Interner CloudPrint-Fehler.

Verwandte Dokumentation ​

Anleitungen zur CloudPrint-Integration, zur Verbindung des lokalen Agenten und zum zuverlässigen Betrieb von Druckabläufen.