API Gateway API Client

BheRecibidas extends ApiBase
in package

Módulo para interactuar con Boletas de Honorarios Electrónicas recibidas del SII.

Para más información sobre la API, consulte la documentación completa de las BHE <https://developers.apigateway.cl/#7de04cde-a3e4-4ab5-b64a-e0fec7f7a5e9>_.

Table of Contents

Properties

$auth  : array<string|int, mixed>
Arreglo que contendrá el diccionario de autenticación.

Methods

__construct()  : mixed
Cliente específico para gestionar Boletas de Honorarios Electrónicas (BHE) recibidas.
consume()  : $this
Realiza una solicitud HTTP a la API.
delete()  : ResponseInterface|null
Realiza una solicitud DELETE a la API.
descargarPdfBheRecibida()  : ResponseInterface
Obtiene el PDF de una BHE recibida.
get()  : ResponseInterface|null
Realiza una solicitud GET a la API.
getApiVersion()  : string
getBody()  : string
Obtiene el cuerpo de la última respuesta HTTP.
getBodyDecoded()  : array<string|int, mixed>
Obtiene el cuerpo de la última respuesta HTTP y lo decodifica de JSON.
getLastApiUrl()  : string|null
Obtiene la última URL utilizada en la solicitud HTTP.
getLastResponse()  : ResponseInterface|null
Obtiene la última respuesta recibida de la API.
getLastUrl()  : string|null
Obtiene la última URL utilizada en la solicitud HTTP.
listarBhesRecibidas()  : ResponseInterface
Obtiene los documentos de BHE recibidos por un receptor en un periodo específico.
observarBheRecibida()  : ResponseInterface
Marca una observación en una BHE recibida.
post()  : ResponseInterface|null
Realiza una solicitud POST a la API.
put()  : ResponseInterface|null
Realiza una solicitud PUT a la API.
setToken()  : $this
Establece el token de autenticación.
setUrl()  : $this
Establece la URL base de la API.
toArray()  : array<string|int, mixed>
Convierte la última respuesta HTTP en un arreglo asociativo.
getAuthPass()  : array<string|int, mixed>
Obtiene la autenticación de tipo 'pass'.

Properties

$auth

Arreglo que contendrá el diccionario de autenticación.

protected array<string|int, mixed> $auth = []

Methods

__construct()

Cliente específico para gestionar Boletas de Honorarios Electrónicas (BHE) recibidas.

public __construct(array<string|int, mixed> $credenciales[, string|null $token = null ][, string|null $url = null ]) : mixed

Provee métodos para obtener documentos, obtener PDF y observar BHE recibidas.

Parameters
$credenciales : array<string|int, mixed>

Credenciales de autenticación.

$token : string|null = null

Token de autenticación para la API.

$url : string|null = null

URL base para la API.

consume()

Realiza una solicitud HTTP a la API.

public consume(string $resource[, array<string|int, mixed> $data = [] ][, array<string|int, mixed> $headers = [] ][, string|null $method = null ][, array<string|int, mixed> $options = [] ]) : $this

Este método envía una solicitud HTTP a la API de API Gateway, utilizando los parámetros especificados y manejando la autenticación y la respuesta.

Parameters
$resource : string

El recurso de la API al cual realizar la solicitud.

$data : array<string|int, mixed> = []

Datos a enviar en la solicitud (para métodos POST y PUT).

$headers : array<string|int, mixed> = []

Encabezados adicionales para incluir en la solicitud.

$method : string|null = null

Método HTTP a utilizar (GET, POST, PUT, DELETE).

$options : array<string|int, mixed> = []

Arreglo con las opciones de la solicitud HTTP.

Tags
throws
ApiException

Si se produce un error en la solicitud.

Return values
$this —

Instancia actual del cliente para encadenar llamadas.

delete()

Realiza una solicitud DELETE a la API.

public delete(string $resource[, array<string|int, mixed> $headers = [] ][, array<string|int, mixed> $options = [] ]) : ResponseInterface|null
Parameters
$resource : string

Recurso de la API al cual realizar la solicitud.

$headers : array<string|int, mixed> = []

Encabezados adicionales para incluir en la solicitud.

$options : array<string|int, mixed> = []

Arreglo con las opciones de la solicitud HTTP.

Return values
ResponseInterface|null

descargarPdfBheRecibida()

Obtiene el PDF de una BHE recibida.

public descargarPdfBheRecibida(string $codigo) : ResponseInterface
Parameters
$codigo : string

Código único de la BHE.

Return values
ResponseInterface —

Contenido del PDF de la BHE.

get()

Realiza una solicitud GET a la API.

public get(string $resource[, array<string|int, mixed> $headers = [] ][, array<string|int, mixed> $options = [] ]) : ResponseInterface|null
Parameters
$resource : string

Recurso de la API al cual realizar la solicitud.

$headers : array<string|int, mixed> = []

