Consultar el uso del Partner Program
Consulta las cuentas gestionadas, los agentes activos y los trabajos de impresión de un mes natural UTC.
Qué hace este método
Consulta las cuentas gestionadas, los agentes activos y los trabajos de impresión de un mes natural UTC.
Autenticación
Envía una aserción RS256 de un solo uso de la Developer Application en Authorization: Bearer <application_assertion>. No es un token de acceso de Public API.
Solicitud
URL de producción: https://public-api.cloudprint.me/partner-api/v1/usage
Parámetros
| Nombre | Ubicación | Tipo | Obligatorio | Descripción | Restricciones |
|---|---|---|---|---|---|
period | query | string | no | Mes natural UTC en formato YYYY-MM al que corresponde el informe de uso. | example: "2026-08" |
X-Request-Id | header | string | no | Identificador opcional para rastrear la solicitud; CloudPrint devuelve un valor seguro en la cabecera de respuesta. | maxLength: 128; example: "order-100045-attempt-1" |
Cuerpo de la solicitud
El método no tiene cuerpo de solicitud.
Ejemplos de solicitud
cURL
bash
curl -sS 'https://public-api.cloudprint.me/partner-api/v1/usage?period=2026-08' \
-H "Authorization: Bearer $APPLICATION_ASSERTION"Respuesta
Estado HTTP: 200 — Solicitud completada.
Campos de respuesta
| Nombre | Tipo | Obligatorio | Descripción | Restricciones |
|---|---|---|---|---|
period | string | sí | Mes natural UTC en formato YYYY-MM al que corresponde el informe de uso. | — |
starts_at | string (date-time) | sí | Marca de tiempo ISO 8601 registrada por CloudPrint. | — |
ends_at | string (date-time) | sí | Marca de tiempo ISO 8601 registrada por CloudPrint. | — |
managed_accounts | integer | sí | Número de cuentas de clientes gestionadas incluidas en el periodo de uso. | min: 0 |
active_agents | integer | sí | Número de agentes activos durante el mes natural UTC solicitado. | min: 0 |
print_jobs | integer | sí | Trabajos de impresión devueltos para la cuenta y los filtros actuales. | min: 0 |
Ejemplo de respuesta
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
}Errores
| Estado HTTP | Descripción |
|---|---|
401 | Falta la autenticación o no es válida. |
403 | El token no tiene permisos suficientes. |
422 | Uno o varios campos no son válidos. |
429 | Se superó el límite de solicitudes; respeta Retry-After. |
500 | Error interno de CloudPrint. |
Documentación relacionada
Crear y administrar cuentas de clientesAprovisiona cuentas administradas y controla su ciclo de vida desde Partner API.Listar cuentas de clientes gestionadasConsulta las cuentas creadas por la aplicación del partner autenticada, incluido el estado de agentes e impresoras.Errores y reintentos de la API de CloudPrintGestiona estados HTTP, errores legibles por máquina, límites de solicitudes, trazabilidad y reintentos seguros.