API Gateway API Client

ApiBase extends ApiClient
in package

apigateway

api

client

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

Properties

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

Methods

__construct() : mixed: Constructor de la clase base.
consume() : $this: Realiza una solicitud HTTP a la API.
delete() : ResponseInterface|null: Realiza una solicitud DELETE a la API.
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.
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'.
isAuthCertData() : bool: Valida si una cadena tiene formato PEM válido.
isAuthFileData() : bool: Verifica si una cadena es una cadena codificada en Base64 válida.
isAuthPass() : bool: Valida la estructura de un RUT chileno utilizando una expresión regular.
setupAuth() : void: Configura la autenticación específica para la aplicación.

$auth

Arreglo que contendrá el diccionario de autenticación.


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

__construct()

Constructor de la clase base.


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

Parameters

$credenciales : array<string|int, mixed> = []: Argumentos adicionales para la 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.

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

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.

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.

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

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.

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>

Return values

array<string|int, mixed> —

Información de autenticación.

isAuthCertData()

Valida si una cadena tiene formato PEM válido.


    private
                    isAuthCertData(string $pemStr) : bool

El formato PEM debe cumplir con los siguientes criterios:

 - Comienza con una línea "-----BEGIN [LABEL]-----"
 - Termina con una línea "-----END [LABEL]-----"
 - Contiene contenido Base64 válido entre las líneas BEGIN y END

Ejemplos de PEM Válidos:

 ```
 -----BEGIN CERTIFICATE-----
 MIIDdzCCAl+gAwIBAgIEbGzVnzANBgkqhkiG9w0BAQsFADBvMQswCQYDVQQGEwJV
 ...
 -----END CERTIFICATE-----
 ```

Ejemplos de PEM Inválidos:

 - Falta la línea de inicio o fin.
 - Contenido no codificado en Base64.
 - Etiquetas de BEGIN y END que no coinciden.

Parameters

$pemStr : string: La cadena a validar.

Return values

bool —

true si la cadena tiene formato PEM válido, false en caso contrario.

isAuthFileData()

Verifica si una cadena es una cadena codificada en Base64 válida.


    private
                    isAuthFileData(string $firmaElectronicaBase64) : bool

Parameters

$firmaElectronicaBase64 : string: La cadena a verificar.

Return values

bool —

true si la cadena es válida en Base64, false en caso contrario.

isAuthPass()

Valida la estructura de un RUT chileno utilizando una expresión regular.


    private
                    isAuthPass(string $rut) : bool

Este método verifica que el RUT cumpla con el formato estándar chileno, que incluye puntos como separadores de miles opcionales y un guion antes del dígito verificador. El dígito verificador puede ser un número o la letra 'K'.

Ejemplos de RUT válidos:

- 12.345.678-5
- 12345678-5
- 9.876.543-K
- 9876543-K

Ejemplos de RUT inválidos:

- 12.345.678-9 (dígito verificador incorrecto)
- 12345678- (falta dígito verificador)
- 12345-6 (formato incorrecto)
- 12.345.6785 (falta guion)
- abcdefgh-i (caracteres no permitidos)

Parameters

$rut : string: El RUT a validar.

Return values

bool —

true si el RUT tiene un formato válido,false en caso contrario.

setupAuth()

Configura la autenticación específica para la aplicación.


    private
                    setupAuth(array<string|int, mixed> $credenciales) : void

Parameters

$credenciales : array<string|int, mixed>: Parámetros de autenticación. Puede ser 'pass' o 'cert'.

ApiBase extends ApiClient in package apigateway api client

Table of Contents

Properties

Methods

Properties

$auth

Methods

__construct()

Parameters

consume()

Parameters

Tags

Return values

delete()

Parameters

Return values

get()

Parameters

Return values

getApiVersion()

Return values

getBody()

Tags

Return values

getBodyDecoded()

Tags

Return values

getLastApiUrl()

Return values

getLastResponse()

Return values

getLastUrl()

Return values

post()

Parameters

Return values

put()

Parameters

Return values

setToken()

Parameters

Return values

setUrl()

Parameters

Return values

toArray()

Tags

Return values

getAuthPass()

Tags

Return values

isAuthCertData()

Parameters

Return values

isAuthFileData()

Parameters

Return values

isAuthPass()

Parameters

Return values

setupAuth()

Parameters

Tags

ApiBase extends ApiClient
in package

apigateway

api

client