API Gateway API Client

BheEmitidas extends ApiBase
in package

Clase base para las clases que consumen la API (wrappers).

Table of Contents

Constants

ANULACION_CAUSA_ERROR_DIGITACION  = 3
Constante de motivo de anulación de BHE por error de digitación.
ANULACION_CAUSA_SIN_PAGO  = 1
Constante de motivo de anulación de BHE por no pago.
ANULACION_CAUSA_SIN_PRESTACION  = 2
Constante de motivo de anulación de BHE por no tener prestación.
RETENCION_EMISOR  = 2
Constante de causa de retención por parte del receptor.
RETENCION_RECEPTOR  = 1
Constante de causa de retención por parte del emisor.

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) emitidas.
anularBheEmitida()  : ResponseInterface
Anula una BHE emitida.
consume()  : $this
Realiza una solicitud HTTP a la API.
delete()  : ResponseInterface|null
Realiza una solicitud DELETE a la API.
descargarPdfBheEmitida()  : ResponseInterface
Obtiene el PDF de una BHE emitida.
emitirBhe()  : ResponseInterface
Emite una nueva Boleta de Honorarios Electrónica.
enviarEmailBheEmitida()  : ResponseInterface
Envía por correo electrónico una BHE emitida.
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.
listarBhesEmitidas()  : ResponseInterface
Obtiene los documentos de BHE emitidos por un emisor en un periodo específico.
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'.

Constants

ANULACION_CAUSA_ERROR_DIGITACION

Constante de motivo de anulación de BHE por error de digitación.

public int ANULACION_CAUSA_ERROR_DIGITACION = 3

ANULACION_CAUSA_SIN_PAGO

Constante de motivo de anulación de BHE por no pago.

public int ANULACION_CAUSA_SIN_PAGO = 1

ANULACION_CAUSA_SIN_PRESTACION

Constante de motivo de anulación de BHE por no tener prestación.

public int ANULACION_CAUSA_SIN_PRESTACION = 2

RETENCION_EMISOR

Constante de causa de retención por parte del receptor.

public int RETENCION_EMISOR = 2

RETENCION_RECEPTOR

Constante de causa de retención por parte del emisor.

public int RETENCION_RECEPTOR = 1

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) emitidas.

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

Provee métodos para emitir, anular, y consultar información relacionada con BHEs.

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.

anularBheEmitida()

Anula una BHE emitida.

public anularBheEmitida(string $emisor, string $folio[, int $causa = self::ANULACION_CAUSA_ERROR_DIGITACION ]) : ResponseInterface
Parameters
$emisor : string

RUT del emisor de la boleta.

$folio : string

Número de folio de la boleta.

$causa : int = self::ANULACION_CAUSA_ERROR_DIGITACION

Motivo de anulación de la boleta.

Return values
ResponseInterface —

Respuesta JSON con la confirmación de la anulación de la BHE.

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

descargarPdfBheEmitida()

Obtiene el PDF de una BHE emitida.

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

Código único de la BHE.

Return values
ResponseInterface —

Contenido del PDF de la BHE.

emitirBhe()

Emite una nueva Boleta de Honorarios Electrónica.

public emitirBhe(array<string|int, mixed> $boleta) : ResponseInterface
Parameters
$boleta : array<string|int, mixed>

Información detallada de la boleta a emitir.

Return values
ResponseInterface —

Respuesta JSON con la confirmación de la emisión de la BHE.

enviarEmailBheEmitida()

Envía por correo electrónico una BHE emitida.

public enviarEmailBheEmitida(string $codigo, string $email) : ResponseInterface
Parameters
$codigo : string

Código único de la BHE a enviar.

$email : string

Dirección de correo electrónico a la cual enviar la BHE.

Return values
ResponseInterface —

Respuesta JSON con la confirmación del envío del email.

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

listarBhesEmitidas()

Obtiene los documentos de BHE emitidos por un emisor en un periodo específico.

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

RUT del emisor de las boletas.

$periodo : string

Período de tiempo de las boletas emitidas.

$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.

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