ContaFiAPI Client

Contribuyentes extends ApiBase
in package

Módulo que permite gestionar contribuyentes en ContaFi, junto con los roles y permisos disponibles.

Table of Contents

Methods

__construct()  : mixed
Módulo que permite gestionar contribuyentes en ContaFi, junto con los roles y permisos disponibles.
agregarPermisoRol()  : ResponseInterface
Recurso que permite agregar permisos a un rol.
agregarUsuarioAutorizado()  : ResponseInterface
Recurso que permite autorizar un usuario con cierto rol en un contribuyente.
consume()  : $this
Realiza una solicitud HTTP a la API.
datos()  : ResponseInterface
Recurso que permite obtener los datos de un contribuyente a partir de su RUT.
delete()  : ResponseInterface
Realiza una solicitud DELETE a la API.
estadisticas()  : ResponseInterface
Recurso que permite obtener la estadística de un contribuyente a partir de su RUT.
get()  : ResponseInterface
Realiza una solicitud GET a la API.
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.
getLastResponse()  : ResponseInterface|null
Obtiene la última respuesta recibida de la API.
getLastUrl()  : string|null
Obtiene la última URL utilizada en la solicitud HTTP.
obtenerRoles()  : ResponseInterface
Recurso que entrega los roles de un contribuyente.
post()  : ResponseInterface
Realiza una solicitud POST a la API.
put()  : ResponseInterface
Realiza una solicitud PUT a la API.
quitarPermisoRol()  : ResponseInterface
Recurso que permite quitar un permiso asociado a un rol de un contribuyente.
quitarUsuarioAutorizado()  : ResponseInterface
Recurso que permite quitar a un usuario con cierto rol en un contribuyente.
setRut()  : $this
Establece el RUT del contribuyente.
setToken()  : $this
Establece el token de autenticación.
setUrl()  : $this
Establece la URL base de la API.
sucursal()  : ResponseInterface
Recurso que permite obtener los datos de una sucursal de un contribuyente a partir de su código.

Methods

__construct()

Módulo que permite gestionar contribuyentes en ContaFi, junto con los roles y permisos disponibles.

public __construct([string|null $token = null ][, string|null $rut = null ][, string|null $url = null ]) : mixed
Parameters
$token : string|null = null

Token de autenticación del usuario. Si no se proporciona, se intentará obtener de una variable de entorno.

$rut : string|null = null

RUT del emisor de ContaFi. Si no se proporciona, se intentará obtener de una variable de entorno.

$url : string|null = null

URL base de la API. Si no se proporciona, se usará una URL por defecto.

agregarPermisoRol()

Recurso que permite agregar permisos a un rol.

public agregarPermisoRol(array<string|int, mixed> $body) : ResponseInterface
Parameters
$body : array<string|int, mixed>

Datos que incluyen el rol a modificar y sus permisos.

Return values
ResponseInterface —

Respuesta con el rol modificado.

agregarUsuarioAutorizado()

Recurso que permite autorizar un usuario con cierto rol en un contribuyente.

public agregarUsuarioAutorizado(array<string|int, mixed> $body) : ResponseInterface
Parameters
$body : array<string|int, mixed>

Datos como el nombre de usuario y rol a asignar.

Return values
ResponseInterface —

Respuesta con la información del usuario autorizado.

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 ContaFi, 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.

datos()

Recurso que permite obtener los datos de un contribuyente a partir de su RUT.

public datos(string $rut) : ResponseInterface
Parameters
$rut : string

RUT del contribuyente a consultar, sin puntos y con DV.

Return values
ResponseInterface —

Respuesta con los datos del contribuyente.

delete()

Realiza una solicitud DELETE a la API.

public delete(string $resource[, array<string|int, mixed> $headers = [] ][, array<string|int, mixed> $options = [] ]) : ResponseInterface
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

estadisticas()

Recurso que permite obtener la estadística de un contribuyente a partir de su RUT.

public estadisticas() : ResponseInterface
Return values
ResponseInterface —

Respuesta con las estadísticas.

get()

Realiza una solicitud GET a la API.

public get(string $resource[, array<string|int, mixed> $headers = [] ][, array<string|int, mixed> $options = [] ]) : ResponseInterface
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

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.

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

obtenerRoles()

Recurso que entrega los roles de un contribuyente.

public obtenerRoles() : ResponseInterface
Return values
ResponseInterface —

Respuesta con el detalle de cada rol.

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

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

quitarPermisoRol()

Recurso que permite quitar un permiso asociado a un rol de un contribuyente.

public quitarPermisoRol(int $idRol, string $permiso) : ResponseInterface
Parameters
$idRol : int

Identificador único del rol

$permiso : string

Permiso que se desea remover

Return values
ResponseInterface —

Respuesta con el rol modificado.

quitarUsuarioAutorizado()

Recurso que permite quitar a un usuario con cierto rol en un contribuyente.

public quitarUsuarioAutorizado(string $usuario, int $rol) : ResponseInterface
Parameters
$usuario : string

Nombre del usuario a remover.

$rol : int

Rol del usuario.

Return values
ResponseInterface —

Respuesta con la información del usuario removido.

setRut()

Establece el RUT del contribuyente.

public setRut(string $rut) : $this
Parameters
$rut : string

RUT del contribuyente.

Return values
$this

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

sucursal()

Recurso que permite obtener los datos de una sucursal de un contribuyente a partir de su código.

public sucursal(int $sucursal) : ResponseInterface
Parameters
$sucursal : int

ID de la sucursal a consultar.

Return values
ResponseInterface —

Respuesta con los datos de la sucursal.


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results