Saltar al contenido

Consultar el uso de cuentas administradas ​

Consulta las cuentas administradas, los agentes activos y los trabajos de impresión de un mes natural UTC.

GET/partner-api/v1/usageVersión de la API: v1operationId: getPartnerUsageVer como Markdown

Qué hace este método ​

Consulta las cuentas administradas, 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 ​

NombreUbicaciónTipoObligatorioDescripciónRestricciones
periodquerystringnoMes natural UTC en formato YYYY-MM al que corresponde el informe de uso.example: "2026-08"
X-Request-IdheaderstringnoIdentificador 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 ​

NombreTipoObligatorioDescripciónRestricciones
periodstringsíMes natural UTC en formato YYYY-MM al que corresponde el informe de uso.—
starts_atstring (date-time)síMarca de tiempo ISO 8601 registrada por CloudPrint.—
ends_atstring (date-time)síMarca de tiempo ISO 8601 registrada por CloudPrint.—
managed_accountsintegersíNúmero de cuentas de clientes gestionadas incluidas en el periodo de uso.min: 0
active_agentsintegersíNúmero de agentes activos durante el mes natural UTC solicitado.min: 0
print_jobsintegersí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 HTTPDescripción
401Falta la autenticación o no es válida.
403El token no tiene permisos suficientes.
422Uno o varios campos no son válidos.
429Se superó el límite de solicitudes; respeta Retry-After.
500Error interno de CloudPrint.

Documentación relacionada ​

Guías para integrar CloudPrint, conectar el agente local y operar flujos de impresión.