Para interactuar con la API de Workvivo, se debe incluir un token de portador en el encabezado de todas las solicitudes. Este artículo le guiará a través del proceso de:
- Crear una aplicación en Workvivo
- Agregar los permisos/alcances necesarios
- Generando el token Bearer
Dispositivo(s): Escritorio
Roles/Permisos: Desarrollador
Disponibilidad: Acceso a API habilitado a solicitud del Soporte
Tenga en cuenta lo siguiente:
- Para utilizar la API de Workvivo, primero debe comunicarse con el soporte para solicitar acceso a la API.
-
Workvivo requiere que cualquier usuario que interactúe con nuestra API tenga primero el rol de desarrollador. Esta tarea puede ser realizada por el administrador de su cuenta una vez que se le haya otorgado acceso a la API. Consulte (Otorgamiento de roles en Workvivo).
Una vez que se haya otorgado el rol de desarrollador, el usuario tendrá acceso a una opción adicional dentro del panel de administración: “Configuración de claves API y JWT”. Esta configuración proporciona al usuario acceso para crear una aplicación, agregar o eliminar ámbitos de integración y generar un token portador siguiendo los pasos a continuación.
1. Abra la administración y haga clic en "Configuración de claves API y JWT".
2. “Haga clic” en Agregar nueva aplicación
3. Otorgue a su aplicación los permisos y ámbitos necesarios y asígnele un nombre. Este es un buen momento para revisar la documentación de la API e identificar los permisos necesarios para cada punto final. Por ejemplo, para interactuar con la API de Teams, deberá aplicar todos los permisos de lectura y escritura necesarios.
Si no está seguro de qué permisos se requieren en este momento, no se preocupe, es posible realizar actualizaciones más adelante una vez que la aplicación esté activa.
4. Ahora que la aplicación se ha creado, haga clic en “Administrar claves”.
5. “Haga clic en” Agregar nueva clave: una vez que se haya nombrado la nueva clave, se completará el token del portador.
Guarde el token en una ubicación segura, ya que no podrá recuperarse una vez cerrada la ventana. Si en algún momento el token de portador se ve comprometido, elimínelo inmediatamente y cree una nueva clave.
información adicional
- Para referencia - Documentación para desarrolladores de Workvivo
- Recordatorio: el acceso a la API no está habilitado para todas las cuentas de Workvivo, por lo que debe solicitar acceso al Soporte.