Legalesign GraphQL API
Legalesign ofrece dos APIs para integración de firma electrónica:
- REST API - Inicio rápido, formato tradicional
- GraphQL API - Máximo poder, más flexible
Esta guía se centra en GraphQL. Necesitarás conocimientos de JSON y experiencia básica en solicitudes web.
¿Por qué elegir GraphQL?
REST es confiable, familiar y viene para quedarse. GraphQL te ofrece una forma diferente de pensar en la recuperación y el modelado de datos. En Legalesign, GraphQL es la API de primera clase: todas las partes de la plataforma están disponibles a través de ella.
| REST | GraphQL | |
|---|---|---|
| Endpoints | Múltiples (/users, /contracts, etc.) | Único (/graphql) |
| Obtención de datos | Fija por endpoint | Consultas definidas por el cliente |
| Sobre/sub-carga de datos | Común | Reducida |
| Versiones | Versionado (/v1/, /v2/) | Sin versiones — los campos nuevos no rompen las consultas existentes |
| Autenticación | Clave API | SRP o subconjunto de clave API |
GraphQL te da acceso completo a las funciones de Legalesign:
- Solicita solo los datos que necesitas
- Endpoint único para todo
- El mismo poder que la aplicación web
Desarrolladores TypeScript/JavaScript
Considera el TS/JS SDK para casos comunes, pero aprender GraphQL te brinda acceso completo a la plataforma. Compara SDK vs GraphQL.
Prueba GraphQL Ahora
Comienza con el Explorador GraphQL (requiere cuenta activa).
El Explorador te permite:
- Probar consultas y mutaciones
- Explorar el esquema completo
- Depurar antes de programar
Si has iniciado sesión en Legalesign, la autenticación es automática.
Para un ejemplo mínimo funcional, visita el Inicio rápido.
Encuentra consultas y mutaciones listas inspeccionando las solicitudes de red en la consola de la aplicación web de Legalesign.
Acceso Programático
GraphQL soporta dos modos de autenticación:
| Modo | Cobertura | Encabezado | Ideal para |
|---|---|---|---|
| SRP | Esquema completo de GraphQL | Authorization: Bearer <access-token> | Integraciones completas |
| Clave API | Subconjunto soportado únicamente | Authorization: Bearer <api-key> | Automatización del lado servidor y flujos comunes de envío/lectura |
Para autenticación SRP, contacta al soporte de Legalesign para obtener las credenciales y detalles para tu integración.
Para autenticación con clave API, crea una clave habilitada para GraphQL en el Portal de desarrolladores y consulta la referencia GraphQL para clave API para las consultas y mutaciones soportadas.
Consulta la guía de autenticación para más detalles.
¿Usas una herramienta de codificación AI?
Si usas Cursor, Claude, Windsurf u otro asistente AI, conéctalo al servidor de documentación de Legalesign para ayuda contextual mientras programas. Consulta Conecta tu herramienta AI.
Próximos Pasos
- Comienza con el Inicio rápido
- Añade eventos en tiempo real con el Inicio rápido Websocket en tiempo real
- Explora el esquema en el Explorador GraphQL
- Elige autenticación SRP o con clave API para acceso programático
- Sigue un tutorial: Node.js · C#
- Conecta tu herramienta AI para asistencia de codificación contextual
GraphQL te da el mismo poder que la aplicación web de Legalesign: si puedes hacerlo allí, puedes hacerlo con la API.