Para probar el funcionamiento de las APIs y el correcto armado de los archivos XML requeridos en cada una de ellas, se sugiere utilizar las siguientes herramientas:
- Base64Encode: https://www.base64encode.org/
- Notepad++: https://notepad-plus-plus.org/
- Postman: https://www.getpostman.com/apps
Procedimiento
1.- Codificar los parámetros
En primer lugar, ingrese al sitio https://www.base64encode.org/ para codificar los parámetros necesarios para la comunicación de la API.
Una vez en el sitio:
- Verifique que esté seleccionada la opción “Encode” (Codificar).
- En la parte superior de la página llene los atributos y valores de los parámetros de comunicación, de acuerdo a la documentación de la API específica que utilizará (puede pegarlos del portapapeles si los llenó en otra aplicación, como por ejemplo Bloc de notas).
- Pulse el botón “>ENCODE<” (Codificar)
- Copie la cadena resultante de la parte inferior de la página.
El resultado debe verse como en la siguiente imagen:
El resultado de esta conversión será utilizado más adelante, por favor guarde la cadena o mantenga abierta la página.
2.- Armar el archivo XML
Para elaborar el archivo XML se recomienda el uso del programa gratuito Notepad++, el cual puede descargar del siguiente enlace: https://notepad-plus-plus.org/
Este programa, además de ligero y amigable, permite configurar el uso de distintos lenguajes, entre ellos XML, para mayor facilidad de uso.
Puede utilizar este programa para elaborar el XML requerido por el método POST, de acuerdo a la documentación proporcionada para cada API.
3.- Enviar el POST
Una vez concluidos los pasos anteriores, está listo para probar el envío del método POST, por lo que deberá descargar(*) el programa Postman si aún no lo ha hecho, el enlace es: Download Postman | Get Started for Free
(*) También es posible instalar Postman como una extensión del navegador Google Chrome, pero el propio desarrollador recomienda usar la aplicación de escritorio, ya que la Chrome App será descontinuada en el futuro próximo. Fuente: Going native | Postman Blog
Cuando haya concluido la instalación de Postman, realice lo siguiente:
- Cierre la ventana de Inicio, y en ventana principal del programa, en la pestaña nueva del lado derecho, seleccione el método POST
- En el siguiente espacio pegue la URL proporcionada por SiNube.
- Haga clic en el botón “Params”. En la columna “key” escriba la palabra “par” (sin comillas), y en la columna “Value” pegue la cadena resultante de codificar los parámetros de conexión en Base 64 en el paso 1 de este tutorial.
- Pulse sobre la sección “Body” y ahí haya clic sobre el botón radial “binary”. Luego haga clic sobre el botón “Elegir archivo” y seleccione en su disco duro el archivo XML del cuerpo de la API, conforme al paso 2 de este tutorial. También es posible usar la opción “raw”, seleccionar el tipo de archivo “XML” y usar el editor propio de Postman, pero este tiene menos funciones.
- Cuando haya realizado los pasos anteriores, haga clic en el botón “Send”, para enviar el método POST con el archivo XML.
A continuación, la ventana mostrará el resultado del envío del POST. Si la URL de comunicación, los parámetros codificados y el archivo XML son correctos, la ventana se verá semejante a la siguiente imagen.
Anteriormente existía la posibilidad de instalar Postman como una extensión del navegador Google Chrome, pero esa opción ya ha sido deprecada o descontinuada.
Si utiliza el IDE Visual Studio Code, opcionalmente puede utilizar la extensión Thunder Client del mismo como alternativa a Postman.
Confiamos que la información anteriormente expuesta sea de utilidad durante la implementación y puesta en marcha de las APIs que permiten la comunicación de aplicaciones externas con SiNube.