Saltar al contenido principal

API GraphQL de Legalesign

El acceso a la API requiere aprobación

Para usar la API de Legalesign necesitas contactarnos para que el uso de la API sea aprobado para tu cuenta.

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

  • REST API - Inicio rápido, formato tradicional
  • API GraphQL - Potencia completa, 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 fiable, conocido y está aquí para quedarse. GraphQL te ofrece una forma diferente de pensar sobre la recuperación y estructuración de datos. En Legalesign, GraphQL es la API de primera clase: cada parte de 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/infra recuperaciónComúnReducida
VersionadoVersionado (/v1/, /v2/)Sin versiones — los nuevos campos no rompen consultas existentes
AutenticaciónClave APISRP o subconjunto de clave API

GraphQL te da acceso completo a las funcionalidades de Legalesign:

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

Desarrolladores TypeScript/JavaScript

Considera el SDK TS/JS para casos comunes, pero aprender GraphQL te da acceso total 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 primer ejemplo mínimo funcional, visita el Inicio rápido.

sugerencia

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

Acceso programático

GraphQL soporta dos modos de autenticación:

ModoCoberturaCabeceraMejor para
SRPEsquema GraphQL completoAuthorization: Bearer <access-token>Integraciones completas
Clave APISolo subconjunto soportadoAuthorization: Bearer <api-key>Automatización del lado servidor y flujos comunes de enviar/leer

Para autenticación SRP, contacta con soporte de Legalesign para obtener las credenciales y detalles para tu integración.

Para autenticación con clave API, crea una clave con soporte GraphQL en el Portal de desarrolladores y revisa la referencia GraphQL de clave API para ver las consultas y mutaciones soportadas.

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 al servidor de documentación de Legalesign para ayuda contextual mientras programas. Consulta Conectar tu herramienta IA.

Próximos pasos

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

GraphQL te da el mismo poder que la app web de Legalesign — si puedes hacerlo ahí, puedes hacerlo con la API.