Guia de Desarrolladores

Bienvenido al Portal de Desarrolladores

 

Inscribirse es muy sencillo!!

 

Nuestras APIs han sido diseñadas para adaptarse a tus necesidades y han demostrado ser exitosas en múltiples casos de uso, permitiendo oportunidades de negocio innovadoras. Proporcionamos una documentación clara y sencilla para facilitar tu integración.

 

Registro

¿Eres nuevo en el portal?

Crea tu cuenta haciendo clic en el botón Regístrate. Comienza llenando un breve formulario para completar tu perfil de usuario, ¡no te olvides de revisar los Términos y Condiciones!

Si tu empresa no se ha registrado antes, tendrás la opción de seleccionar tu tipo de entidad. Selecciona «Proveedor de Soluciones» (como FinTech o proveedor) y completa los campos con la información general de tu empresa. Por último, facilítanos información sobre tu solución. 

Usuario

  • Escribe el nombre de la empresa en el campo designado
  • Selecciona la opción: «La empresa no existe, vamos a crearla»

Tipo de Entidad

  • De acuerdo con tu tipo de entidad, selecciona <Proveedor de soluciones> y luego haz clic en Siguiente

Información de la Empresa  

  • Completa la información relacionada con tu entidad en las secciones «Información de la empresa«, «Perfil de la empresa» e «Información adicional«

Información de la Solución 

  • Añade información sobre el producto o productos que has desarrollado en la sección denominada «Información sobre la solución» 
  • ¡Cuéntanos todo sobre tus Soluciones! Sólo los campos marcados con un asterisco son obligatorios, pero te sugerimos que proporciones la mayor cantidad de información posible para que todos puedan comprender mejor tu producto

 

En cualquier momento, mientras completas los formularios de registro, puedes revisar la información proporcionada haciendo clic en el botón AtrásUna vez que hayas terminado de ingresar toda la información requerida, haz clic en Finalizar y Cargar la Información.

 

Antes de que tu registro sea aprobado, tu información tiene que ser revisada por nuestro equipo. Como desarrollador, una vez que tengas esta autorización de acceso, podrás tener visibilidad sobre las funcionalidades de la plataforma según tu rol, «ENTITY_ADMIN» es el que recomendamos.

Además, ahora que está aprobado, Bankbot le ha asignado 5 clientes y transacciones automáticamente para que comience a probar su solución y las APIs.

Nuestras APIs

¿Listo para integrarte en nuestro ambiente Sandbox?

Ahora que está registrado, ¡puedes empezar a probar tu solución!

En la barra lateral, en el apartado de APIs, puedes encontrar todas nuestras APIs, navegar por nuestro Catálogo de APIs, consultar las categorías o incluso gestionar tus APIs. Para empezar a utilizarlas, haz clic en la tarjeta que desees y selecciona «Solicitar Aprobación«. El Administrador del Portal recibirá una notificación y tendrá que aprobar tu solicitud antes de que puedas utilizar la API, pero puedes seguir consultando la documentación de la API.

 

Para empezar a utilizar cualquier API debes:

  • Ir al apartado APIs en el menú principal.
  • Seleccionar la tarjeta de la API y darle la vuelta con un clic:
    • En las fichas se puede encontrar información sobre ella, como una descripción, certificaciones o si está integrada con BankBot.
  • En la tarjeta seleccionada, hacer clic en:
    • Solicitar Aprobación para informar al Administrador del Portal que deseas utilizar la API, tendrá que aprobar la solicitud antes de que puedas empezar a utilizarla.
    • Ver API para revisar toda la documentación de las APIs, consultar ejemplos y errores, o incluso descargar Postman Collections para empezar a probarlas. Por defecto, revisarás la documentación de un ambiente de pruebas, el de Bankbot. En la esquina superior derecha, puedes elegir qué documentación quieres ver.
  • Una vez que tu solicitud haya sido aceptada, recibirás un correo electrónico para informarte de que ha sido aprobada. Aquí encontrarás instrucciones para obtener el Consumer Key y Consumer Secret de tu solución, necesarios para obtener la autorización de 4WRD.
  • Puedes ver el conjunto de APIs aprobadas o pendientes de aprobación en la pestaña «Mis APIs» y también encontrar la biblioteca de APIs a las que te has suscrito.

El ID de la aplicación y la clave secreta son credenciales únicas y privadas que permiten a FinConecta identificar tu app en el Portal de forma segura, no compartas esta información con personas no autorizadas.

Para utilizar cualquier API, primero tendrás que llamar a la API «Authorize», para que podamos reconocer que tienes acceso a la plataforma y que tu solución ha sido aprobada. A continuación, viene la API «Create Access Token», que utilizamos para asegurarnos de que las credenciales que estás utilizando como cliente son válidas.

Para suscribirte a otras API dentro del catálogo, sigue el mismo proceso. Da la vuelta a la tarjeta de la API con un clic y solicita la aprobación. El consentimiento para acceder a otras APIs se concederá utilizando el mismo ID de la aplicación y la Secret Key.

