Saltar al contenido principal

Legalesign GraphQL API

Legalesign ofrece dos APIs para la integración de firmas electrónicas:

  • REST API - Inicio rápido, formato tradicional
  • GraphQL API - Máximo poder, más flexible

Esta guía se enfoca en GraphQL. Necesitarás conocimientos de JSON y experiencia básica en solicitudes web.

¿Por qué elegir GraphQL?​

REST es confiable, familiar y seguirá con nosotros. GraphQL te ofrece una forma diferente de pensar acerca de cómo obtener y estructurar datos. En Legalesign, GraphQL es la API de primera clase: toda la plataforma está disponible a través de ella.

RESTGraphQL
EndpointsMúltiples (/users, /contracts, etc.)Único (/graphql)
Obtención de datosFijo por endpointConsultas definidas por el cliente
Sobre/subobtenciónComúnReducida
VersionadoVersionado (/v1/, /v2/)Sin versión — nuevos campos no rompen consultas existentes
AutenticaciónClave APIOAuth 2.0 o clave API (subconjunto soportado igual)

GraphQL te da acceso completo a las funciones de Legalesign:

  • Solicita solo los datos que necesitas
  • Un endpoint único para todo
  • El mismo poder que la app web

Desarrolladores TypeScript/JavaScript​

Considera el TS/JS SDK para casos de uso comunes, pero aprender GraphQL te da 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
  • Navegar el esquema completo
  • Depurar antes de programar
info

Si has iniciado sesión en Legalesign, la autenticación es automática.

Para un ejemplo mínimo de funcionamiento inicial, ve a la Guía Rápida.

sugerencia

Encuentra consultas y mutaciones listas inspeccionando las solicitudes de red en la consola de la app web Legalesign.

Acceso Programático​

GraphQL soporta dos modos de autenticación:

ModoCoberturaEncabezadoMejor para
OAuth 2.0Solo subconjunto soportado (operaciones con clave API, excepto generateComponentToken)Authorization: Bearer <access-token>Integraciones que actúan en nombre de un usuario Legalesign, que inicia sesión y da su consentimiento
Clave APISolo subconjunto soportadoAuthorization: Bearer <api-key>Automatización del lado servidor y flujos comunes de envío/lectura

Para OAuth 2.0, registra un cliente en el Portal de Desarrolladores y sigue la guía de cliente OAuth.

Para autenticación con clave API, crea una clave con soporte GraphQL en el Portal de Desarrolladores y revisa las operaciones GraphQL soportadas para conocer consultas y mutaciones compatibles.

Consulta la guía de autenticación para más detalles.

¿Usas una herramienta de codificación con IA?​

Si usas Cursor, Claude, Windsurf u otro asistente IA, conéctalo con el servidor de documentación Legalesign para ayuda contextual mientras programas. Ve a Conecta tu herramienta IA.

Próximos Pasos​

  1. Comienza con la Guía Rápida
  2. Añade eventos en tiempo real con la Guía Rápida de Websocket en Tiempo Real
  3. Explora el esquema en el Explorador GraphQL
  4. Elige autenticación OAuth 2.0 o con clave API para acceso programático
  5. Sigue un tutorial: Node.js · C#
  6. Conecta tu herramienta IA para asistencia de codificación contextual

GraphQL te ofrece el mismo poder que la app web Legalesign: si puedes hacerlo allí, puedes hacerlo con la API.