Saltar al contenido

Obtener el contexto actual del cliente API

Confirma qué cuenta, aplicación cliente y permisos representa el token de acceso actual.

GET/api/v1/meVersión de la API: v1operationId: getApiClientContextVer como Markdown

Qué hace este método

Confirma qué cuenta, aplicación cliente y permisos representa el token de acceso actual.

Autenticación

Envía un token de corta duración en Authorization: Bearer <access_token>.

Se acepta cualquier token de acceso válido de CloudPrint; no se necesitan permisos adicionales.

Solicitud

URL de producción: https://public-api.cloudprint.me/api/v1/me

Parámetros

NombreUbicaciónTipoObligatorioDescripciónRestricciones
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/api/v1/me \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Respuesta

Estado HTTP: 200 — Solicitud completada.

Campos de respuesta

NombreTipoObligatorioDescripciónRestricciones
account_idstring (uuid)UUID estable de la cuenta CloudPrint propietaria del recurso.
account_namestringNombre legible de la cuenta CloudPrint.example: "Acme Print Ops"
client_app_idstring | null (uuid)Identificador estable de las credenciales API representadas por el token actual.
client_app_namestring | nullNombre de las credenciales API usado para diagnosticar la cuenta.
application_idstring | null (uuid)noIdentificador estable de la Developer Application asociada al recurso.
application_namestring | nullnoNombre de la Developer Application que ven los operadores de la cuenta.
authorization_modestringModelo de autorización del token: credenciales de cuenta o App Installation.enum: client_credentials
installation_idstring | null (uuid)UUID estable de la App Installation asociada al recurso.
scopesarrayPermisos concedidos al token de acceso actual.example: ["agents:read","printers:read","documents:write","print_jobs:write","print_jobs:read"]
permissionsarraynoPermisos aprobados para la App Installation.

Ejemplo de respuesta

json
{
  "account_id": "11111111-1111-4111-8111-111111111111",
  "account_name": "Acme Print Ops",
  "authorization_mode": "client_credentials",
  "installation_id": "11111111-1111-4111-8111-111111111111",
  "client_app_id": "11111111-1111-4111-8111-111111111111",
  "client_app_name": "string",
  "scopes": [
    "agents:read",
    "printers:read",
    "documents:write",
    "print_jobs:write",
    "print_jobs:read"
  ]
}

Errores

Estado HTTPDescripción
401Falta la autenticación o no es válida.
429Se superó el límite de solicitudes; respeta Retry-After.
500Error interno de CloudPrint.

Recomendaciones de integración

  • Úsalo durante la incorporación y el diagnóstico para verificar la cuenta y los permisos.
  • No lo llames antes de cada operación: el token ya representa el contexto.

Documentación relacionada

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