ApiClient
in package
Clase ApiClient para la integración con la API de LibreDTE.
Proporciona funcionalidades para realizar peticiones HTTP a la API de LibreDTE, incluyendo métodos para realizar solicitudes GET y POST.
Table of Contents
Properties
- $api_prefix : string
- El prefijo para las rutas de la API.
- $api_url : string
- La URL base de la API de LibreDTE.
- $client : HttpCurlClient
- Objeto para manejar las conexiones HTTP mediante cURL.
- $headers : array<string|int, mixed>
- Valores por defecto de la cabecera que se pasarán a cURL.
Methods
- __construct() : mixed
- Constructor de la clase ApiClient.
- get() : array<string|int, mixed>
- Realiza una solicitud GET a la API de LibreDTE.
- post() : array<string|int, mixed>
- Realiza una solicitud POST a la API de LibreDTE.
- setHeader() : mixed
- Establece una cabecera para las solicitudes HTTP.
- setSSL() : mixed
- Configura las opciones de SSL para las conexiones HTTP.
- env() : string|null
- Obtiene el valor de una variable de entorno.
Properties
$api_prefix
El prefijo para las rutas de la API.
private
string
$api_prefix
= '/api'
$api_url
La URL base de la API de LibreDTE.
private
string
$api_url
= 'https://libredte.cl'
$client
Objeto para manejar las conexiones HTTP mediante cURL.
private
HttpCurlClient
$client
$headers
Valores por defecto de la cabecera que se pasarán a cURL.
private
array<string|int, mixed>
$headers
= ['User-Agent' => 'LibreDTE: Cliente de API en PHP.', 'Content-Type' => 'application/json', 'Accept' => 'application/json']
Methods
__construct()
Constructor de la clase ApiClient.
public
__construct([string|null $hash = null ][, string|null $url = null ]) : mixed
Inicializa el cliente con las credenciales y la URL de la API. Si no se proporcionan, se intentará obtener desde las variables de entorno.
Parameters
- $hash : string|null = null
-
Hash de autenticación del usuario en LibreDTE.
- $url : string|null = null
-
URL base de la API de LibreDTE.
Tags
get()
Realiza una solicitud GET a la API de LibreDTE.
public
get(string $resource[, mixed $data = null ][, array<string|int, mixed> $headers = [] ]) : array<string|int, mixed>
Recupera datos de un recurso específico de la API utilizando el método GET.
Parameters
- $resource : string
-
El recurso de la API a solicitar.
- $data : mixed = null
-
Los datos a enviar en la solicitud GET.
- $headers : array<string|int, mixed> = []
-
Encabezados adicionales para la solicitud.
Return values
array<string|int, mixed> —Respuesta de la API.
post()
Realiza una solicitud POST a la API de LibreDTE.
public
post(string $resource[, mixed $data = null ][, array<string|int, mixed> $headers = [] ]) : array<string|int, mixed>
Envia datos a un recurso específico de la API utilizando el método POST.
Parameters
- $resource : string
-
El recurso de la API a solicitar.
- $data : mixed = null
-
Los datos a enviar en la solicitud POST.
- $headers : array<string|int, mixed> = []
-
Encabezados adicionales para la solicitud.
Return values
array<string|int, mixed> —Respuesta de la API.
setHeader()
Establece una cabecera para las solicitudes HTTP.
public
setHeader(string $name, mixed $value) : mixed
Permite definir un valor para una cabecera específica que se incluirá en todas las solicitudes HTTP realizadas por la instancia del cliente.
Parameters
- $name : string
-
Nombre de la cabecera.
- $value : mixed
-
Valor de la cabecera.
setSSL()
Configura las opciones de SSL para las conexiones HTTP.
public
setSSL([bool $sslcheck = true ]) : mixed
Este método permite activar o desactivar la verificación del certificado SSL del servidor.
Parameters
- $sslcheck : bool = true
-
Activar o desactivar la verificación del certificado SSL.
env()
Obtiene el valor de una variable de entorno.
private
env(string $name) : string|null
Este método es utilizado internamente para obtener configuraciones como el hash de autenticación o la URL base de la API.
Parameters
- $name : string
-
Nombre de la variable de entorno.
Return values
string|null —Valor de la variable de entorno o null si no está definida.