Portal de Desarrolladores
El Portal de Desarrolladores de Legalesign es donde puedes gestionar tu acceso a la API y supervisar tu organización.
Úsalo para crear y revocar claves API, copiar los identificadores que necesita tu integración, gestionar endpoints de webhook, revisar las entregas recientes de webhooks e inspeccionar el uso de la API para tu organización.
El portal reemplaza el antiguo panel de control de la API para los nuevos flujos de gestión de claves API. Las claves API REST heredadas existentes siguen funcionando para integraciones ya existentes, pero las nuevas integraciones deben usar el portal y el nuevo formato de claves API.
Acceso
Ve a developer.legalesign.com. Inicia sesión con tu cuenta de Legalesign. Es posible que inicies sesión automáticamente si tienes una sesión activa en la aplicación web.
Tu cuenta debe estar aprobada para desarrollo de API. Si el portal indica que la gestión de claves API no está habilitada para tu usuario, crea un ticket de soporte y solicita que se verifique el acceso a la API.
Claves API
La sección de Claves API te permite crear y revocar claves API para una organización.
Cuando crees una clave, elige:
- Un nombre para la clave, usualmente la integración o entorno que la usará.
- La interfaz API: REST, GraphQL o ambas.
- Un periodo de expiración opcional.
La clave API en texto plano se muestra una vez, inmediatamente después de la creación. Cópiala antes de salir de la página porque no se mostrará de nuevo.
Las nuevas claves usan el formato de clave API empresarial y se envían como un token bearer:
Authorization: Bearer ak_<environment>_<key-id>.<secret>
Las claves heredadas REST se muestran por separado cuando existen. Se soportan solo para integraciones REST existentes. Migra las nuevas integraciones a las nuevas claves API y revoca las claves heredadas cuando ya no se usen.
Entorno
La sección de Entorno muestra los identificadores de organización y equipo disponibles para tu cuenta.
Usa esta sección cuando una solicitud de API requiera un contexto de organización o equipo. En particular, las solicitudes REST API que actúan dentro de una organización deben incluir el encabezado de organización:
X-Organisation: <organisation-id>
El portal muestra los identificadores de GraphQL y REST lado a lado cuando ambos están disponibles.
Si tu usuario REST API está en modo sandbox, la sección Entorno muestra tu límite actual de velocidad (100 llamadas por hora).
Webhooks
La sección de Webhooks te permite crear, editar, deshabilitar y eliminar endpoints de webhook.
Para cada webhook, elige:
- La URL del endpoint.
- El tipo de evento.
- El ámbito del grupo, o todos los grupos.
- Si el webhook está habilitado.
El portal también muestra intentos recientes de entrega de webhook. Usa la vista de registro para inspeccionar cargas útiles de eventos, estado de entrega y fallos recientes.
Para facilitar el desarrollo de webhooks, también puedes enviar manualmente eventos webhook desde esta página.
Para configuración automática, la configuración de webhooks también puede gestionarse mediante la API. Consulta la guía de webhooks para detalles de integración.
Uso
La sección de Uso resume la actividad reciente de la API para la organización seleccionada.
Úsala para revisar:
- Volumen total de solicitudes.
- Qué claves fueron usadas.
- Principales operaciones.
- Conteo de solicitudes autorizadas y denegadas.
- Actividad de solicitudes a lo largo del tiempo.
Este es el primer lugar para revisar después de crear una clave y hacer una solicitud de prueba. Ayuda a confirmar que la clave se está usando y si las solicitudes están siendo aceptadas o denegadas.
Administrador de Organización
Los administradores de organización pueden ver una vista más amplia de gestión para su organización.
Dependiendo de tus permisos, esta sección puede incluir:
- Claves API a nivel de organización.
- Claves activas y revocadas.
- Uso de claves a nivel de organización.
- Eventos de auditoría de claves API.
- Webhooks de la organización.
Usa esta vista para revisar accesos, revocar claves propiedad de usuarios de la organización y auditar cambios recientes en el ciclo de vida de las claves API.
