Documentación de la API
Referencia de la API de ProcessMind: endpoints, autenticación y guías de integración para desarrolladores.
En esta página
Comenzar
Fundamentos de procesos
Arquitectura de procesos
Inteligencia de procesos
Datos
Administración
Referencia
Claves de API
Administrar claves de API en ProcessMind
Para integrar la API de ProcessMind, debe crear y administrar claves de API. Aprenda a generarlas, usarlas y protegerlas.
En la configuración de su cuenta de ProcessMind, vaya a la sección «Claves de API». Allí puede crear una clave haciendo clic en el botón Nueva clave de API del entorno. Asígnele un nombre para identificarla más adelante.
Crear una clave de API
Puede crear varias claves de API para distintas aplicaciones o servicios. Cada clave se administra por separado, de modo que puede revocarla cuando sea necesario sin afectar a otras integraciones. Una vez generada la clave, cópiela y guárdela en un lugar seguro. Por motivos de seguridad, solo se mostrará una vez durante su creación.
warning
Mantenga seguras sus claves de API y nunca las exponga en código del lado del cliente ni en repositorios públicos. Si una clave queda comprometida, revóquela de inmediato y genere otra.
Claves de API de la organización
Los administradores de la organización también pueden crear claves de API de la organización en la misma página. A diferencia de las claves de entorno, una clave de organización funciona en todos los entornos (inquilinos) de la organización, por lo que una sola integración puede atenderlos a todos. Use claves de organización para:
- Aprovisionar claves de API de entorno: crear, actualizar y eliminar claves asociadas a un inquilino mediante la API externa (
/v1/tenant/{tenantId}/api-keys). - Generar enlaces de inicio de sesión de un solo uso: dirigir a un usuario desde su propio producto directamente a ProcessMind con la sesión ya autenticada (
/v1/tenant/{tenantId}/users/{userId}/login-token).
Ámbitos
| Ámbito | Permisos |
|---|---|
| read | Leer datos del inquilino (endpoints de lista y consulta). Activado de forma predeterminada. |
| write | Crear, actualizar y eliminar datos del inquilino. Activado de forma predeterminada. |
| uploadData | Solicitar URL de carga prefirmadas para tablas de datos. Activado de forma predeterminada. |
| sessions | Generar tokens de transferencia de inicio de sesión de un solo uso. Desactivado de forma predeterminada. |
Active sessions solo en las claves que necesiten transferir el inicio de sesión y protéjalas como si fueran contraseñas: el token generado inicia la sesión del usuario sin pedirle una contraseña. Una clave de organización puede generar tokens para usuarios de todos los entornos de la organización; una clave de entorno, solo para usuarios de su propio entorno.
Transferencia de inicio de sesión de un solo uso
POST /v1/tenant/{tenantId}/users/{userId}/login-tokenDevuelve un token de un solo uso, válido durante 60 segundos y vinculado al usuario, al entorno y a la organización, además de un url. Redirija el navegador del usuario a esa URL para que acceda a ProcessMind con su propia sesión, sin enlaces por correo electrónico ni suplantación de identidad. Si lo desea, incluya un path en el cuerpo de la solicitud para dirigirlo directamente a una página específica. La clave debe tener el alcance sessions, y solo se puede crear un usuario para un inquilino al que la clave tenga permiso de acceso.
La generación de tokens queda registrada en auditoría, está sujeta a límites estrictos de frecuencia y se bloquea de inmediato si se desactiva la clave o el usuario pierde el acceso. El token se devuelve una sola vez y nunca se registra en los logs.
Temas relacionados
- Descripción general de la API: cómo realizar llamadas a la API.
- Referencia de la API: documentación de los endpoints.