Autenticar con la API
GraphQL admite dos modos de autenticación:
| Modo | Cobertura | Encabezado | Ideal para |
|---|---|---|---|
| OAuth 2.0 | Solo subconjunto soportado (las operaciones con API-key, excepto generateComponentToken) | Authorization: Bearer <access-token> | Integraciones que actúan en nombre de un usuario de Legalesign, que inicia sesión y da su consentimiento |
| Clave API | Solo subconjunto soportado | Authorization: Bearer <api-key> | Automatización del lado del servidor y flujos comunes de envío/lectura |
Ambos modos soportan el mismo conjunto de operaciones. Un token OAuth actúa como el usuario que lo autorizó, con los permisos de ese usuario.
Autenticación con Clave API
Cree una clave API habilitada para GraphQL en el Developer Portal, luego envíela como un token bearer:
POST /graphql HTTP/1.1
Host: graphql.uk.legalesign.com
Content-Type: application/json
Authorization: Bearer ak_<environment>_<key-id>.<secret>
{"query": "{ user { id email } }"}
GraphQL solo necesita
Authorization: Bearer. No se requieren encabezados personalizados comox-organisationu otros.
Consulte las operaciones GraphQL soportadas y las insignias de autenticación en las páginas de referencia de consultas y mutaciones antes de usar una operación con una clave API.
Autenticación OAuth 2.0
OAuth 2.0 permite que su aplicación actúe en nombre de un usuario específico de Legalesign, para las operaciones que admiten las claves API, excepto generateComponentToken (consulte las operaciones GraphQL soportadas). El usuario inicia sesión y da su consentimiento explícito. Su aplicación nunca maneja su contraseña.
Registre un cliente OAuth en el Developer Portal y luego siga la guía de cliente OAuth para los pasos completos de integración. Su servidor se autentica en el endpoint de token con el secreto del cliente, así como con PKCE.
Una vez que tenga un token de acceso, úselo de manera idéntica a una clave API:
POST /graphql HTTP/1.1
Host: graphql.uk.legalesign.com
Content-Type: application/json
Authorization: Bearer eyJ...
{"query": "{ user { id email } }"}
Los tokens de acceso expiran después de una hora. Use el token de actualización para obtener uno nuevo sin que el usuario se vuelva a autenticar. Un token de actualización expira si no se usa durante 30 días, y la autorización del usuario en su conjunto dura 12 meses desde la última vez que aprobó su aplicación, después de lo cual el usuario debe autorizar nuevamente. Los tokens de actualización rotan en cada uso, así que actualice desde un solo lugar a la vez y guarde el nuevo token en cada ocasión.
Los tokens OAuth son aceptados únicamente por la API GraphQL, no por la API REST. Un token actúa con los permisos propios del usuario autorizado y actualmente no está limitado a los datos de su organización. Consulte la guía de cliente OAuth para entender lo que eso significa antes de registrar un cliente.
Autorización de Widget y Componente
Los widgets autenticados, como el Visor de Documentos y el Firmante, necesitan un token de corta duración que se pasa a su atributo token. Use una clave API para llamar a generateComponentToken desde el servidor y pase el token devuelto al widget.
Consulte Autorización de Widget para el flujo completo y las recomendaciones de seguridad del navegador.