Guía del Desarrollador

Bienvenido al Portal del Desarrollador

 

Registrarse es muy sencillo!

 

Our APIs have been designed to accommodate your needs and have proven to be successful in multiple use cases, enabling innovative business opportunities. We provide clear and simple documentation to facilitate your integration.

Registro

¿Nuevo en el Portal?

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

 

If your company has not been registered, you’ll get the option to select your type of Entity. Select "Proveedor de Soluciones" (como una 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

  • Escriba el nombre de la empresa en el campo designado.
  • Selecciona la opción: “The company does not exist, let’s create it.”

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 "Información de la Empresa,” “Perfil de la Empresa, " e "Información Adicional” sections

Información de la Solución

  • Añada información sobre el producto o productos que desarrollaste en la sección " Información sobre la Solución.” 
  • Tell us all about your Solutions! Only fields marked with a star are mandatory, but we suggest you provide as much information as possible so that everyone can better understand your product.

 

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

 

Before your registration gets approved, your information has to be reviewed by our team. As a developer, once you have this access authorization, you will be able to have visibility over the platform functionalities according to your role, “ENTITY_ADMIN” es el rol que recomendamos. 

Also, now that you are approved you have been automatically assigned 5 Customers and Transactions from Bankbot to start testing your Solution and the APIs.

Nuestras APIs

¿Listo para integrarte en nuestro ambiente Sandbox?

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

In the sidebar under APIs, you can find all our APIs, browse our API Catalog, check the categories or even manage your APIs. To start using them, click on the card you want and select “Request Approval.” The Portal Administrator will get notified and will have to approve your request before using the API, but you can still check the API Documentation.

 

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.
  • On the selected card click on
    • Request Approval to let the Portal Administrator know that you want to use the API, they’ll have to approve it before you can start to use it.
    • Ver API to check all the APIs documentation, examples, and errors, or even download Postman Collections to start testing them. By default, you will be reviewing a testing environment documentation, Bankbot’s. In the upper right corner, you can choose which documentation you want to see.
  • 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.

The application ID and Secret key are unique and private credentials that allow FinConecta to safely identify your app in the Portal and no compartas esta información con personas no autorizadas.

 

To use any API, first, you will need to call the Autorizar API, so we can recognize that you have access to the platform and your solution has been approved. Next comes the Create Access Token API, which we use to make sure the credentials you are using as a customer are valid.

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ú, busque la sección de Necesidades section. There, you can see all the needs posted within your portal. Go, explore, and find something that looks interesting to you and your company, or that you think your Solution would be a good fit for. 

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 
  • On “More Information,” you’ll find an Overview of this Necesidad, the requirements, the recommended APIs, and a section to check your Application
  • Haz click en "Aplicar para resolver la necesidad" en la tarjeta o en la parte superior derecha de la información de la Necesidad’s information and complete the application form
    • Your Application will be reviewed by the Financial Institution that posted this need/challenge, if they find your application a good match for what they are looking for, you’ll get an email notification.
    • 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 de “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 Institución Financiera. No olvides que tendrás que presentar un prototipo para está dentro de tu Aplicación para probarlo y decidir si es lo que buscan.

Best of luck!

Empieza a Testear con un Postman Collection

¡Calentando!

Once you have successfully subscribed to selected APIs or been Approved for a Necesidad, you are ready to start testing with a Postman Collection. We provide you with a couple of Postman Collections separated by API Groups, Use Cases, or Institutions, so you can choose what suits you best. Choose one, download it, check the documentation as a guideline, and start testing!

 

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 
  • En la tarjeta seleccionada, hacer clic en Ver API
  • 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 with the one given to your Solution
    • To get them, go to Services > Gateway Subscriptions, select your solution and get the Consumer Key and Consumer Secret
  • The Institution should provide you with a username and a password, for the “customer” or account that you would be testing with
  • Asegúrate de que la variable del proveedor coincide con la institución a la que intentas integrarte. 
    • If you are not sure if you have that variable right, you can always contact the Portal Administrator 
  • Once you have all the variables set correctly, you can start testing. Run the Autorizar API to generate the application, your solution, and access token
  • A continuación, ejecuta la API de Create Access Token para generar el token de acceso del cliente que te proporcionó tu institución
  • Now you can run any API that you select

 

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.

To start integrating, you must check what information you have available to test. To do this, you can use our 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.

 

If you cannot find the information about customers or transactions, you need to test your solution, or have any inquiries regarding our documentation, just let us know! You can open a ticket, go to Servicios > Tickets and ask away, or just contact us via email.

Revisa las Transacciones bajo "Metricas"

Track your API calls

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. 

On the sidebar Menu, just click on Métricas. Simuladores Bancarios shows transactions with Bankbot, Sandbox will show you your API calls once integrated with the Institution’s core in a testing environment, and Producción will show you actual API calls with the Institution’s core.

Under Metrics, you will be able to filter by “API," "Target”, “Solución," o"Date Range”  depending on what you want to see, you can filter further in a specific period, i.e. by Year o by Month. Top solutions, the most active ones, will also be displayed. Last but not least, you can also compare all your Successful and Failed API calls in a graph.

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.  

 

Do not forget that we are here to help you with whatever we can!

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! 

Whatever the case, you are ready now to integrate into an actual Core, no more Bankbot. To do so, there are two options, as mentioned before.

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
  • Ir 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
    • Here you might have multiple options to select, and you’ll be able to see which core you are already approved to, pending approval, or available to request access
    • Once you select a core, the Financial Institution will get an email to approve or reject the request
  • Se te notificará sobre cómo obtener un código de proveedor para el core de la Institución Financiera.
  • APIs > Mis APIs > Click on the API card you requested access to and select the core that you want to integrate to, the code is on the back of the card

The other option is if your Portal Owner gives you access to it directly. As mentioned above, if they have already checked your Solution and want you to integrate it into their core, they can give you access. You will get a notification on how to get it, and you can get the código de Proveedor/Entidad una vez que te hayan aprobado para utilizarlo como variable para tu integración.

Do not forget that the APIs and the documentation might be different for Bankbot compared to the Financial Institution you are trying to integrate into! Always check the documentation, and if you have any doubts, remember that your Portal Administrator and FinConecta are here to help you!

¡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 Solution Provider Manual to walk you through FinConecta‘s platform.

Soporte