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, administrar puntos finales de webhook, revisar las entregas recientes de webhook e inspeccionar el uso de la API para tu organización.
El portal reemplaza el panel de control API anterior para los nuevos flujos de trabajo de gestión de claves API. Las claves REST API heredadas existentes continúan funcionando para integraciones actuales, pero las nuevas integraciones deben usar el portal y el nuevo formato de clave 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 el desarrollo 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 API.
Claves API
La sección Claves API te permite crear y revocar claves API para una organización.
Cuando crees una clave, elige:
- Un nombre para la clave, generalmente la integración o el entorno que la utilizará.
- La interfaz de la API: REST, GraphQL o ambas.
- Un período de expiración opcional.
La clave API en texto plano se muestra una sola vez, inmediatamente después de la creación. Cópiala antes de salir de la página porque no se puede mostrar nuevamente.
Las claves nuevas usan el formato de clave API empresarial y se envían como un token bearer:
Authorization: Bearer ak_<environment>_<key-id>.<secret>
Las claves REST heredadas se muestran por separado cuando existen. Solo se admiten para integraciones REST actuales. Migra las nuevas integraciones a las nuevas claves API y revoca las claves heredadas cuando ya no se usen.
Entorno
La sección Entorno muestra los identificadores de organización y equipo disponibles para tu cuenta.
Usa esta sección cuando una solicitud API necesite 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 también muestra las direcciones de correo electrónico aprobadas para destinatarios sandbox. El modo sandbox restringe el envío de documentos REST solo a esas direcciones.
Webhooks
La sección Webhooks te permite crear, editar, deshabilitar y eliminar puntos finales de webhook.
Para cada webhook, elige:
- La URL del punto final.
- El tipo de evento.
- El alcance 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 registros para inspeccionar cargas útiles de eventos, estado de entrega y fallos recientes.
Para facilitar el desarrollo de webhooks, también puedes enviar eventos de webhook manualmente en esta página.
Para configuración automatizada, la configuración de webhook también se puede administrar a través de la API. Consulta la guía de webhooks para detalles de integración.
Uso
La sección Uso resume la actividad reciente de la API para la organización seleccionada.
Úsala para verificar:
- Volumen total de solicitudes.
- Qué claves se usaron.
- Operaciones principales.
- Conteos 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 realizar 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 la organización pueden ver una vista de gestión más amplia 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 a través de claves de la organización.
- Eventos de auditoría de claves API.
- Webhooks de la organización.
Usa esta vista para revisar el acceso, revocar claves propiedad de usuarios de la organización y auditar cambios recientes en el ciclo de vida de las claves API.
