Documentación técnica

Bienvenida

Registrarse en nuestro portal es el primer paso para acceder a las APIs que Inversis Banco pone a disposición de sus Clientes en API Inversis Solutions.

Para ello, lee detenidamente esta pequeña introducción como paso previo. A continuación, sigue el enlace de la esquina superior derecha Registro y completa los formularios que API Inversis Solutions te irá ofreciendo. Por favor, presta especial atención a aquellos campos señalados con un asterisco que son considerados como preceptivos para el registro.

Una vez que hayas accedido a tu área privada dentro de API Inversis Solutions, revisa la información actualizada de la sección “Como Empezar”.

Jerarquía de Usuarios para su Organización

Tu Organización o Institución puede registrar tantos usuarios de API Inversis Solutions como necesite y todos tus usuarios estarán asociados a tu Organización, pudiendo ser fácilmente gestionados desde API Inversis Solutions .

API Inversis Solutions distingue dos tipos diferenciados de usuario y la operativa de registro varía ligeramente para cada tipo. Todos los usuarios del portal tienen asociada una Organización o Institución que será defina por el primer usuario que registrado.

El primer usuario que tu Organización registre será considerado el usuario Administrador de la Organización ( Organization Admin ) y se le otorgarán los permisos de administración de tu Organización dentro de API Inversis Solutions . Como administrador, este usuario tendrá la capacidad de suscribir a tantos usuarios Desarrollador ( Developer ) a tu Organización como necesites, mediante una invitación personal gestionada dentro de API Inversis Solutions. La siguiente tabla muestra los diferentes tipos de usuarios, así como el método de registro y las características asociadas a cada tipo de usuario.

Administrador de la Organización

Creación de una cuenta en API Inversis Solutions a través de Registro

Usuario considerado como administrador de la Organización dentro de API Inversis Solutions
Es el primer usuario registrado asociado a la Organización
Es responsable de la administración de los usuarios Developer asociados a la Organización
Puede ser el único usuario de la Organización
Tiene acceso a todos los servicios de API Inversis Solutions

Desarrollador

Por invitación directa del Usuario Administrador

Resto de usuarios asociados a la Organización
Tiene acceso a todos los servicios de API Inversis Solutions

Registra el Primer Usuario de tu Organización en API Inversis Solutions

1. Sigue el enlace de la esquina superior derecha Registro (Signup).
API Inversis Solutions te guiará a través de un sencillo proceso de registro mediante un formulario.

2.Rellene el formulario

Pestaña Información Personal. Es obligatorio cumplimentar todos los campos, así como aceptar los términos de uso marcando el descargo de responsabilidad del final del cuadro de diálogo.
Pestaña Información Adicional. Se introducen los datos sobre la organización que estás registrando, siendo obligatorio introducir un nombre de organización. Si no se introduce un nombre de organización, API Inversis Solutions otorga un nombre por defecto.

Nombre de la Organización

Nombre de la Organización
Si no completa este campo, el nombre de la organización será asignado por defecto como username_org.

Descripción de la Organización

Descripción de la organización
Si no completa este campo, el nombre de usuario será utilizado como descripción de la organización

Nótese que la pestaña Información Adicional no estará disponible hasta que se completen los datos obligatorios de la pestaña Información Personal.

3. Cumplimentada la información de ambas pestañas y aceptados los términos de uso, pulsa el botón registrar. Un diálogo informativo confirmará que tu petición ha sido procesada y el registro está bajo revisiónⁱ. Recibirás esta misma información en el correo electrónico introducido durante el registro.

4. Validación de usuario.
Completados estos pasos, tu usuario Administrador y tu Organización están registrados en API Inversis Solutions. Inversis Banco procederá a la validación de su Organización y enviará la información de registro al correo electrónico facilitado.

5. Comience a explorar API Inversis Solutions
Como usuario validado, podrás acceder a tu área privada de API Inversis Solutions a través del botón Login (esquina superior derecha de página de inicio del Portal), con el usuario y las contraseñas elegidas en el registro.

Registra nuevos Usuarios de su Organización

Una vez registrada y aprobada tu Organización y tras acceder con el usuario Administrador, podrás enviar tantas invitaciones para la creación de usuarios Desarrollador como necesites para trabajar con API Inversis Solutions. Estas invitaciones se gestionan directamente en el área privada del usuario Administrador de Inversis API Portal y son enviadas a los destinatarios vía correo electrónico.

Los usuarios Desarrollador recibirán la invitación en su correo electrónico con las instrucciones de acceso y suscripción a API Inversis Solutions, incluyendo el enlace a la página de registro. El proceso de registro de un usuario Desarrollador, una vez ha sido invitado, es similar al proceso de registro del usuario Administrador y estará guiado en todo momento por Inversis API Poral.

Todos los usuarios, independientemente del rol asignado, pueden acceder a todos los servicios de API Inversis Solutions, en particular crear aplicaciones con las APIs accesibles a través del portal o usar herramientas como API Explorer para testar los Servicios Web.

ⁱEl registro de nuevos usuarios puede estar sujeto a la aprobación de Inversis Banco

Registra Nuevos Usuarios de su Organización

Una vez registrada y aprobada tu Organización y tras acceder con el usuario Administrador, podrás enviar tantas invitaciones para la creación de usuarios Desarrollador como necesites para trabajar con API Inversis Solutions. Estas invitaciones se gestionan directamente en el área privada del usuario Administrador de lnversis API Portal y son enviadas a los destinatarios vía correo electrónico.

