Credenciales de API

Una credencial de API permite que un sistema de su organización, como un ERP o un sistema de facturación, cree y envíe sobres sin intervención manual. Cada credencial actúa solo dentro de su organización y con el rol que usted le asigne. Consiste en un ID de cliente y un Secreto de cliente, con los que el sistema obtiene sus tokens de acceso.

Quién: administradores de la organización y administradores de plataforma. Dónde: Configuración, pestaña Credenciales de API.

Crear una credencial

1. Pulse Nueva credencial.

2. Escriba la Etiqueta, que indica qué sistema la usará; por ejemplo, «Sistema de facturación».

3. En Acceso, elija el Espacio de trabajo y el Rol (Lector, Auditor o Gestor). La opción predeterminada es Gestor en General.

4. Pulse Nueva credencial. El diálogo Guarda este secreto ahora muestra el ID de cliente y el Secreto de cliente. Cópielos en el gestor de secretos de su organización antes de cerrarlo.

El secreto se muestra una sola vez

bb-sign no conserva una copia recuperable del secreto. Si lo pierde, rote la credencial para obtener uno nuevo.

Qué puede hacer una credencial

Una credencial actúa con el rol que usted le asignó en cada espacio de trabajo, igual que una persona. Con Gestor en General, crea, envía y cancela sobres y descarga documentos de ese espacio; con Lector, consulta los sobres. Para darle acceso a otros espacios, añádala como miembro desde Espacios y miembros. La fila de cada credencial muestra los espacios en los que actúa.

Las tareas de administración, como crear credenciales, configurar webhooks o gestionar espacios y miembros, quedan siempre a cargo de las personas administradoras. La razón está en la Matriz de permisos.

Su organización puede tener hasta 10 credenciales activas.

Rotar el secreto

Rotar genera un secreto nuevo para el mismo ID de cliente. El secreto anterior deja de funcionar de inmediato, así que coordine la rotación con el equipo que despliega la integración. Confirme con Rotar secreto y guarde el secreto nuevo que muestra el diálogo.

Revocar una credencial

Revocar desactiva la credencial de forma definitiva. Las solicitudes nuevas se rechazan de inmediato, y los tokens que la credencial ya había obtenido dejan de funcionar al vencer, en máximo 300 s. La fila indica la hora exacta.

La credencial revocada permanece en la lista durante 90 días para que pueda consultarla. La creación y la revocación quedan en la auditoría.

Estado	Significado
Activa	Obtiene tokens y actúa en sus espacios.
Revocada — en expiración	Ya no obtiene tokens; los vigentes funcionan hasta la hora indicada.
Revocada	Sin acceso. Sale de la lista al terminar el plazo.

Mensajes de error

Mensaje	Qué ocurrió y qué hacer
«“etiqueta” se creó, pero no se le pudo dar su acceso, así que se revocó. Nada puede usarla.»	El acceso al espacio no se pudo configurar y la credencial se revocó por seguridad. Créela de nuevo en un momento.
«No se pudo crear la credencial.»	Se alcanzó el máximo de credenciales activas o hubo un problema temporal. Revoque una que no use o intente más tarde.

Inicio rápido para desarrolladoresCómo obtener un token con el ID y el secreto, y hacer la primera llamada a la API.

Autenticación de máquinasQué contiene el token, cuánto dura y qué significa cada error.