Skip to main content
Bold acepta dos métodos de autenticación para la API: claves API para integraciones de servidor a servidor y credenciales de sesión para usuarios.
Si la petición incluye la cabecera X-Api-Key, Bold usa autenticación por clave API. Si no la incluye, valida la petición como sesión de usuario.

Obtener una clave API

Necesitas ser administrador para crear o desactivar claves API. En la aplicación, esta gestión vive en Panel de control > Acceso > Claves API.
1

Abre Claves API

Entra en Panel de control y abre Claves API dentro del grupo Acceso.
2

Crea una clave

Haz clic en Crear nueva clave API. Escribe un valor en Nombre de la clave, por ejemplo Gestión producción o Análisis inventario.
3

Guarda el secreto

Haz clic en Crear clave y copia el valor que aparece en Clave API creada. La clave completa solo se muestra en ese momento.
4

Confirma la copia

Guarda la clave en el gestor de secretos de la integración y confirma con Ya la he copiado y guardado.

Usar claves API

Usa claves API para integraciones técnicas. La clave identifica la organización y se trata como una credencial secreta. Envía la clave en la cabecera X-Api-Key.
Buenas prácticas:
  • Crea una clave por sistema externo.
  • Usa nombres descriptivos como Gestión producción o Análisis inventario.
  • Rota la clave si sospechas que se compartió fuera del sistema autorizado.
  • Revoca claves que ya no se usen.
No guardes claves API en repositorios, documentos compartidos ni scripts locales sin gestor de secretos.

Credenciales de sesión

Usa credenciales de sesión cuando la llamada representa una sesión interactiva de usuario.
La credencial debe contener el contexto de organización y los permisos necesarios. Si caduca o no pertenece a la organización correcta, la API responde con un error de autenticación o autorización.

Permisos

La autenticación responde a la pregunta “quién llama”. Los permisos responden a la pregunta “qué puede hacer”.

Ejemplo

Prueba primero una ruta de lectura con paginación pequeña. Después añade operaciones de escritura cuando confirmes que la clave pertenece a la organización correcta.

Gestionar claves

La creación, consulta y desactivación de claves se hace desde Panel de control > Acceso > Claves API. Consulta Claves de integración y avisos externos para entender cómo se administran las claves y los avisos externos.