fbpx

< / >

Consultar registros

Consultar registros

URL:

https://{{crm_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 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
  • module
  • field
  • value

– Archivos adjuntos:

Si tu módulo contiene al menos un campo de tipo “Adjuntos” esta API traerá el conjunto de archivos adjuntos asignados al registro encontrado. También permitirá copiar la URL del archivo para que cualquier persona con el link pueda descargarlo. La estructura de este campo es el siguiente:

“Nombre del campo de tipo Adjuntos”: [
                {
                    “name”: “Nombre del archivo.extensión del archivo”,
                    “url”: “https://crm.wolkvox.com/server/…”
                }
            ]

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

				
					$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 => 'POST',
  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