Saltar al contenido principal

Documentation Index

Fetch the complete documentation index at: https://docs.clearpolicy.app/llms.txt

Use this file to discover all available pages before exploring further.

La API de ClearPolicy usa tokens portadores para la autenticación. Cada solicitud debe incluir un token de API válido en el encabezado Authorization. Los tokens están vinculados a la organización donde se crearon, por lo que el token que uses determina qué datos de organización se devuelven.

Crear un token de API

Los propietarios y administradores de la organización pueden crear tokens de API en ClearPolicy.
1

Abre la configuración de la API

En el panel de ClearPolicy, ve a Configuración -> API.
2

Crea un token

Haz clic en Crear token de API. Dale al token un nombre claro, como Automatización de informes, para que tu equipo sepa dónde se usa.
3

Copia el token portador

Copia el token cuando ClearPolicy lo muestre. No podrás volver a ver el token completo después de cerrar el cuadro de diálogo.
4

Guárdalo de forma segura

Guarda el token en tu gestor de contraseñas, gestor de secretos o configuración de la integración. No lo compartas por correo electrónico, chat ni código público.

Pasar el token en las solicitudes

Incluye el token en el encabezado Authorization de cada solicitud a la API:
Authorization: Bearer YOUR_ACCESS_TOKEN
Ejemplo de solicitud usando el token:
curl https://api.clearpolicy.app/api/v1/me \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Respuestas de error

EstadoSignificado
401 UnauthorizedEl token falta, ha caducado o no es válido.
403 ForbiddenEl token es válido pero no tiene permiso para el recurso solicitado.
Los tokens están vinculados a una organización. Todas las respuestas de la API reflejan la organización donde se creó el token.
El acceso a la API también sigue el rol del miembro del equipo en ClearPolicy. Los propietarios y administradores pueden crear y gestionar tokens de API. Los tokens vinculados a un gestor de grupo pueden confirmar el token con GET /me, pero los endpoints de personas, documentos y solicitudes de acuse de recibo devuelven 403 Forbidden.

Revocar un token

Ve a Configuración -> API para revisar los tokens de API activos. Puedes ver quién creó cada token, cuándo se creó, cuándo se usó por última vez y cuándo caduca. Haz clic en Revocar para quitar el acceso a un token que ya no necesitas.
Last modified on May 27, 2026