fbpx

< / >

Reportes

Reportes

URL:

https://{{wolkvox_server}}/server/API/v2/custom/reports.php

Descripción:

El API de búsqueda de reportes nos permite mediante el envío de parámetros buscar registros de reportes en los módulos parametrizados de nuestro CRM. Los reportes ya deben estar generados para poder usar la API.

¿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:

 En las cabeceras de la petición se requiere:

  • Wolkvox-Token

– En el cuerpo de la petición se requiere:

  • operation
  • name
  • dateStart
  • dateEnd

REQUEST

KEY
DESCRIPCIÓN
EJEMPLO
Wolkvox-Token
Es el token configurado por el cliente en la página de CRM.
A8K3J7F2
operation
Es el nombre de la operación del CRM.
“operation”:”modulodeprueba”
name
Es el nombre del reporte, se debe poner exactamente igual al nombre que se parametrizo en el CRM.
“name”:”Reporte de empresas 20230817 versión 1″
dateStart
Es el rango inicial para generar la consulta.
“dateStart”:”2023-01-01 00:00:00″
dateEnd
Es el rango final para generar la consulta.
“dateEnd”:”2023-12-31 00:00:00″

REQUEST

				
					<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://{{wolkvox_server}}/server/API/v2/custom/reports.php',
  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_POSTFIELDS =>'{
    "operation":"{{operation}}",
    "name":"{{name}}",
    "dateStart":"{{yyyymmddhis}}",
    "dateEnd":"{{yyyymmddhis}}"
}',
  CURLOPT_HTTPHEADER => array(
    'Wolkvox-Token: {{Wolkvox-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 estado de la respuesta.
“code”: 200
error
Proporciona detalles sobre el error que ocurrió durante la solicitud.
“error”: “null”
msg
Muestra un mensaje descriptivo sobre el resultado de la solicitud.
“msg”: “Succesfully edit record”
data
Es el conjunto de información obtenido como resultado de haber hecho la solicitud.
{ “code”: “200”, “error”: “null”, “msg”: “2 records were are found”, “data”: [ { “Company ID”: 12345, “Company name”: “Tech Solutions Inc.”, “Email”: “[email protected]”, “wolkvox_id”: “64dc” }, { “Company ID”: 1001, “Company name”: “GreenTech Innovations Ltd.”, “Email”: “[email protected]”, “wolkvox_id”: “64dcf” } ] }
				
					{
    "code": "200",
    "error": "null",
    "msg": "X records were are found",
    "data": []
}
				
			
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