Integración Api Externo de OasisCom

Documentacion

INTEGRACIÓN A OASISCOM POR MEDIO DE API

La interfaz de conexión es un servicio RESTful que utiliza el método POST y ofrece un conjunto de endpoints HTTPS fáciles de usar. Esta API recibe sus parámetros mediante un objeto MultipartFormDataContent, el cual permite enviar datos como usuarios, publicaciones y otros elementos, además de soportar la consulta y actualización de información.

Datos de configuración

Para el uso correcto de los servicios es importante que se suministres algunos datos en la construcción de la petición.

Parametros Descripción
Conexión Ambiente Base de Datos donde prodremos realizar las consultas y/o subidas de información (Dato proporcionado por OasisCom)
Código empresa: Código unico por Empresa con el cual podremos realizar las consultas y/o subidas de información (Dato proporcionado por OasisCom)
Código publicación: Publicación que cotiene estructura y logica usada en el proceso de Consulta y/o Subida de informacón (Dato proporcionado por OasisCom)
FileBase64 Si es necesario subir datos en archivos XML o JSON, estos deben convertirse a una cadena en formato Base64. Para ello, puede utilizar un conversor que facilite este proceso
token: El código generado mediante el servicio de autenticion proporcionado por OasisCom

El EndPoint estara estructurado de la siguiente manera

POST https://app.oasiscom.com/api/externalservices/{conexión}/{código_empresa}/{código_publicación}

Ejemplo

Nota: Este código es un ejemplo ilustrativo de la conexión al servicio y no está diseñado para uso funcional en producción.

var settings = {
  url: "https://app.oasiscom.com/api/externalservices/{conexión}/{código_empresa}/{código_publicación}",
  method: "POST",
  timeout: 0,
  headers: {
    "Content-Type": "application/x-www-form-urlencoded",
  },
  data: {
    token: "{token}",
    FileBase64: "{fileBase64}",
  },
};

$.ajax(settings).done(function (response) {
  console.log(response);
});

Ejemplo usando herramienta Postman

Uso del EndPoint en Postman

Ejemplo de respuesta correcta

NOTA: Segun el EndPoint que se este usando puede variar los parametros de la URL y de la estructura de la petición. Como tambien los mensajes de control de respuesta.

Ejmplo de esctructura de subida de datos Tipo XML

<?xml version="1.0"?>
<ROWS xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
	<OPERATIONS>
		<VENDOR>
			<COMPANYID>1</COMPANYID>
			<CLIENTTYPE>C</CLIENTTYPE>
			<CLIENTID>1</CLIENTID>
			<CHECKDIGIT>1</CHECKDIGIT>
			<CLIENTNAME>VENDEDOR 1 </CLIENTNAME>
			<GEOGRAPHICLOCATIONID>1101</GEOGRAPHICLOCATIONID>
			<ADDRESS/>
		</VENDOR>
		<CLIENT>
			<COMPANYID>1</COMPANYID>
			<CLIENTTYPE>C</CLIENTTYPE>
			<CLIENTID>2</CLIENTID>
			<CHECKDIGIT>9</CHECKDIGIT>
			<CLIENTNAME>TERCERO PRUEBA </CLIENTNAME>
			<GEOGRAPHICLOCATIONID>1101</GEOGRAPHICLOCATIONID>
			<CELPHONE>7654321</CELPHONE>
			<ADDRESS>CALLE PRUEBA 1</ADDRESS>
			<EMAIL>correo@correo.com</EMAIL>
			<TAXTYPEID>107</TAXTYPEID>
		</CLIENT>
		<OPERATION>
			<COMPANYID>1</COMPANYID>
			<DOCUMENTID>PD</DOCUMENTID>
			<NUMBERID>0</NUMBERID>
			<LOCATIONID>1</LOCATIONID>
			<CONCEPTID>PD</CONCEPTID>
			<MOTIVEID>0</MOTIVEID>
			<DATE>02/04/2025</DATE>
			<HOUR>02/04/2025 19:12</HOUR>
			<CLIENTID>2</CLIENTID>
			<DIRECTIONID>0</DIRECTIONID>
			<VENDORID>1</VENDORID>
			<CURRENCYID>0</CURRENCYID>
			<STATE>A</STATE>
			<STATUS>R</STATUS>
			<TYPEPRICEID>1</TYPEPRICEID>
			<CONDITIONPAYMENTID>9</CONDITIONPAYMENTID>
			<WAREHOUSEID>1</WAREHOUSEID>
			<OBSERVATION/>
			<DELIVERYDATEMAX/>
			<PURCHASEORDER>PABIXRQL90KPM6041224193755</PURCHASEORDER>
		</OPERATION>
		<OPERATIONDETAIL>
			<COMPANYID>1</COMPANYID>
			<DOCUMENTID>PD</DOCUMENTID>
			<NUMBERID>0</NUMBERID>
			<LOCATIONID>1</LOCATIONID>
			<ROWID>1</ROWID>
			<PRODUCTID>1</PRODUCTID>
			<DESCRIPTION>DESCRIPCION</DESCRIPTION>
			<QUANTITY>4</QUANTITY>
			<PRICE>1000.00</PRICE>
			<TAXSALEPERCENTAGE>0</TAXSALEPERCENTAGE>
			<OBSERVATION/>
			<GIFT>false</GIFT>
		</OPERATIONDETAIL>
		<OPERATIONDETAIL>
			<COMPANYID>1</COMPANYID>
			<DOCUMENTID>PD</DOCUMENTID>
			<NUMBERID>0</NUMBERID>
			<LOCATIONID>1</LOCATIONID>
			<ROWID>2</ROWID>
			<PRODUCTID>2</PRODUCTID>
			<DESCRIPTION>DESCRIPCION</DESCRIPTION>
			<QUANTITY>1</QUANTITY>
			<PRICE>2000.00</PRICE>
			<TAXSALEPERCENTAGE>0</TAXSALEPERCENTAGE>
			<OBSERVATION/>
			<GIFT>false</GIFT>
		</OPERATIONDETAIL>
	</OPERATIONS>
</ROWS>

NOTA: El XML puede cambiar, según definición de la publicación y del proceso en particular.