bhexpress 1.1.0

BHExpress: Cliente de API en C#

Cliente para realizar la integración con los servicios web de BHExpress desde C#.

Instalación y actualización

Instalación mediante el Administrador de Paquetes NuGet

1. Abre tu proyecto en Visual Studio.

2. Haz clic derecho en el proyecto en el Explorador de Soluciones y selecciona "Administrar paquetes NuGet...".

3. En la pestaña "Examinar", busca bhexpress.

4. Selecciona el paquete bhexpress y haz clic en "Instalar".

Instalación desde la línea de comandos (cmd)

1. Abre la línea de comandos desde Herramientas, Administrador de paquetes NuGet, Consola del administrador de paquetes.

2. Ejecuta el siguiente comando para instalar bhexpress:

    nuget install bhexpress

Modo de uso

Se recomienda ver los ejemplos para más detalles. Lo que se muestra aquí es sólo una idea, y muy resumida:

Lo más simple, y recomendado, es usar una variable de entorno con el token del usuario, el cual será reconocido automáticamente por el cliente:

using bhexpress.api_client;
using System.Net.Http;
using System.Collections.Generic;

Boletas boleta = new Boletas();
// Encabezado contiene la información de la boleta, del emisor y del receptor.
// Detalle contiene una lista con el detalle de los items.

HttpResponseMessage response = boleta.ListadoBhe(); // Respuesta del cliente de API.

var jsonResponse = response.Content.ReadAsStringAsync().Result; // Resultado convertido en JSON
Dictionary<string, object> resultado = JsonConvert.DeserializeObject<Dictionary<string, object>>(jsonResponse); // Resultado convertido en diccionario.

Lo que hizo el ejemplo anterior es listar boletas emitidas en un resultado.

Pruebas

Las tres variables de entorno a continuación son un requisito tanto para las pruebas como para el software que desees hacer usando el cliente de API.

Si deseas usar el cliente de la API, debes tener las siguientes variables de entorno creadas. En Windows 10, se hace con:

set BHEXPRESS_API_URL="https://bhexpress.cl"
set BHEXPRESS_API_TOKEN="" # aquí el token obtenido en https://bhexpress.cl/usuarios/perfil#token
set BHEXPRESS_EMISOR_RUT="" # aquí el RUT del emisor de las BHE

Lo siguiente aplica para el proyecto "tests" que está disponible en el repositorio de GitHub:

• Para probar la aplicación, deberás tener el paquete incluído en tu programa. Haz click en "Ver" y selecciona "Explorador de pruebas".

• Renombra la clase y el constructor en "TestEnv_dist.cs" como "TestEnv".

• Define todas las variables dentro de "TestEnv_dist.cs".

• Ejecuta las pruebas en el siguiente orden (asegúrate de tener las variables de entorno definidas en "TestEnv_dist.cs"):

  1. Todos o algunos de los test con el prefijo "TestListadoBoletas"
  2. TestEmitirBoleta
  3. TestPdfBoleta
  4. TestEmailBoleta
  5. TestAnularBoleta

Consejos para las pruebas:

• Ejecuta las pruebas una por una.
• Define el número de la BHE por anular como la BHE que vayas a emitir. Así no quedas con una BHE emitida esperando a ser cobrada.
• Revisa en test/bin/debug/ el PDF que hayas emitido con las pruebas.
• Revisa el email que hayas definido para "TestEmailBoleta". Allí va a llegar la BHE que hayas emitido luego de ejecutar la prueba.

Licencia

Este programa es software libre: usted puede redistribuirlo y/o modificarlo bajo los términos de la GNU Lesser General Public License (LGPL) publicada por la Fundación para el Software Libre, ya sea la versión 3 de la Licencia, o (a su elección) cualquier versión posterior de la misma.

Este programa se distribuye con la esperanza de que sea útil, pero SIN GARANTÍA ALGUNA; ni siquiera la garantía implícita MERCANTIL o de APTITUD PARA UN PROPÓSITO DETERMINADO. Consulte los detalles de la GNU Lesser General Public License (LGPL) para obtener una información más detallada.

Debería haber recibido una copia de la GNU Lesser General Public License (LGPL) junto a este programa. En caso contrario, consulte GNU Lesser General Public License.

Enlaces

• Sitio web BHExpress.
• Código fuente en GitHub.
• Paquete en NuGet.