Integración a OasisCom con API

OasisCom - Documentacion

Ver en GitHub

INTEGRACIÓN A OASISCOM POR MEDIO DE API

La interfaz de conexión es un servicio RESTful web api 2 de tipo POST, el cual proporciona un conjunto fácil de usar de puntos finales HTTP quee recibe sus parámetros por medio de un objeto Content tipo “MultipartFormDataContent”, incluidos usuarios, publicaciones y más, además de que permite recuperar o actualizar datos.

Dicho objeto consta de los siguientes parámetros:

IMPORTANTE: Los paramétros descritos a continuación, son insumos proporcionados por OasisCom para la realización de la respectiva integración.

  • pArguments: Estos parametros pueden ser: informacion sobre la empresa, la publicación, el tipo de publicación y los argumentos requeridos por dicha publicación para arrojar un resultado idóneo. Se ingresan de la siguiente manera:

  • Compañía, el cual corresponde a un Id de dato tipo entero.
  • Publicación, la cual se parametriza desde la opción BARC (Archivos) y puede ser visualizada desde la opción BINT (Interfaces).
  • Tipo de publicación, la cual puede ser subida (S) o bajada (B).
  • Parámetros de la publicación, los cuales dependerán de la debida parametrización, por ejemplo el código del producto, o bien, el número del tercero pueden considerarse parámetros de entrada.

Ejemplo de argumentos: (1;1;S;1). Donde estos deben estar separados por ; (punto y coma). Tenga en cuenta que en este ejemplo solamente se muestra un parametro y pueden ingresarse muchos más. Cabe recordar que esto depende de la parametrización que se realice.

  • pFileBase64: Si se requiere subir un archivo, este campo almacenará el contenido del archivo en una cadena con formato Base64 estandar.

  • pFilename: Corresponde al nombre del archivo a ser subido con su respectiva extensión.

EJEMPLO DE CONEXIÓN EN C# (VISUAL STUDIO 2017)

Inicialmente se ingresa una variable de tipo HttpClient, donde dentro de ella se declara el objeto MultipartFormDataContent con sus respectivos argumentos y el archivo Base64 correspondiente. Nota: Debe tener en cuenta que en este ejemplo al ser un tipo de publicación de bajada (B) los parametros de los archivos estarán vacíos StringContent(““).

WEB API

A continuación se describirá una prueba ejecución del API desde la plataforma OasisCom

Por medio de la opción BAPI se realizan pruebas de servicios creados en OasisCom mostrando la respuesta en formatos .XML y .JSON:

  • En el campo Method Type se debe seleccionar la opción POST.
  • En el campo Resource debe ingresarse lo siguiente: api/oasisapi/executeinterface, lo cual indica el recurso a consumir por el API.
  • En el campo File Input, dependiendo del tipo de la publicación, si corresponde a Bajada no se adjuntará ningun archivo. De lo contrario, si corresponde a Subida si será necesario subir el archivo correspondiente.
  • En el campo EndPoint_, se deberá ingresar la dirección proviente del servicio, en este caso, _https://app.oasiscom.com.
  • En el campo Arguments, se ingresarán los parámetros de la manera descrita previamente.
  • En el campo UserName, de debe ingresar el nombre de usuario.
  • En el campo Password, se deberá ingresar la contraseña correspondiente.

Posteriormente, se dará clic en el botón Test Web Api:

Se puede ver el resultado al ejecutar el API.

Así pues de esta manera se realiza la integración a OasisCom a través de un API.