1. Home
  2. Para desarrolladores
  3. Conectarse a las APIs

Conectarse a las APIs

Introducción

En este tutorial se explica cómo conectarse con la API de Reviso (REST) usando “Agreement Grant Tokens” (tokens de autorización de acceso a los datos de la empresa) y “App Secret Tokens” (tokens secretos a la aplicación).

Esto son aplicaciones que permiten a cualquier socio integrador el acceso a los datos de Reviso, sin tener que memorizar los credenciales del usuario.

Notas y requisitos

El usuario final debe estar definido con los permisos requeridos por la aplicación. En la aplicación, por defecto, cuando se utiliza nuestro formulario de solicitud para desarrolladores, se requiere el rol de Superusuario. Lee más acerca de los permisos y roles.

Perfil administrador: si deseas administrar la autorización de accesos a datos de una empresa de un cliente, deberás utilizar los credenciales del Superusuario de la empresa cliente.

El propietario de la empresa recibió sus credenciales, o datos de acceso, en el primer e-mail que recibió de Reviso en el momento del alta de la suscripción. Como administrador, no puedes instalar la aplicación utilizando credenciales de administrador, sino que necesitarás los del Superusuario.

Conectarse en 3 pasos

Para comenzar, deberás completar los siguientes 3 pasos:

  1. Regístrate como desarrollador.
  2. Obtén, desde Reviso, un “Agreement Grant Token” (token de autorización de acceso a los datos de la empresa) y “App Secret Token” (token secreto a la aplicación).
  3. Conecta Reviso a través de REST.

Paso 1: Registrarse como desarrollador

Regístrate en la página de Reviso para desarrolladores para obtener un número de contrato con perfil de desarrollador. Este contrato tendrá una aplicación pre-registrada que podrás utilizar de inmediato y, también, podrás dar de alta nuevas apps.

Ten en cuenta que esta aplicación inicial está establecida para requerir el uso del rol de Superusuario.

Integración con Reviso

Después de realizar el registro recibirás un e-mail con los credenciales de acceso para tu nuevo contrato como desarrollador.

Paso 2: Obtén un token de autorización de acceso a los datos de la empresa

Inicia sesión en tu contrato de desarrollador de Reviso y dirígete a la pestaña de Desarrollador.

Aquí, podrás dar de alta la conexión con la aplicación y empresa de tu cliente. Pincha en la opción de New app (nueva app) y rellena los datos.

Una vez rellenos los datos, pincha en Save (Guardar) para crear los datos del token.

Pincha, sobre la línea que se ha creado, en la columna llamada “Request URL”. Se te abrirá una pestaña adicional para conectar el contrato de Reviso.

Si deseas llevar a cabo pruebas para ver como funciona Reviso, puedes solicitar una versión de prueba gratuita o asistir a alguna de nuestras presentaciones online gratuitas, donde mostramos Reviso y sus principales funcionalidades.

Si necesitas ampliar el periodo de prueba de tu acceso como desarrollador, envía un correo a nuestro equipo de soporte api@reviso.com. Deberás escribirles en inglés, por favor.

Recepción manual del “Agreement Grant Token”

Envía la URL de la pantalla de conexión de contrato al cliente final para solicitar la autorización de acceso. Cuando el usuario haga clic en el enlace, podrá introducir sus datos de suscripción de Reviso como Superusuario y te concederá acceso a sus datos.

Una vez introducidos sus datos, el cliente te concede acceso a su empresa. Además, le aparecerá en pantalla en token que deberá copiar y enviarle al propietario de la app a conectar con Reviso.

Recepción automática del “Agreement Grant Token”

Para obtener automáticamente el Agreement Grant Token, debes configurar un punto final (endpoint) en tu propia solución, la cual sea capaz de recibir la señal de petición GET donde se muestra el token.

Para redirigir a los usuarios finales es necesario incluir un parámetro redirectURL en el enlace proporcionado a los usuarios finales. La URL de redireccionamiento puede contener una cadena de consulta en la que se puede especificar información adicional para identificar al usuario.

Ejemplo de re-dirección con el parámetro redirectURL:

    redirectUrl=https://www.example.com%3userIdInMySystem=123

Ejemplo completo de URL de solicitud incluida la re-dirección:

    https://app.reviso.com/api1/requestaccess.aspx?appId=<PublicAppToken>&locale=en-GB&redirectUrl=https://www.example.com%3FuserIdInMySystem=123

Cuando los usuarios hagan clic sobre el enlace, se registrará en la página de autorización.

Después de autorizar la aplicación, los usuarios son redirigidos a la URL indicada con el Agreement Grant Token unido a la cadena de consulta.

Ejemplo:

    https://www.example.com?userIdInMySystem=123&token=<GeneratedAgreementGrantToken>

Paso 3: Conectarse a Reviso

Una vez disponemos del Agreement Grant Token, deberás conectarte a Reviso utilizando la llamada REST.

1. Adjuntar los siguientes tres encabezados a las peticiones HTTP:

  X-AppSecretToken: <TheAppSecretToken>
  X-AgreementGrantToken: <TheAgreementGrantToken>
  Content-Type: application/json

2. Emitir un GET a https://rest.reviso.com/customers y controlar la respuesta para verificar que todo funciona.

Updated on 10 August, 2020

Was this article helpful?

Related Articles