Esta funcionalidad permite realizar una llamada de tipo GET a una api.
¿Para qué sirve?
Los llamados a los métodos GET en una API se utilizan para obtener información o datos de un servidor sin realizar cambios en los mismos. Estas solicitudes son seguras y se envían a través de la URL, a menudo con parámetros de consulta.
Antes de empezar
Antes de utilizar esta funcionalidad, es necesario instalar Postman y realizar algunas configuraciones iniciales en el sistema.
- Verificamos que el usuario que vamos a utilizar para realizar las llamadas tiene las credenciales necesarias para comunicarse con la API. Para esto nos vamos a dirigir a Configuración → General → Usuarios y vamos a seleccionar el usuario.
- Una vez que elegimos el usuario debemos verificar que tiene las Keys o credenciales para comunicarse con las APIs.
3. Si el usuario que elegimos, no tiene permisos las credenciales estarán vacías y las tendremos que generar.
Modo de uso
- La ruta para acceder a la documentación de las Api es la siguiente.
Configuración → Diseño del espacio de trabajo → Diccionario de APIs → Documentación → API de la transacción.
Nos va a dirigir a esta página, en donde vamos a poder ver todas las APIs que están disponibles y los métodos que podemos utilizar en cada una.
- Primero debemos generar un token válido para realizar las peticiones, esto se consigue en la parte de Autenticación OAuth 2.0
- Copiamos esa dirección url en Postman para poder generar el token.
3.1. Los campos {$clientid} y {$secretkey} son las credenciales que verificamos o generamos, en caso de que no estuvieran, al seleccionar el usuario que vamos a utilizar.
- Una vez obtenido el token, ya podemos utilizarlo para realizar las llamadas a los métodos GET de una transacción como es el caso de las Cobranzas.
- En este caso tenemos dos métodos GET disponibles para utilizar en la API de cobranza. Para realizar las llamadas en postman debemos copiar el URL que se encuentra en la descripción del método.
Luego debemos reemplazar la información que necesitamos, en este caso el código, que indica el código de la transacción de la cual queremos obtener los datos y el token generado con las credenciales.
NOTA: Se deben eliminar también las llaves que encierran la palabra {codigo}.