Skip to content

Commit 1940537

Browse files
SantiagoFiolSantiagoFiol
committed
Se añadieron las insignias al index.rst principal. Se añadió un enlace a la página principal de la documentación al README.md. Se eliminó el desgloce de ejemplo en example, y se reemplazó el ejemplo utilizado de listar por emitir una BHE. Se corrigió ci.yml.
1 parent d93487e commit 1940537

4 files changed

Lines changed: 103 additions & 53 deletions

File tree

‎.github/workflows/ci.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ jobs:
3030
- name: Create temporary env file
3131
run: |
3232
echo "BHEXPRESS_API_TOKEN=${{ secrets.BHEXPRESS_API_TOKEN }}" >> tests/test.env
33-
echo 'BHEXPRESS_EMISOR_RUT="76192083-9"' >> tests/test.env
33+
echo "BHEXPRESS_EMISOR_RUT=${{ secrets.BHEXPRESS_EMISOR_RUT }}" >> tests/test.env
3434
3535
- name: Run PHP tests read only
3636
run: |

‎README.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ BHExpress: Cliente de API en PHP
1212

1313
Cliente para realizar la integración con los servicios web de [BHExpress](https://www.bhexpress.cl) desde PHP.
1414

15+
Revisa la [documentación](https://api-client-php.docs.bhexpress.cl/guide/index.html) de la biblioteca para más información, sus características y detalles de su uso.
16+
1517
Licencia
1618
--------
1719

‎docs/getting-started/example.rst‎

Lines changed: 85 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -1,70 +1,103 @@
11
Ejemplo
22
=======
33

4-
El siguiente es un ejemplo básico de cómo obtener un listado de documentos BHE utilizando el cliente de API.
5-
6-
.. code-block:: php
7-
<?php
8-
9-
# Definición de directorio autoload. Necesario si se usa la versión de GitHub.
10-
require_once __DIR__ . '/vendor/autoload.php';
11-
12-
# Importaciones del cliente de API de BHExpress
13-
use bhexpress\api_client\ApiClient;
14-
15-
# Instanciación de cliente de API
16-
$client = new ApiClient();
17-
18-
# Periodo de búsqueda de BHEs
19-
$periodo = '202407';
20-
# Recurso a consumir
21-
$url = '/bhe/boletas?periodo='.$periodo;
22-
23-
# Respuesta de la solicitud HTTP
24-
$response = $client->get($url);
25-
26-
# Impresión de código de estado y BHE pertenecientes al periodo.
27-
echo "\n", $response->getStatusCode();
28-
echo "\nLISTA BOLETAS: \n";
29-
echo "\n",$response->getBody(),"\n";
30-
31-
Desgloce de ejemplo
32-
-------------------
33-
344
Para utilizar el cliente de API de BHExpress, deberás tener definido el token de API y el RUT del emisor como variables de entorno.
355

366
.. seealso::
377
Para más información sobre este paso, referirse al la guía en Configuración.
388

39-
Al momento de integrar el cliente de API con tu programa, debes importar el cliente e instanciarlo.
9+
El siguiente es un ejemplo básico de cómo emitir una BHE utilizando el cliente de API.
4010

4111
.. code-block:: php
12+
<?php
13+
14+
# Definición de directorio autoload. Necesario si se usa la versión de GitHub.
15+
require_once __DIR__ . '/vendor/autoload.php';
16+
4217
# Importaciones del cliente de API de BHExpress
4318
use bhexpress\api_client\ApiClient;
4419
45-
# Instanciación de cliente de API
20+
# Instancia de cliente.
4621
$client = new ApiClient();
47-
48-
Luego, se definen los parámetros a utilizar.
49-
50-
.. code-block:: php
51-
# Periodo de búsqueda de BHEs
52-
$periodo = '202407';
53-
# Recurso a consumir
54-
$url = '/bhe/boletas?periodo='.$periodo;
55-
56-
Más adelante, se ejecuta la solicitud HTTP y se guarda en una variable llamada ``$response``. Response contiene la información de la respuesta HTTP, desde el código de estado, hasta las cabeceras y el cuerpo (si es que tiene).
57-
58-
.. code-block:: php
59-
# Respuesta de la solicitud HTTP
60-
$response = $client->get($url);
61-
62-
Y al final de todo, se despliega el cuerpo de la respuesta en consola, junto con su código de estado.
63-
64-
.. code-block:: php
65-
# Impresión de código de estado y BHE pertenecientes al periodo.
22+
# RUT del emisor.
23+
$emisor_rut = "12345678-9";
24+
# Fecha de emisión de BHE.
25+
$fecha_emis = date('Y-m-d');
26+
# Recurso a consumir.
27+
$url = '/bhe/emitir';
28+
29+
# Datos de la boleta a ser emitida.
30+
$datos_boleta = [
31+
'Encabezado' => [
32+
'IdDoc' => [
33+
'FchEmis' => $fecha_emis,
34+
'TipoRetencion' => 1,
35+
],
36+
'Emisor' => [
37+
'RUTEmisor' => $emisor_rut
38+
],
39+
'Receptor' => [
40+
'RUTRecep' => '66666666-6',
41+
'RznSocRecep' => 'Receptor generico',
42+
'DirRecep' => 'Santa Cruz',
43+
'CmnaRecep' => 'Santa Cruz'
44+
]
45+
],
46+
'Detalle' => [
47+
[
48+
'NmbItem' => 'Item con monto final solamente (lo básico en SII)',
49+
'MontoItem' => 100
50+
],
51+
[
52+
'CdgItem' => 'CASO2',
53+
'NmbItem' => 'Se agrega código al item',
54+
'MontoItem' => 300
55+
],
56+
[
57+
'NmbItem' => 'Se agrega cantidad al item (se indica precio unitario)',
58+
'QtyItem' => 1,
59+
'PrcItem' => 120
60+
],
61+
[
62+
'NmbItem' => 'Se agrega cantidad al item (se indica precio unitario)',
63+
'QtyItem' => 0.5,
64+
'PrcItem' => 120
65+
],
66+
[
67+
'CdgItem' => 'CASO2',
68+
'NmbItem' => 'Se agrega código y cantidad al item (se indica precio unitario)',
69+
'QtyItem' => 2,
70+
'PrcItem' => 250
71+
],
72+
[
73+
'CdgItem' => 'COMPLETO',
74+
'NmbItem' => 'Caso más completo, con código, cantidad, precio unitario y descuento en porcentaje',
75+
'QtyItem' => 10,
76+
'PrcItem' => 75,
77+
'DescuentoPct' => 10
78+
],
79+
[
80+
'CdgItem' => 'COMPLETO',
81+
'NmbItem' => 'Caso más completo, con codigo, cantidad, precio unitario y descuento en monto fijo',
82+
'QtyItem' => 10,
83+
'PrcItem' => 75,
84+
'DescuentoMonto' => 50
85+
],
86+
[
87+
'NmbItem' => 'En este caso el MontoItem es descartado por que va cantidad y precio unitario',
88+
'QtyItem' => 2,
89+
'PrcItem' => 10,
90+
'MontoItem' => 100
91+
]
92+
]
93+
];
94+
95+
# Respuesta de solicitud HTTP (POST) de emisión de boleta.
96+
$response = $client->post($url, $datos_boleta);
97+
98+
# Despliegue del resultado.
6699
echo "\n", $response->getStatusCode();
67-
echo "\nLISTA BOLETAS: \n";
100+
echo "\nEMISION BOLETA: \n";
68101
echo "\n",$response->getBody(),"\n";
69102
70103
.. seealso::

‎docs/index.rst‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,24 @@
11
Docs: bhexpress-api-client-php
22
==============================
33

4+
.. image:: https://github.com/bhexpress/bhexpress-api-client-php/actions/workflows/ci.yml/badge.svg?branch=master&event=push
5+
:target: https://github.com/bhexpress/bhexpress-api-client-php/actions/workflows/ci.yml?query=branch%3Amaster
6+
7+
.. image:: https://scrutinizer-ci.com/g/bhexpress/bhexpress-api-client-php/badges/quality-score.png?b=master
8+
:target: https://scrutinizer-ci.com/g/bhexpress/bhexpress-api-client-php/
9+
10+
.. image:: https://scrutinizer-ci.com/g/bhexpress/bhexpress-api-client-php/badges/coverage.png?b=master
11+
:target: https://scrutinizer-ci.com/g/bhexpress/bhexpress-api-client-php/
12+
413
.. image:: https://poser.pugx.org/bhexpress/bhexpress-api-client/license
514
:target: https://packagist.org/packages/bhexpress/bhexpress-api-client
615

16+
.. image:: https://app.fossa.com/api/projects/git%2Bgithub.com%2FBHExpress%2Fbhexpress-api-client-php.svg?type=shield&issueType=license
17+
:target: https://app.fossa.com/projects/git%2Bgithub.com%2FBHExpress%2Fbhexpress-api-client-php?ref=badge_shield&issueType=license
18+
19+
.. image:: https://app.fossa.com/api/projects/git%2Bgithub.com%2FBHExpress%2Fbhexpress-api-client-php.svg?type=shield&issueType=security
20+
:target: https://app.fossa.com/projects/git%2Bgithub.com%2FBHExpress%2Fbhexpress-api-client-php?ref=badge_shield&issueType=security
21+
722
.. image:: https://poser.pugx.org/bhexpress/bhexpress-api-client/downloads
823
:target: https://packagist.org/packages/bhexpress/bhexpress-api-client
924

0 commit comments

Comments
 (0)