Aplica a una Necesidad o Desafío

¡Acepta el reto!

Otra forma de testear e integrar tu solución es a través de una Necesidad. Algunas de ellas están relacionadas con un Reto, mientras que otras pueden ser sólo Necesidades específicas y puntos de dolor que se intentan resolver. Estas son publicadas por el Administrador del Portal o por una Institución Financiera específica. Encontrarás una descripción con información sobre lo que buscan y las APIs recomendadas para que las tengas en cuenta. 

En la barra lateral del menú, busca la sección de Necesidades. Allí podrás ver todas las necesidades publicadas en tu portal. Ve, explora y encuentra algo que parezca interesante para ti y tu empresa, o que creas que encajaría bien con tu Solución . 

Una vez que lo hagas, ¡sólo tendrás que aplicar!

Una vez que encuentres una necesidad que te llame la atención,

  • Haz clic en la tarjeta para darle la vuelta
  • En «Más información«, encontrarás una descripción general de esta Necesidad, los requisitos, las API recomendadas y una sección para comprobar tu Aplicación
  • Haz clic en «Aplicar para resolver la necesidad» en la tarjeta o en la parte superior derecha de la información de la necesidad y completa el formulario de solicitud
    • Tu solicitud será revisada por la institución financiera que publicó esta necesidad/desafío, si encuentran que tu solicitud se ajusta a lo que están buscando, recibirás una notificación por correo electrónico
    • Se necesita una segunda aprobación del equipo de la institución financiera antes de que puedas empezar a testear tu solución

Una vez que tu aplicación sea Aprobada para Sandbox, se te suscribirá automáticamente a las APIs recomendadas para la Necesidad.  Puedes verificar las APIs a las que estás suscrito encontrándolas en la pestaña «Mis APIs«. Ahora puedes empezar a construir.

Puedes empezar a testear o desarrollar tu Solución para esta Necesidad específica, probándola contra Bankbot o el core de la IF. No olvides que tendrás que presentar un prototipo para la IF dentro de tu Aplicación para probarlo y decidir si es lo que buscan.

¡Mucha Suerte!

 

Empieza a Testear con un Postman Collection

¡Calentando!

Una vez que te hayas suscrito con éxito a un conjunto seleccionado de APIs o hayas sido Aprobado para una Necesidad, estás listo para empezar a hacer pruebas con un Postman Collection. Te proporcionamos un par de Postman Collections separadas por Grupos de APIs, Casos de Uso, o incluso por Institución, para que puedas elegir la que más te convenga. Elige una, descargala, revisa la documentación como guía y ¡empieza a testear!

 

Para empezar a realizar pruebas debes:

  • Ir a APIs en el menú principal
  • Seleccionar la tarjeta de la API y darle la vuelta con un clic
  • Hacer clic en Ver API en la tarjeta seleccionada
  • Ir a Overview y en la parte superior derecha puedes seleccionar el Postman Collection de la Institución que estás buscando 
  • Hacer clic en el botón de descarga para obtener tu Postman Collection
  • Importarlo a Postman una vez que lo tengas descargado
  • Hacer clic en la colección, ir a las variables, y cambiar la «key & secret» que se le dio a tu Solución
    • Para obtenerlos, ve a Servicios > Suscripciones al Gateway, selecciona tu solución y obtén la Consumer Key y Consumer Secret
  • La institución debe proporcionarte un nombre de usuario y una contraseña para el «cliente» o la cuenta con la que vas a realizar la prueba
  • Asegúrate de que la variable del proveedor coincide con la institución a la que intentas integrarte 
    • Si no estás seguro de tener esa variable correctamente, siempre puedes ponerte en contacto con el administrador del portal 
  • Una vez que tengas todas las variables configuradas correctamente, puedes empezar a hacer pruebas. Ejecuta la API de «Authorize» para generar la aplicación, tu solución y el token de acceso
  • A continuación, ejecuta la API de «Create Access Token» para generar el token de acceso del cliente que te proporcionó tu institución
  • Ahora puedes ejecutar cualquier API que selecciones

 

Si tienes algún problema o duda en relación con la Postman Collection o la Documentación, no dudes en ponerte en contacto con nosotros en support@finconecta.com

Realiza una llamada a la API

¡Empiece a testear!

¡Ahora comienza la parte divertida! Empieza a construir con BankBot, nuestro simulador de datos bancarios.

En el momento de la integración, te sugerimos que sigas la documentación de las APIs y realices una llamada a través de HTTPS a una API autorizada. La plataforma admite la autenticación de cliente OAuth2 para generar un token de acceso que sólo será válido durante un tiempo limitado. Este token de acceso le permite realizar una llamada, como una transferencia o una consulta de cuenta. En cuanto el token de acceso caduque, tendrá que volver a solicitarlo.

Para empezar a integrar, debes revisar qué información tienes disponible para testear. Para ello, puedes utilizar nuestro Bankbot.

