ARGENTINA
Buenos Aires +54 (11) 5217 5933
BRASIL
Goiânia +55 (62) 99328 6605
CHILE
Santiago de Chile +56 (2) 240 533 89
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:
– En el cuerpo de la petición se requiere:
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” |
'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;
curl --location --request GET 'https://{{wolkvox_server}}/server/API/v2/custom/query.php' \
--header 'Wolkvox-Token: {{token}}' \
--header 'Content-Type: application/json' \
--data-raw '{
"operation":"{{operacion}},
"module":"{{module}}",
"field":"{{field}}",
"value":"{{value}}"
}'
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\r\n \"operation\":\{"operation\"},\r\n \"module\":\{"module\"},\r\n \"field\":\{"field\"},\r\n \"value\":\{"value\"}\r\n}");
Request request = new Request.Builder()
.url("https://{{wolkvox_server}}/server/API/v2/custom/query.php")
.method("GET", body)
.addHeader("Wolkvox-Token", {"{{token}}"})
.addHeader("Content-Type", "application/json")
.build();
Response response = client.newCall(request).execute();
import requests
import json
url = "https://{{wolkvox_server}}/server/API/v2/custom/query.php"
payload = json.dumps({
"operation": "{{operation}}",
"module": "{{module}}",
"field": "{{field}}",
"value": "{{value}}"
})
headers = {
'Wolkvox-Token': '{{token}}',
'Content-Type': 'application/json',
}
response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)
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": []
}
Medellín +57 (604) 322 98 80
Bogotá +57 (601) 381 90 40
Cali +57 (602) 891 28 46
Barranquilla +57 (605) 316 10 34
Goiânia +55 (62) 99328 6605
Santiago de Chile +56 (2) 240 533 89
Atlanta +1 (678) 496 7474
Ciudad de Guatemala +502 (2) 314 1344
Ciudad de México +52 (55) 8526 36 34
Copyright © 2022 MICROSYSLABS S.A.S. Todos los derechos reservados. Cra 30 # 4A-45 Of. 205 Ed. FOREVER W&L, Medellín, Colombia
COLOMBIA
Medellín +57 (4) 322 98 80
Bogotá +57 (1) 381 90 40
Cali +57 (2) 891 28 46
Barranquilla +57 (5) 316 10 34
ARGENTINA
Buenos Aires +54 (11) 5217 5933
ESPAÑA
Madrid +34 (910) 601 691
MÉXICO
Ciudad de México +52 (55) 8526 36 34
BRASIL
Brasilia +55 (61) 9836 4127
São Paulo +55 (12) 9811 155 83
ESTADOS UNIDOS
New York +1 (914) 373 71 36
REPÚBLICA DOMINICANA
Santo Domingo +1 (829) 249 69 68
CHILE
Santiago de Chile +56 (2) 240 533 89
GUATEMALA
Ciudad de Guatemala +502 (2) 314 1344
PERÚ
Lima +51 (1) 644 91 39
Copyright © 2022 MICROSYSLABS S.A.S.
Todos los derechos reservados.
Cra 30 # 4A – 45 Of. 205 Ed. FOREVER W&L, Medellín, Colombia
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