Skip to main content

​
Claves de API

  • Las claves pertenecen a tu organización, no a una persona. Siguen funcionando si el compañero que las creó deja el equipo.
  • El secreto empieza con oak_ y se muestra una sola vez al crearlo. Ciarem guarda únicamente un hash: nadie, ni siquiera Ciarem, puede recuperar un secreto perdido.
  • Envíalo como token bearer en cada solicitud:

​
Requisito de plan

La API es parte del plan Scale, y está abierta durante la prueba gratuita para que puedas construir y probar tu integración antes de pagar. Una clave en prueba obtiene toda la API con un presupuesto menor — consulta los límites de uso. GET /v1/me te dice en cuál estás: "trial": true mientras dura la prueba. Cuando una clave es rechazada con 403, el detail dice qué lo resuelve:

​
Revocación

Revoca una clave en cualquier momento en Configuración → Claves de API. La revocación es inmediata: la siguiente solicitud con ese secreto falla con 401. Los administradores pueden crear tantas claves como necesiten — una por integración es un buen hábito, y la fecha de último uso de cada clave te ayuda a detectar las que puedes retirar.

​
Buenas prácticas

  • Guarda los secretos en tu gestor de secretos o variables de entorno — nunca en el código ni en aplicaciones del lado del cliente.
  • La API es de servidor a servidor: no la llames desde un navegador o una app móvil donde la clave quedaría expuesta.
  • Rota creando una clave nueva, migrando tu integración y revocando después la antigua.