API Client: Uso y ejemplos

Existen actualmente dos implementaciones de la libreria APIClientBOS, una en PHP y otra en ASP.NET. Esta libreria es la encargada de autenticar todos los pedidos y operaciones que se realicen a la API utilizando el KEY para autenticar.
 

PHP

La libreria de PHP se puede descargar desde el siguiente link: APIClientPHP v1.0

La misma se utiliza haciendo el  include del archivo “APIClientBOS.php” y luego utilizando la clase “APIClientBOS“

Codigo de ejemplo para buscar productos por la categoria con Id “199”
<?php
require_once 'APIClientBOS.php';
 
$apiClient = new APIClientBOS('<KEY>', '<URL>');
 
$data = $apiClient->ExecuteGET('Productos/ListaProductos.aspx', array('ProductosCategoriaId' => '199'));
print_r($data);
?>
 

APIClientBOS: Metodos

function ExecuteGET($path, $parametros): stdClass Object
Esta funcion realiza un GET utilizando el path indicado y los parametros provistos como querystring, y retorna el resultado en un objeto. Los parametros deben ser enviados como un array de clave/valor.

function ExecutePOST($path, $parametros): stdClass Object
Esta funcion realiza un POST utilizando el path indicado y enviando un json construido a partir de los parametros provistos, retorna el resultado en un objeto. Los parametros deben ser enviados como un array de clave/valor.

function ExecutePUT($path, $parametros): stdClass Object
Esta funcion realiza un PUT utilizando el path indicado y enviando un json construido a partir de los parametros provistos, retorna el resultado en un objeto. Los parametros deben ser enviados como un array de clave/valor.

function ExecuteDELETE($path, $parametros): stdClass Object
Esta funcion realiza un DELETE utilizando el path indicado y los parametros provistos como querystring, y retorna el resultado en un objeto. Los parametros deben ser enviados como un array de clave/valor.

ASP.NET

La libreria de ASP.NET se puede descargar desde el siguiente link: APIClientNET v1.0

La misma se utiliza incluyendo en Referencias la libreria Cylarcom.BOS.Client.APIClient” y luego utilizando la clase “APIClientBOS“

Codigo de ejemplo para buscar productos por la categoria con Id “199”
APIClientBOS api;
JToken obj;
Dictionary<string, string> parametros;
 
api = new APIClientBOS("<KEY>", "<URL>");
 
parametros = new Dictionary<string, string>();
parametros.Add("ProductosCategoriaId", "199" );
 
obj = api.ExecuteGET("Productos/Producto.aspx", parametros);
Response.Write(obj.ToString());
 

APIClientBOS: Metodos

JToken ExecuteGET(string path, Dictionary<string, string> parametros)
Esta funcion realiza un GET utilizando el path indicado y los parametros provistos como querystring, y retorna el resultado en un JToken.

JToken ExecutePOST(string path, JToken data)
Esta funcion realiza un POST utilizando el path indicado y enviando un json con la data provista, retorna el resultado en un JToken.

JToken ExecutePUT(string path, JToken data)
Esta funcion realiza un PUT utilizando el path indicado y enviando un json con la data provista, retorna el resultado en un JToken.

JToken ExecuteDELETE(string path, Dictionary<string, string> parametros)
Esta funcion realiza un DELETE utilizando el path indicado y los parametros provistos co