fbpx

< / >

token

Información del token

URL:

https://{{crm_server}}/server/API/v2/token/tokenInformation.php?operation={{operation_name}}

Descripción:

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

¿Cómo funciona?:

Esta API funciona a través de un cuerpo de tipo “raw” y una petición en POST, la cual requiere para su correcto funcionamiento los siguientes campos:

Importante: Al consumir esta API, también se consumirá el token y se reducirá en 1 la cantidad restante del disponible de consumo.

Reemplaza {{operation_name}} por el nombre de su operación.

En las cabeceras de la petición se requiere:

  • Wolkvox-Token: {{token}}
  • Content-Type: application/json

– No hay requerimientos para el cuerpo de la petición.

¿Cómo usar la URL?:

La URL de las APIs contiene un marcador de posición {{crm_server}} que debe ser sustituido por el servidor específico donde se encuentra la operación del cliente.

Servidores disponibles

Actualmente, los servidores disponibles son:

  • sv0001.crmvox.com
  • crm.wolkvox.com

¿Cómo determinar el servidor del CRM?

  • Acceda a la página inicial del CRM mediante el enlace: https://crm.wolkvox.com/.
  • Inicie sesión utilizando sus credenciales de CRM.
  • Una vez que haya iniciado sesión y esté en la página de inicio de su plataforma CRM, observe la barra de direcciones del navegador web. La URL en esta barra indica el servidor donde se aloja su operación.
  • Reemplace {{crm_server}} en la URL original con la URL específica de su servidor de CRM para asegurarse de que la API apunte correctamente a su instancia de CRM.

 

Aviso importante: Actualización de rutas de acceso

A partir del 1 de septiembre de 2024, se implementarán nuevas URLs para acceder a la plataforma de wolkvox CRM. Las URLs actuales coexistirán con las nuevas hasta el 30 de noviembre de 2024, fecha en la cual serán deshabilitadas.

Nuevas URLs:

De “https://sv0001.crmvox.com” a “https://crm0001.wolkvox.com

De “https://sv0000.crmvox.com” a “https://crm0000.wolkvox.com

Por favor, asegúrate de actualizar tus integraciones y automatizaciones antes del 30 de noviembre de 2024 para evitar interrupciones en el servicio.

REQUEST

KEY
DESCRIPCIÓN
EJEMPLO
Wolkvox-Server
Nomenclatura del servidor de la operación.
https://MiServidor.crmvox.com/server/API/v2/token/tokenInformation.php?operation=NombreDeMiOperacion
Wolkvox-Token
Token generado en el módulo de CRM que deseas consultar.
‘Wolkvox-Token: token’
operation
Nombre de la operación.
operation=NombreDeMiOperacion

REQUEST

				
					$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://{{wolkvox_server}}.crmvox.com/server/API/v2/token/tokenInformation.php?operation={{operation_name}}',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_HTTPHEADER => array(
    'Wolkvox-Token: {{token}}',
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

				
			

RESPONSE

KEY
DESCRIPCIÓN
EJEMPLO
code
Indica el código de respuesta HTTP.
“code”: “200”
error
Indica si hubo algún error durante la solicitud.
“error”: “null”
msg
Es un campo que puede proporcionar un mensaje descriptivo acerca del resultado de la solicitud.
“msg”: “1 records were are found”
data
Es el conjunto de datos específicos obtenidos.
“data”: { “description”: “token”, “token_limit”: 4800, “token_use_today”: 0, “available_consumition_options”: 4800, “hours_to_restart_count”: 15 }
description
Es la descripción del token.
“description”: “token”
token_limit
Indica el límite máximo de tokens que se pueden utilizar.
“token_limit”: 4800
token_use_today
Representa la cantidad de tokens utilizados hasta el momento en el día actual.
“token_use_today”: 0
available_consumition_options
Indica la cantidad de tokens que aún pueden ser utilizados.
“available_consumition_options”: 4800
hours_to_restart_count
Muestra la cantidad de horas que deben transcurrir antes de que el contador de uso se reinicie.
“hours_to_restart_count”: 15
				
					{
    "code": "",
    "error": "",
    "msg": "",
    "data": {
        "description": "",
        "token_limit": ,
        "token_use_today": ,
        "available_consumition_options": ,
        "hours_to_restart_count": 
    }
}
				
			
Posibles códigos de error

Usamos cookies, se continuar a navegar assumimos que concorda. Pode ler mais sobre a utilização de cookies nas nossas políticas de privacidade e tratamento de dados pessoais

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