ApiClientsController extends Controller
Table of Contents
Properties
- $enableCsrfValidation : mixed
Methods
- actionCreate() : array{name: string, message: string, status: int}
- Desc: Crea un nuevo cliente API.
- actionIndex() : array<string|int, mixed>
- Desc: Retorna la lista de clientes API (regions).
- actionOptions() : void
- Desc: Método para brindar información al fronend sobre opciones de comunicación. Funciona con método OPTIONS.
- actionReset() : array{name: string, message: string, status: int}
- Desc: Reinicia los créditos utilizados por todos los clientes API.
- actionUpdate() : array{name: string, message: string, status: int}
- Desc: Actualiza un cliente API específico por su ID.
- actionView() : ApiClients
- Desc: Retorna un cliente API específico por su ID.
- actionViewApiCode() : ApiClients
- Desc: Retorna un cliente API específico por su código.
- behaviors() : array<string|int, mixed>
- Desc: Retorna lista de comportamientos que el controlador debe de seguir.
- init() : void
- Desc: Inicializa configuraciones para el controlador.
Properties
$enableCsrfValidation
public
mixed
$enableCsrfValidation
= false
Methods
actionCreate()
Desc: Crea un nuevo cliente API.
public
actionCreate() : array{name: string, message: string, status: int}
Notes: Si se envía el header 'X-Mode-Name' con valor 'strict', se valida que los créditos asignados no superen los créditos disponibles en MetricData. Si la validación falla, se retorna un error 409 Conflict. Si la validación es exitosa, se actualiza el campo used_credits de MetricData sumando los créditos asignados al nuevo cliente API.
Ref: ApiClients, MetricData,
Tags
Return values
array{name: string, message: string, status: int}actionIndex()
Desc: Retorna la lista de clientes API (regions).
public
actionIndex() : array<string|int, mixed>
Notes: Permite paginación, ordenamiento y filtrado por api_code_except, por ejemplo: /api/v1/api-clients?api_code_except=abc123.
Ref: ApiClients,
Date: 2026-03-18, Version: v0.2603.21,
Example: GET /api/v1/api-clients, GET /api/v1/api-clients?api_code_except=abc123
Return values
array<string|int, mixed>actionOptions()
Desc: Método para brindar información al fronend sobre opciones de comunicación. Funciona con método OPTIONS.
public
actionOptions([mixed $id = null ]) : void
Notes: n/a,
Ref: https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Methods/OPTIONS
Date: 2025-08-07, Version: v0.2507.01
Example: n/a
Parameters
- $id : mixed = null
actionReset()
Desc: Reinicia los créditos utilizados por todos los clientes API.
public
actionReset() : array{name: string, message: string, status: int}
Notes: Se actualiza el campo used_credits de la tabla api_clients a 0 y se actualiza el campo used_credits de la tabla metric_data sumando los créditos utilizados por los clientes API regionales.
Ref: ApiClients, MetricData,
Example: n/a
Tags
Return values
array{name: string, message: string, status: int}actionUpdate()
Desc: Actualiza un cliente API específico por su ID.
public
actionUpdate(int $id) : array{name: string, message: string, status: int}
Notes: Si se envía el header 'X-Mode-Name' con valor 'strict', se valida que los créditos asignados no superen los créditos disponibles en MetricData. Si la validación falla, se retorna un error 409 Conflict. Si la validación es exitosa, se actualiza el campo used_credits de MetricData sumando la diferencia entre los créditos asignados al cliente API antes y después de la actualización.
Ref: ApiClients, MetricData,
Date: 2026-03-18, Version: v0.2603.21,
Example: PUT /api/v1/api-clients/1, PATCH /api/v1/api-clients/1
Parameters
- $id : int
Tags
Return values
array{name: string, message: string, status: int}actionView()
Desc: Retorna un cliente API específico por su ID.
public
actionView(int $id) : ApiClients
Notes: n/a, Ref: ApiClients,
Date: 2026-03-18, Version: v0.2603.21,
Example: GET /api/v1/api-clients/1
Parameters
- $id : int
Return values
ApiClientsactionViewApiCode()
Desc: Retorna un cliente API específico por su código.
public
actionViewApiCode(string $apiCode) : ApiClients
Notes: n/a, Ref: ApiClients,
Date: 2026-03-18, Version: v0.2603.21,
Example: GET /api/v1/api-clients/api_code
Parameters
- $apiCode : string
Tags
Return values
ApiClientsbehaviors()
Desc: Retorna lista de comportamientos que el controlador debe de seguir.
public
behaviors() : array<string|int, mixed>
Notes: Contiene excepciones de auht, auhtenticator, filtros de cors, métodos HTTP permitidos.
Ref: https://www.yiiframework.com/doc/api/2.0/yii-rest-controller#behaviors()-detail
Date: 2025-08-07, Version: v0.2507.01
Example: n/a
Return values
array<string|int, mixed> —Configuraciones del comportamiento
init()
Desc: Inicializa configuraciones para el controlador.
public
init() : void
Notes: Se deshabilita la sesión (porque se comporta como un API rest).
Ref: https://www.yiiframework.com/doc/api/2.0/yii-rest-controller#init()-detail
Date: 2025-08-07, Version: v0.2507.01
Example: n/a