fbpx

< / >

Consultar registros

Consultar registros

URL:

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

Descripción:

El API de búsqueda nos permite, mediante el envío de parámetros, buscar registros en los módulos configurados de nuestro CRM.

¿Cómo funciona?:

Esta API funciona a través de un cuerpo de tipo “raw” y una petición en GET, 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
  • module
  • field
  • value

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”: “modulotest03”
module
Nombre del módulo para consultar.
“module”: “Ventas”
field
Es el campo de CRM que utilizaremos para filtrar.
“field”: “Categoria”
value
Es el criterio de búsqueda.
“value”: “Arepas”

REQUEST

				
					<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://{{wolkvox_server}}/server/API/v2/custom/query.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 => 'GET',
  CURLOPT_POSTFIELDS =>'{
    "operation":"{{operation}}",
    "module":"{{module}}",
    "field":"{{field}}",
    "value":"{{value}}"
}',
  CURLOPT_HTTPHEADER => array(
    'Wolkvox-Token':'{{token}}',
    'Content-Type: application/json',
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
				
			

RESPONSE

El campo "data" del response entrega todos los campos registrados en el módulo más los campos predeterminados que son los siguientes:

KEY
DESCRIPCIÓN
EJEMPLO
wolkvox_usuario_creacion
Es el usuario que creó el registro.
“wolkvox_usuario_creacion”: “admin@modulodeprueba”
wolkvox_fecha_creacion
Es el nombre de la operación del CRM.
“wolkvox_fecha_creacion”: “2023-09-29 10:59:54”
wolkvox_origen
Indica desde dónde fue creado el registro
“PostmanRuntime/7.33.0 – /server/API/v2/custom/insert.php”
wolkvox_ip_address
Indica la IP pública desde la cual fue creado el registro.
“wolkvox_ip_address”: “xxx.ccc.ddd.ee – v2”
wolkvox_owner
Muestra un conjunto de datos acerca del propietario del registro. Este conjunto de datos incluye el nombre de usuario (user), el nombre (nombre), número de id (id) y correo electrónico (email).
“wolkvox_owner”: { “user”: “api”, “nombre”: “api”, “id”: “api”, “email”: “api” }
wolkvox_id
Es la identificación del registro en el módulo.
“wolkvox_id”: “6cvvbbxx”
				
					{
    "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