Consultar Consumo de API Pro

Descripción

Devuelve el consumo de API Pro del mes vigente, permitiendo realizar un seguimiento programático de la cantidad de solicitudes (hits) realizadas y sus respectivos costos.

El consumo se presenta por separado entre los períodos diurno y nocturno, además de los valores totales acumulados durante el período. La respuesta también informa la moneda utilizada y el límite financiero de consumo (costLimit) configurado para el alcance de la clave utilizada en la solicitud.

La consulta respeta el alcance de la clave de acceso:

Clave de ADM General: devuelve el consumo correspondiente al alcance de ADM General.

Clave de sucursal: devuelve únicamente el consumo correspondiente al alcance de la respectiva sucursal.

🚧 Observaciones
El consumo devuelto corresponde al mes vigente.
El consumo de API Pro se contabiliza considerando los costos aplicables a los hits diurnos y nocturnos.
El límite financiero es independiente entre los diferentes alcances. El consumo realizado por claves registradas en ADM General se contabiliza en el alcance de ADM General, mientras que el consumo de una clave de sucursal se contabiliza en el alcance de la respectiva sucursal.
El campo costLimit representa el límite financiero configurado para el alcance consultado.
El límite financiero es opcional. Cuando está configurado, se utiliza para controlar el valor máximo de consumo de API Pro durante el período.
Cuando el costo acumulado alcanza el límite configurado, las claves vinculadas al respectivo alcance se bloquean para nuevos consumos de API Pro.
Después de alcanzar el límite y bloquearse la clave, este endpoint tampoco podrá consultarse con la clave bloqueada. Las solicitudes devolverán HTTP 401 con el código API_COST_LIMIT_REACHED.
El consumo y el bloqueo se reinician al comienzo de un nuevo mes, manteniendo el límite configurado para el nuevo período.

📤 Estructura de la Respuesta

La respuesta presenta el período considerado, la moneda, el consumo de API Pro separado entre los períodos diurno y nocturno, el consumo total y el límite financiero configurado.

Campo	Tipo	Descripción
`period`	object	Objeto que contiene el período considerado para el cálculo del consumo. Ver más abajo.
`currency`	string	Moneda utilizada para los valores de consumo y el límite financiero.
`usage`	object	Objeto que contiene la cantidad de hits y los costos acumulados durante el período. Ver más abajo.
`costLimit`	number	Límite financiero de consumo de API Pro configurado para el alcance de la clave utilizada.

🧩 Estructura del Objeto `period`

Campo	Tipo	Descripción
`start`	date-time	Fecha y hora inicial del período considerado para el cálculo del consumo del mes vigente.
`end`	date-time	Fecha y hora final del período considerado para el cálculo del consumo.

🧩 Estructura del Objeto `usage`

Campo	Tipo	Descripción
`daytime`	object	Consumo acumulado durante el período diurno.
`nighttime`	object	Consumo acumulado durante el período nocturno.
`total`	object	Consumo total acumulado, considerando los períodos diurno y nocturno.

🧩 Estructura de los Objetos `daytime`, `nighttime` y `total`

Campo	Tipo	Descripción
`hits`	int32	Cantidad de solicitudes (hits) contabilizadas en el respectivo período. En el objeto `total`, representa la suma de los hits diurnos y nocturnos.
`cost`	number	Costo acumulado de las solicitudes en el respectivo período. En el objeto `total`, representa el costo total acumulado.

💰 Moneda

La moneda utilizada para presentar el consumo y el límite financiero varía según el mercado del cliente:

Mercado	`currency`
Brasil	`BRL`
LATAM aplicable	`USD`

⚠️ Límite de Consumo Alcanzado

Cuando el costo acumulado alcanza el 100% del costLimit configurado, las claves vinculadas al respectivo alcance se bloquean.

A partir de ese momento, las nuevas solicitudes realizadas con la clave bloqueada, incluida la consulta de este endpoint, devolverán:

HTTP 401

{
  "error": {
    "code": "API_COST_LIMIT_REACHED",
    "message": "The configured API usage cost limit has been reached."
  }
}

OBS. Mientras la clave esté activa, este endpoint puede utilizarse para monitorear el consumo y comparar el campo usage.total.cost con el costLimit configurado.

Envía tus solicitudes HTTP con un encabezado

Authorization

que contenga la palabra Basic seguida de un espacio y una cadena codificada en base64 username:password

Ejemplo:

Authorization: Basic *****************

Respuestas

🟢200

application/json

Success

Body

Ejemplo

{
    "period": {
        "start": "2019-08-24T14:15:22.123Z",
        "end": "2019-08-24T14:15:22.123Z"
    },
    "currency": "string",
    "usage": {
        "daytime": {
            "hits": 0,
            "cost": 0
        },
        "nighttime": {
            "hits": 0,
            "cost": 0
        },
        "total": {
            "hits": 0,
            "cost": 0
        }
    },
    "costLimit": 0
}

🟠400

Get API Pro usage of the current month (hits and costs by period) and the configured cost limit

Consultar Consumo de API Pro

Descripción

📤 Estructura de la Respuesta

🧩 Estructura del Objeto `period`

🧩 Estructura del Objeto `usage`

🧩 Estructura de los Objetos `daytime`, `nighttime` y `total`

💰 Moneda

⚠️ Límite de Consumo Alcanzado

Solicitud

Ejemplos de solicitud

Respuestas

Get API Pro usage of the current month (hits and costs by period) and the configured cost limit

Consultar Consumo de API Pro#

Descripción#

📤 Estructura de la Respuesta#

🧩 Estructura del Objeto period#

🧩 Estructura del Objeto usage#

🧩 Estructura de los Objetos daytime, nighttime y total#

💰 Moneda#

⚠️ Límite de Consumo Alcanzado#

Solicitud

Ejemplos de solicitud

Respuestas

Consultar Consumo de API Pro

Descripción

📤 Estructura de la Respuesta

🧩 Estructura del Objeto `period`

🧩 Estructura del Objeto `usage`

🧩 Estructura de los Objetos `daytime`, `nighttime` y `total`

💰 Moneda

⚠️ Límite de Consumo Alcanzado