ApiRegionsCreditsController extends Controller
Table of Contents
Methods
- actionIndex() : mixed
- Desc: Devuelve listado de items de ApiRegionsCredits. Funciona con método GET.
- actionOptions() : void
- Desc: Método para brindar información al fronend sobre opciones de comunicación. Funciona con método OPTIONS.
- actionUpdate() : array{name: string, message: string, code: int, status: int}
- Desc: Actualiza un item de ApiRegions. Funciona con los métodos PUT, PATCH.
- actionView() : mixed
- Desc: Item de ApiRegions. Funciona con método GET.
- behaviors() : array<string|int, mixed>
- Desc: Retorna lista de comportamientos que el controlador debe de seguir.
- init() : void
- Desc: Inicializa configuraciones para el controlador.
Methods
actionIndex()
Desc: Devuelve listado de items de ApiRegionsCredits. Funciona con método GET.
public
actionIndex() : mixed
Notes: Obtiene el listado de las regiones registradas en la Api-metrics (v1/api/clients). Se puede filtrar por código de regiones (api regions) a excluir (api_code_except).
Ref: (https://metrics.okvirtual.com/)
Date: 2026-02-27, Version: v0.2603.21
Tags
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
actionUpdate()
Desc: Actualiza un item de ApiRegions. Funciona con los métodos PUT, PATCH.
public
actionUpdate(int $id) : array{name: string, message: string, code: int, status: int}
Notes: Actualiza los datos de una región específica. Utiliza el ID del registro local de ApiRegions para obtener el api_code y luego hacer la consulta a la Api-metrics (v1/api-clients/api-code/{api_code}) para obtener el ID del cliente en la Api-metrics y luego hacer la actualización con el endpoint v1/api-clients/{id} de la Api-metrics. El cuerpo de la solicitud contiene los campos a actualizar en la Api-metrics (ejemplo: {"credits": 1000} para actualizar los créditos). Se incluyen de la solicitud las credenciales de autenticación (X-API-Key, X-Signature) y el header "X-Mode-Name" con el valor "strict" para indicar que se desea una actualización estricta (Actualiza valores en la tabla).
Ref: n/a
Date: 2026-02-27
Example: n/a
Parameters
- $id : int
-
ID Local del recurso.
Return values
array{name: string, message: string, code: int, status: int}actionView()
Desc: Item de ApiRegions. Funciona con método GET.
public
actionView(int $id) : mixed
Notes: Obtiene los detalles de una región específica. Se puede expandir la información de la región con el parámetro "expand" (ejemplo: ?expand=credits). Utiliza el ID del registro local de ApiRegions para obtener el api_code y luego hacer la consulta a la Api-metrics (v1/api-clients/api-code/{api_code}).
Ref: ApiRegions,
Date: 2026-02-27,
Example: n/a
Parameters
- $id : int
-
ID local del recurso
behaviors()
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-11, 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-11, Version: v0.2507.01
Example: n/a