Uso del portal - Pruebas

Los portales de APIs, así como el Centro de Ayuda APIs internas está integrado con el directorio activo, por esta razón, los usuarios no requieren un registro o creación de una cuenta y cualquier persona con credenciales banco (correo + contraseña de red), puede acceder a cada uno de ellos. Inclusive nuestro método de autenticación es con Microsoft y con “Single SignOn”, esto quiere decir que si ya estás autenticado en otra de las herramientas de office, cuando ingreses al portal de APIs internas o Centro de Ayuda APIs internas, se tomará la autenticación que ya tienes activa y no tendrás que iniciar sesión nuevamente.

Para poder delegar la organización a otra persona, primero debes añadirlo como usuario a tu organización con algún rol, como administrador, desarrollador o visor; luego de que tenga acceso a tu organización puedes delegársela a este usuario. 

Si ya no estarás participando en el proyecto, equipo o presente en la organización, es muy importante que seas precavido y delegues la organización con tiempo a otro compañero del equipo para que puedan seguir gestionando las credenciales de las aplicaciones creadas bajo la misma, sin ningún inconveniente.

Se puede gestionar desde API Connect la delegación de una organización de una persona que ya no está a otro usuario, realizando la solicitud oficial mediante la generación de una OC que gestionará directamente el equipo de IBM, es importante que esta solicitud la realice directamente el responsable o líder técnico del equipo consumidor. 

Al final de este artículo puedes conocer los pasos para gestionar la OC.

Las aplicaciones te permiten obtener las credenciales necesarias para realizar consumos de productos API, también te permiten realizar y gestionar las suscripciones a los productos, ya que es necesario solicitar la suscripción antes de poder consumir un producto. Además en caso que requieras adjuntar un certificado digital.

Insomnia es una aplicación de software que se utiliza para probar y depurar APIs (Interfaz de Programación de Aplicaciones). Permite a los desarrolladores interactuar con APIs, enviar solicitudes HTTP, ver las respuestas, realizar pruebas de rendimiento y depurar problemas de comunicación entre aplicaciones.

Esta herramienta es valiosa para desarrolladores y equipos de desarrollo que trabajan en proyectos que involucran la creación y el uso de APIs, pues facilita la colaboración y permite verificar que estas funcionen según lo previsto. Algunas de sus características más relevantes son: permite configurar solicitudes, administrar colecciones de API, realizar seguimiento de historiales de solicitudes y respuestas, y realizar pruebas automatizadas, entre otras funciones.  

Podrás conseguir su versión gratuita aquí 

¿Cómo puedes probar nuestras API desde Insomnia? 

1. Crear proyecto 

Para crear un nuevo proyecto, debes ingresar a la aplicación y dar clic en el signo + ubicado en la pestaña projects, allí debes nombrar tu proyecto y dar clic en el botón crear. 

2. Desactivar SSL 

Realiza la desactivación del SSL para evitar errores durante el consumo de la API.  

• Da clic en application 

• Luego clic en preferences 

• Desactiva la casilla validate certificates 

3. Importa colecciones y firmas 

• Selecciona el proyecto que previamente se ha creado y en la parte derecha da clic en +.  Después dar clic en import

• Se abrirá una nueva ventana donde podremos seleccionar las colecciones previamente descargadas del portal API market 

• Selecciona la colección de tu interés y da clic en el botón scan 

• Llegarás a otra ventana donde podrás ver la información de la colección. Confirma dando clic en el botón import 

• La colección quedará agregada con el nombre por defecto Imported Workspace 

• Para personalizar el nombre de la colección dirígete a los 3 puntos que se encuentra en la parte superior derecha de la colección y da clic en rename. 

5. Autorización de solicitudes

Las API utilizan la autorización para garantizar que las solicitudes de los clientes accedan a los datos de forma segura. Esto puede implicar la autenticación del remitente de una solicitud y la verificación de que tiene permiso para acceder o manipular los datos relevantes. 

En nuestras APIs podrá encontrar el método de autorización en los parámetros de seguridad.  Estos son Oauth2.0 (Authorization) o JWT.

5. Realizar consumo

•  Configuración campos de token 

En el apartado AUTH TYPES debes escoger la opción OAuth 2 

Completa los campos con la información correspondiente: 

• Grant type: Client Credentials 
• Access token url: Aquí se ingresa el endpoint del token (Información que podrás encontrar en el portal API market) 
• client ID: Identificador único proporcionado al momento de registrar la aplicación en el portal API market 
• Client secret: Clave confidencial proporcionada junto con el Client ID al momento de registrar la aplicación en el portal API market 
• En la parte inferior del campo client secret se encuentra la pestaña Advanced Options. Al desplegar, encontrarás un campo que debes llenar con la información del scope (ten en cuenta que cada API cuenta con su propio scope. Esta información la puedes verificar previamente en el API market) 

• Para obtener el token, da clic en el botón Fetch Tokens que encontrarás en la parte inferior (cada token tiene una vigencia de 20 minutos) 

• En la casilla access token obtendrás el token generado  

• Ubícate en la pestaña Headers y verifica que estén todos asignados según la firma y la documentación del portal API market 

• Ubícate en la pestaña Other o JSON y revisa que estén todos los campos asignados con los valores a probar.

• En la casilla POST debes ingresar el End Point perteneciente a la API que quieres probar (puedes consultar distintos End Points en la documentación del portal API market) 

• Da clic en el botón send 

• En la parte derecha obtendrás la respuesta de la petición  

¡Excelente! Ahora que has consumido tu API, estás un paso más cerca de desbloquear un mundo de posibilidades. No dudes en repetir este proceso para explorar y aprovechar diversas APIs y enriquecer tus aplicaciones con datos y funcionalidades sorprendentes. El universo de las APIs está repleto de recursos por descubrir, así que ¡adelante y sigue explorando! 

Primero debemos buscar el producto y su API, haremos un ejemplo con el producto Accounts y la API de Fund Transfers:

Desplazamos la página hacía abajo y consultamos las operaciones:

Seleccionamos la primera y hay que revisar los apartados de seguridad y Header:

En el apartado de seguridad se indica que es necesario enviar client id y client secret como cabeceras de la petición; adicional en el apartado de header se nos indica que requiere de un JWT y un Certificado para poder consumir.

Un ejemplo con otro producto, en este caso Electronic Signature - Composite Signature, igualmente revisamos los apartados de seguridad y header:

El apartado seguridad solamente nos pide client id y secret, pero ahora en el apartado de header adicional nos pide un usuario y token.