R094 - Conectarse a las APIs - REVISO – Software Delsol

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).

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

Notas y requisitos

N.B. El usuario final debe tener las mismas autorizaciones requeridas por la aplicación para poder utilizarla.

Conectarse en 3 pasos

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

Solicitar registro de desarrollador.
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).
Conéctate a Reviso a través de REST.

Paso 1: Solicitar registro de desarrollador

Envía un correo electrónico a api@reviso.com y solicita la activación de un contrato con un perfil de desarrollador, indicando:

la dirección de correo electrónico que se utilizará para acceder a tu contrato
el nombre que se asignará a la aplicación.

Al activar este perfil, es posible crear varias aplicaciones.

Una vez enviada la solicitud, recibirás un correo electrónico con las credenciales de acceso al nuevo contrato de desarrollo.

N.B. Antes de iniciar la sesión, debes crear el TeamsystemID. Para ello, lee el artículo detallado

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.

Para que la aplicación pueda acceder a los datos del cliente, es necesario enviarle la URL de solicitud de autorización de acceso a los datos. 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.

Apoyamos la traducción de las páginas de solicitud de autorización. Esto se consigue añadiendo la cadena "local" a la url de solicitud de autorización /requestaccess.aspx. Se admiten los siguientes códigos: en-GB, de-DE, es-ES, en-IT.

N.B. Si deseas llevar a cabo pruebas para ver cómo 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:

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

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

Utilizzare Postman per gestire le APIs

Postman es una herramienta para crear, probar, documentar, supervisar y publicar la documentación de la API. Permite realizar cualquier tipo de petición a un servidor y es capaz de dar cualquier tipo de información necesaria.

Postman permite crear peticiones desde cero especificando diferentes parámetros, para conocer todo tipo de información tanto de la Petición como de la posterior Respuesta.

Permite realizar llamadas HTTP en GET, POST, PUT y DELETE, guardarlas y agruparlas para no tener que redefinirlas cada vez.

A continuación se muestra una colección de APIs de Contabilidad en la Nube para importar en Postman.

Reviso APIs - Collection v1.1.1

Para importar la colección, simplemente descargue y descomprima el archivo, inicie Postman, haga clic en Importar y seleccione el archivo a importar.

funciona.