Para invitar a nuevos usuarios Desarrollador navega a través del menú de la izquierda de tu área privada (Dashboard) hasta Organización > Invitaciones. Una vez en esa página pulsa el botón Invitar Nuevo Usuario e introduce la lista de correos electrónicos de los desarrolladores que deseas invitar, separados por comas, en el campo habilitado del diálogo que le mostrará API Inversis Solutions. Como Administrador, podrás realizar este proceso tantas veces como desees.

Los desarrolladores recibirán la invitación en su correo electrónico con las instrucciones de acceso y suscripción al Portal, incluyendo el enlace a la página de registro. El proceso de registro de un usuario Desarrollador, una vez ha sido invitado, es similar al proceso de registro del usuario Administrador.

Un Plan de Cuentas a Medida para tu Organización

Este es un paso fundamental para poder operar en API Inversis Solutions. El equipo de Inversis Banco contactará con tu Organización para crear un Plan de Cuentas (Account Plan) a tu medida. Te aconsejaremos y guiaremos en la decisión de seleccionar las APIs que incluirá tu Plan de Cuentas para cubrir las necesidades de tu Organización y ayudarte a expandir tu negocio. Una asesoría constante le permitirá en todo momento ajustar tu Plan de Cuentas a los nuevos retos que tengas que afrontar, permitiendo potenciar tu negocio a cada paso con nuestro catálogo de APIs.

Crea una Aplicación a tu Medida

La creación de una Aplicación es un paso preceptivo para obtener las claves que permiten al usuario hacer uso de los APIs que Inversis ha hecho accesibles a través del Inversis API Portal.

Para crear una Aplicación navega a través del menú de la izquierda de tu área personal (Dashborad) hasta la pantalla Aplicaciones (Applications) y sigue estos sencillos pasos:

Pulsa el botón Añadir Aplicación (Add Application). Se mostrará el cuadro de diálogo del asistente de creación de nueva aplicación. Este asistente tiene varias pestañas a las que se accede a través del botón Next Step.
Completa la información de la primera pestaña Información de la Aplicación (Application Information), siendo imprescindible rellenar aquellos campos marcados con un asterisco.
Pulsa el botón Next Step.
Completa la información de la segunda pestaña API Management. Esta pestaña está dedicada a la elección de la API (los servicios) o grupos de APIs que deseas incluir en tu aplicación. Recuerda aceptar los Términos y condiciones de uso de cada una de las APIs seleccionadas para la Aplicación.
Pulsa el botón Next Step.
En la tercera pestaña, Auth, debes rellenar el campo tipo (type) si la Aplicación utiliza Oauth 2.0, fijándolo como confidencial en el desplegable.
Pulsa el botón Save para finalizar el proceso de creación de su Aplicación.

Puedes encontrar una descripción más detallada de este procedimiento en nuestro manual Como Empezar en API Inversis Solutions .

Tras la ejecución de los pasos descritos, tu Aplicación está creada y una vez aprobada te avisaremos por correo electrónico notificando la disponibilidad de la Aplicación en tu área privada.

Prueba los servicios desde API Inversis Solutions

El Explorador de APIs (API Explorer) del API Inversis Solutions permite a los desarrolladores descubrir de forma interactiva las APIs expuestas en el portal, pudiendo entender y analizar las características de las APIs expuesta. Seleccionando entre los diferentes recursos y métodos válidos del API, enviando consultas y analizando las respuestas, los desarrolladores no solo obtienen una mejor comprensión del funcionamiento del API, sino también de los métodos de autenticación para accederlas.

La autentificación es el paso previo a configurar y testar una API en el portal. Todas las APIs expuestas en API Inversis Solutions utilizan autentificación OAuth 1.0 o OAuth 2.0.

Sigue los siguientes pasos para autentificar una API usando Oauth 2.0 en API Inversis Solutions:

1. Selecciona la API a autenticar.

2. Pulsa el botón Autentificación (Authentication).

3. Selecciona Oauth 2.0 en el menú Servicio de Autentificación (Service Authentication).

4. Completa los campos que se describen en la tabla que se muestra a continuación.

5. Pulsa el botón OK para validar la entrada y añadirla a l lista de Peticiones (Requests).

Consulta nuestro manual Como Empezar en API Inversis Solutions para obtener más detalles acerca de este procedimiento.

Ya estás preparado para probar tus Servicios en API Inversis Solutions. Navega desde la página principal a Explorador de APIs (API Explorer). Elije el Servicio o API que deseas probar, así como el Recurso y el Método que utilizará el Servicio. Se abrirá un formulario para que introduzcas el JSON y para que añadas los parámetros de cabecera (Headers).

Puedes encontrar un ejemplo detallado en nuestro manual Como Empezar en API Inversis Solutions .

Establecido el comportamiento que deseas para tu Aplicación (parámetros de cabecera y tipo de representación), autentifica la Aplicación pulsando Autentificación (Authentication). Se mostrará un diálogo donde se eligen a través de listas desplegables el método de autentificación y el tipo. Valida los datos pulsando OK.

Ahora tienes todo preparado para probar tu Servicio simplemente pulsando el botón Ejecutar Petición (Execute Request). Los resultados se mostrarán en la tercera pestaña del diálogo habilitado, Respuesta (Response).