Consultar API key
Consulta la API key con la que haces la solicitud, su organización y su límite de uso.
Descripción general
Este endpoint devuelve la API key con la que se hace la solicitud: su nombre, sus permisos, la organización a la que pertenece y el estado de su límite de uso. Úsalo para verificar que tu API key funciona antes de integrar el resto de los endpoints.
Acepta cualquier API key válida, sin importar sus permisos. No lleva cuerpo y consume una solicitud del límite de uso, igual que cualquier otro endpoint.
Endpoint
https://app.credonix.mx/api/v1/meConsulta tu API key
Envía tu API key en el header Authorization, por ejemplo Bearer cdx_Ab12.... La respuesta confirma a qué organización pertenece y cuántas solicitudes le quedan en la ventana actual.
Campos de la respuesta
| Campo | Tipo | Descripción |
|---|---|---|
api_key.id | string | Identificador de la API key. |
api_key.name | string | Nombre de la API key. Llega como "" si la API key no tiene nombre. |
api_key.full_access | boolean | true si la API key tiene Acceso total. Con acceso total, la API key tiene acceso a todos los recursos, sin importar el contenido de permissions. |
api_key.permissions | objeto | Permisos seleccionados, por recurso. Ver abajo. |
organization.id | string | Identificador de la organización. |
organization.name | string | Nombre de la organización. |
organization.slug | string | null | Clave corta de la organización. |
rate_limit.limit | integer | Solicitudes permitidas por ventana. |
rate_limit.remaining | integer | Solicitudes restantes en la ventana actual. Ya descuenta esta solicitud. |
rate_limit.window_seconds | integer | Duración de la ventana, en segundos. |
permissions
Cada llave es un recurso con permiso (customers, invoices, automations, payments, products, message_groups) y su valor es la lista de niveles incluidos hasta el nivel otorgado. Los recursos sin permiso no aparecen.
{
"customers": ["read", "create"],
"payments": ["read"]
}| Nivel | En la aplicación |
|---|---|
read | Leer |
create | Crear |
admin | Administrar |
Errores
| Status | Código | Causa |
|---|---|---|
401 | MISSING_API_KEY, INVALID_API_KEY, API_KEY_REVOKED | API key ausente, inválida o revocada. |
404 | NOT_FOUND | La organización de la API key ya no existe. La respuesta incluye "La organización de esta API key ya no existe.". |
429 | RATE_LIMITED | La API key superó su límite de uso. |