fbpx
Search
Close this search box.
Search
Close this search box.

< / >

APIs

10. Información de tokens

URL:

https://wv{{wolkvox_server}}.wolkvox.com/api/v2/information.php?api=token_info

Descripción:

Esta API Permite realizar un seguimiento detallado de la cantidad de uso de cada token generado

Beneficio:

Permite tener información básica para una optimización de recursos, evitar exceder límites, planificar el uso del token, entre otros beneficios.

Cómo funciona:

  • El consumo de esta API se realiza por método GET.
  • Para consumir esta API debe reemplazar en la url {{wolkvox_server}} por la nomenclatura del servidor de la operación.
  • Se debe hacer uso del wolkvox-token: {{token}} en el Header para hacer uso de el token de autorización.
  • Importante: Al consumir esta API, también se consumirá el token y se reducirá en 1 la cantidad restante del disponible de consumo.
  • Tenga en cuenta que un mismo token no puede ser consumidos de manera simultánea, por lo cual puede programar que la siguiente API sea consumida cuando el resultado de la anterior sea exitoso.
  • En términos de tiempo, para hacer seguimiento a su operación puede hacer un consumo cada 5 minutos de la información.

REQUEST

NAME DESCRIPTION TYPE
api Tipo de reporte requerido. String
wolkvox-token Token a consultar. String

RESPONSE

NAME DESCRIPTION TYPE
description Descripción del token String
token_limit Este campo muestra el límite máximo de usos permitidos para el token en un período de tiempo determinado. Representa la cantidad máxima de veces que se puede utilizar el token en un día o algún otro intervalo de tiempo establecido. String
token_use_today Este campo indica la cantidad de veces que el token se ha utilizado durante el día actual. Especifica cuántas veces se ha empleado el token hasta el momento desde que comenzó el día. String
all_token_today Este campo representa el total de todos los tokens utilizados durante el día actual. Es la suma de los usos de todos los tokens generados en el software durante ese período. String
available_consumption_options Este campo muestra la cantidad restante de usos permitidos para el token en el día actual. Es el resultado de restar la cantidad total de usos permitidos (token_limit) de la cantidad de usos ya realizados en el día (token_use_today). Indica cuántas veces más se puede utilizar el token antes de alcanzar su límite máximo de usos diarios. String

 

Posibles códigos de respuesta
				
					$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://wv{{wolkvox_server}}.wolkvox.com/api/v2/information.php?api=token_info',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'wolkvox-token: {{token}}'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
				
			

RESPONSE

				
					{
    "code": "200",
    "error": null,
    "msg": " 1 records were found",
    "data": [
        {
            "description": " ",
            "token_limit": " ",
            "token_use_today": " ",
            "all_token_today": " ",
            "available_consumption_options": " "
        }
    ]
}
				
			

Hacemos uso de cookies, si continúas navegando asumiremos que estás de acuerdo. Puede leer más sobre el uso de cookies en nuestras políticas de privacidad y tratamiento de datos personales

Hacemos uso de cookies, si continúas navegando asumiremos que estás de acuerdo. Puede leer más sobre el uso de cookies en nuestras políticas de privacidad y tratamiento de datos personales