Desde el menú principal, ve al simulador Bankbot. Aquí podrás encontrar datos sintéticos de «Clientes» y «Transacciones«. En «Clientes» encontrarás conjuntos de datos «ficticios» proporcionados por la Institución a la que estás suscrito, y en «Transacciones» podrás encontrar las diferentes operaciones correspondientes a los «Clientes» creados. Los grupos de datos pueden filtrarse según el tipo de transacción, como pagos, depósitos o transferencias. Considera Bankbot como un banco real donde puedes probar tu solución a través de nuestras APIs sin tener que pasar por integraciones reales y sin ninguna repercusión si ocurre algo.

Nuestra documentación de la API te enseñará a saber cómo formatear las llamadas HTTPS. Completa la información requerida y podrás iniciar el proceso de construcción de su aplicación en un ambiente controlado.

Si no puedes encontrar la información sobre clientes o transacciones que necesitas para probar tu solución o tienes dudas acerca de nuestra documentación, ¡déjanos saber! Puedes abrir un Ticket, ve a Servicios > Tickets y pregunta lo que necesites o ponte en contacto con nosotros vía correo electrónico. 

Revisa las Transacciones bajo “Metricas”

Monitorea tus llamadas API

Para asegurarnos de que tu y la institución financiera pueden ver las llamadas API, les proporcionamos Métricas así pueden revisar sus llamadas API.

 

En el menú de la barra lateral, haz clic en Métricas. Simulador muestra las transacciones con Bankbot, Sandbox te mostrará tus llamadas a la API una vez que esté integrado con el core de la institución en un ambiente de pruebas, y Producción le mostrará las llamadas reales a la API con el core de la institución.

 

En Métricas, podrás filtrar por «API«, «Servicios«, «Solución» o «Rango de fechas«, dependiendo de lo que quieras ver, puedes filtrar más en un periodo de tiempo específico, es decir, por Año o por Mes. También se mostrarán las soluciones más activas. Por último, pero no menos importante, en un gráfico, también puede comparar todas sus llamadas a la API, tanto las realizadas con Éxito como las Fallidas.

Cuando termines la etapa de pruebas con Bankbot y en el Sandbox, nuestro equipo te dará todo el apoyo que necesites para llevar la aplicación a producción. 

¡No olvides que estamos aquí para ayudarte en todo lo que podamos!

Empezar a Transaccionar con el Core de una Institución Financiera

¡Ahora estás listo para conectarte al Core de un Banco!

Una vez que hayas probado tu solución con Bankbot y estés seguro de que las APIs le funcionan, puedes solicitar la integración al core de un banco. O tal vez una institución financiera vio tu Solución, revisó tu perfil, vio tus llamadas a la API en las Métricas y, ¡decidió ponerse en contacto contigo porque le gustó lo que vio!


Sea cual sea el caso, ya estás listo para integrarte a un verdadero Core, no más Bankbot. Para ello, hay dos opciones, como se mencionó anteriormente.

 

Si quieres integrarte a un core y solicitarlo por tu cuenta, sigue los siguientes pasos:

    • Haz click en APIs en el menú principal de la barra lateral
    • Ve a Mis APIs y selecciona la tarjeta de la API a la que desea solicitar acceso
    • Una vez que hayas dado la vuelta a la tarjeta, haz clic en Core Banking Selection
    • Selecciona la Institución Financiera a la que quieres integrarte
      • Aquí puedes tener varias opciones para seleccionar, podrás ver a qué core estás ya aprobado, está pendiente de aprobación o está disponible para solicitar acceso
      • Una vez que elijas el core, la Institución Financiera recibirá un correo electrónico para aprobar o rechazar la solicitud.
    • Se te notificará sobre cómo obtener un código de proveedor para el core de la IF.
  • APIs > Mis APIs > Haz clic en la tarjeta de la API a la que solicitaste acceso y selecciona el core al que deseas integrarte, el código se encuentra en el reverso de la tarjeta

La otra opción es si el Portal Owner te da acceso a el core  directamente. Como se mencionó anteriormente, si ya han revisado tu Solución y quieren que te integres a su core, pueden darte acceso a él. Recibirás una notificación sobre cómo conseguirlo, y podrás obtener el código de Proveedor/Entidad una vez que te hayan aprobado para utilizarlo como variable para tu integración.

 

No olvides que las APIs y la documentación pueden ser diferentes para Bankbot en comparación con la Institución Financiera a la que estás tratando de integrarte. Comprueba siempre la documentación y si tienes alguna duda, ¡recuerda que tu Portal Owner y FinConecta estamos aquí para ayudarte!

¡Buena suerte en la integración! Esperamos que esta guía te haya sido útil.

¿Sigues Perdido y Quieres Más Ayuda?

Necesitas más información? Por favor solicite nuestro Manual de Proveedor de soluciones para guiarlo a través de la plataforma de Finconecta.

Support