¿Cómo hacer un método 'PUT' de una transacción?

jcolombo
Thu, 21 Dec 2023 15:23:49 +0000
API

Esta funcionalidad permite realizar una llamada de tipo PUT a una API.

¿Para qué sirve?

Los llamados PUT en una API se utilizan para modificar información o datos de un servidor. Estas solicitudes son seguras y se envían a través de la URL.

Antes de empezar

Antes de utilizar esta funcionalidad, es necesario instalar Postman y realizar algunas configuraciones iniciales en el sistema.

Descargar Postman: Download Postman | Get Started for Free

1. 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.

2. Una vez que elegimos el usuario debemos verificar que tiene las Keys o credenciales para comunicarse con las API.

3. Si el usuario que elegimos, no tiene permisos, las credenciales estarán vacías y las tendremos que generar.

Modo de uso

1. La ruta para acceder a la documentación de las API es la siguiente.

Configuración → Diseño del espacio de trabajo → Diccionario de API → Documentación → API de la transacción.

Nos va a dirigir a esta página, en donde vamos a poder ver todas las API que están disponibles y los métodos que podemos utilizar en cada una.

2. Primero debemos generar un token válido para realizar las peticiones, esto se consigue en la parte de Autenticación OAuth 2.0

3. 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.

4. Una vez obtenido el token, ya podemos utilizarlo para realizar las llamadas a los métodos PUT de una transacción, como es el caso de las Cobranzas.

5. Para realizar las llamadas en Postman debemos copiar el URL que se encuentra en la descripción del método PUT

Luego debemos reemplazar la información que necesitamos, en este caso el código, que vendría ser el Documento-interno de la transacción, que indica el código de la transacción, de la cual queremos modificar los datos y el token generado con las credenciales.

En la solapa Body, seleccionamos de tipo raw y de tipo JSON, vamos a agregar el JSON donde va a tener los atributos de la cobranza y hacer los cambios que queremos hacer (Importante tener en cuenta que los atributos que no agregamos los va a borrar, por eso es importante que los atributos que no queremos modificarlo de todas maneras tienen que estar en el JSON)

Apretamos Send y genera los cambios necesarios.