Encabezados adicionales para incluir en la solicitud.

$options : array<string|int, mixed> = []

Arreglo con las opciones de la solicitud HTTP.

Return values
ResponseInterface|null

getApiVersion()

public getApiVersion() : string
Return values
string

getBody()

Obtiene el cuerpo de la última respuesta HTTP.

public getBody() : string

Este método devuelve el cuerpo de la respuesta de la última solicitud HTTP realizada utilizando este cliente API.

Tags
throws
ApiException

Si no hay respuesta previa o el cuerpo no se puede obtener.

Return values
string —

El cuerpo de la respuesta HTTP.

getBodyDecoded()

Obtiene el cuerpo de la última respuesta HTTP y lo decodifica de JSON.

public getBodyDecoded() : array<string|int, mixed>

Este método devuelve el cuerpo de la respuesta de la última solicitud HTTP realizada por este cliente API, decodificándolo de formato JSON a un arreglo asociativo de PHP.

Tags
throws
ApiException

Si no hay respuesta previa o el cuerpo no se puede decodificar.

Return values
array<string|int, mixed> —

El cuerpo de la respuesta HTTP decodificado como un arreglo.

getLastApiUrl()

Obtiene la última URL utilizada en la solicitud HTTP.

public getLastApiUrl() : string|null
Return values
string|null

getLastResponse()

Obtiene la última respuesta recibida de la API.

public getLastResponse() : ResponseInterface|null
Return values
ResponseInterface|null

getLastUrl()

Obtiene la última URL utilizada en la solicitud HTTP.

public getLastUrl() : string|null
Return values
string|null

listarBhesRecibidas()

Obtiene los documentos de BHE recibidos por un receptor en un periodo específico.

public listarBhesRecibidas(string $receptor, string $periodo[, int|null $pagina = null ][, string|null $pagina_sig_codigo = null ]) : ResponseInterface
Parameters
$receptor : string

RUT del receptor de las boletas.

$periodo : string

Período de tiempo de las boletas recibidas.

$pagina : int|null = null

Número de página para paginación (opcional).

$pagina_sig_codigo : string|null = null

Código para la siguiente página (opcional).

Return values
ResponseInterface —

Respuesta JSON con los documentos de BHE.

observarBheRecibida()

Marca una observación en una BHE recibida.

public observarBheRecibida(string $emisor, string $numero[, int $causa = 1 ]) : ResponseInterface
Parameters
$emisor : string

RUT del emisor de la boleta.

$numero : string

Número de la boleta.

$causa : int = 1

Motivo de la observación.

Return values
ResponseInterface —

Respuesta JSON con la confirmación de la observación.

post()

Realiza una solicitud POST a la API.

public post(string $resource, array<string|int, mixed> $data[, array<string|int, mixed> $headers = [] ][, array<string|int, mixed> $options = [] ]) : ResponseInterface|null
Parameters
$resource : string

Recurso de la API al cual realizar la solicitud.

$data : array<string|int, mixed>

Datos a enviar en la solicitud.

$headers : array<string|int, mixed> = []

Encabezados adicionales para incluir en la solicitud.

$options : array<string|int, mixed> = []

Arreglo con las opciones de la solicitud HTTP.

Return values
ResponseInterface|null

put()

Realiza una solicitud PUT a la API.

public put(string $resource, array<string|int, mixed> $data[, array<string|int, mixed> $headers = [] ][, array<string|int, mixed> $options = [] ]) : ResponseInterface|null
Parameters
$resource : string

Recurso de la API al cual realizar la solicitud.

$data : array<string|int, mixed>

Datos a enviar en la solicitud.

$headers : array<string|int, mixed> = []

Encabezados adicionales para incluir en la solicitud.

$options : array<string|int, mixed> = []

Arreglo con las opciones de la solicitud HTTP.

Return values
ResponseInterface|null

setToken()

Establece el token de autenticación.

public setToken(string $token) : $this
Parameters
$token : string

Token de autenticación.

Return values
$this

setUrl()

Establece la URL base de la API.

public setUrl(string $url) : $this
Parameters
$url : string

URL base.

Return values
$this

toArray()

Convierte la última respuesta HTTP en un arreglo asociativo.

public toArray() : array<string|int, mixed>

Este método transforma la última respuesta HTTP recibida en un arreglo asociativo, que incluye información del estado HTTP, encabezados y el cuerpo de la respuesta, ya sea en formato de texto o decodificado de JSON.

Tags
throws
ApiException

Si se encuentra un error en el proceso.

Return values
array<string|int, mixed> —

Arreglo asociativo con la información de la respuesta.

getAuthPass()

Obtiene la autenticación de tipo 'pass'.

protected getAuthPass() : array<string|int, mixed>
Tags
throws
ApiException

Si falta información de autenticación.

Return values
array<string|int, mixed> —

Información de autenticación.


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results