Nutzung im Partner Program abrufen
Rufen Sie verwaltete Konten, aktive Agents und Druckaufträge für einen UTC-Kalendermonat ab.
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
| Name | Position | Typ | Erforderlich | Beschreibung | Einschränkungen |
|---|---|---|---|---|---|
period | query | string | nein | UTC-Kalendermonat im Format YYYY-MM für den Nutzungsbericht. | example: "2026-08" |
X-Request-Id | header | string | nein | Optionale 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
| Name | Typ | Erforderlich | Beschreibung | Einschränkungen |
|---|---|---|---|---|
period | string | ja | UTC-Kalendermonat im Format YYYY-MM für den Nutzungsbericht. | — |
starts_at | string (date-time) | ja | Von CloudPrint erfasster ISO-8601-Zeitstempel. | — |
ends_at | string (date-time) | ja | Von CloudPrint erfasster ISO-8601-Zeitstempel. | — |
managed_accounts | integer | ja | Anzahl der verwalteten Kundenkonten im Nutzungszeitraum. | min: 0 |
active_agents | integer | ja | Anzahl der aktiven Agents im angefragten UTC-Kalendermonat. | min: 0 |
print_jobs | integer | ja | Druckaufträ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-Status | Beschreibung |
|---|---|
401 | Authentifizierung fehlt oder ist ungültig. |
403 | Das Token hat nicht die erforderlichen Berechtigungen. |
422 | Mindestens ein Feld ist ungültig. |
429 | Anfragelimit überschritten; beachten Sie Retry-After. |
500 | Interner CloudPrint-Fehler. |
Verwandte Dokumentation
Kundenkonten erstellen und verwaltenStellen Sie verwaltete Konten bereit und steuern Sie deren Lebenszyklus über die Partner API.Verwaltete Kundenkonten auflistenRufen Sie die von der authentifizierten Partneranwendung bereitgestellten Kundenkonten einschließlich Agent- und Druckerstatus ab.Fehler und Wiederholungen der CloudPrint APIBehandeln Sie HTTP-Statuscodes, maschinenlesbare Fehler, Anfragelimits, Anfrageverfolgung und sichere Wiederholungslogik.