📖 Tabla de contenidos
¿Qué es una clave API?
Una clave API permite a tu aplicación autenticarse con la API de Yousign.
Identifica tu organización y habilita intercambios seguros de datos, documentos y servicios a través de solicitudes API.
Cada clave API está definida por:
Un entorno (Sandbox o producción)
Un ámbito, que determina a qué recursos puede acceder la clave
Un nivel de permiso (acceso completo o solo lectura)
Cómo crear una clave API
Ve a la sección Desarrolladores en el menú de la izquierda.
Haz clic en Claves API.
Si es tu primera clave API, haz clic en Iniciar integración (entorno Sandbox).
De lo contrario, haz clic en Nueva clave API en la parte superior de la página.
Cuando creas tu primera clave API, tu período de prueba de la API comienza automáticamente.
Deberás añadir la siguiente información:
1. Descripción
Introduce un nombre para la clave API.
Este campo es opcional, pero se recomienda rellenarlo si piensas crear varias claves API. Añade una breve descripción para identificar su propósito (por ejemplo: «Integración CRM – Producción»).
2. Entorno
Elige dónde se utilizará la clave API:
Sandbox: entorno de prueba para la integración de la API.
Selecciona esta opción si estás iniciando la integración o aún no tienes un plan de API pago.
Producción: entorno activo para tu integración.
Disponible solo si te has suscrito a un plan de API.
3. Ámbito
Define el ámbito de la clave API.
El ámbito determina el conjunto máximo de recursos a los que puede acceder la clave.
Puedes elegir entre:
Ámbito de la organización
La clave API puede acceder a recursos en todos los espacios de trabajo de tu organización.
Esta opción permite que la clave API acceda a todos los datos de la organización.
Apto para integraciones globales o a nivel de plataforma.
Ámbito del espacio de trabajo
La clave API puede acceder a recursos solamente dentro de los espacios de trabajo seleccionados.
Debes seleccionar uno o más espacios de trabajo durante la creación.
Los recursos externos a esos espacios de trabajo no son accesibles.
La clave no puede gestionar usuarios ni espacios de trabajo.
El ámbito del espacio de trabajo permite aislar datos entre diferentes equipos, proyectos o clientes finales.
4. Nivel de permiso
Elige el nivel de acceso:
Acceso completopara crear o actualizar recursos con solicitudes API.
Solo lectura: para leer solo la información transmitida con solicitudes API.
Una vez completados todos los campos, haz clic en Crear clave API.
La nueva clave aparecerá en la lista de claves API, donde podrás ver su:
Entorno
Nivel de permiso
Ámbito
También puedes utilizar filtros y opciones de navegación en la página de claves API para encontrar rápidamente claves específicas.
¿Cuántas claves API puedo crear?
Puedes crear hasta 200 claves API activas por organización.