fbpx

< / >

Insertar obligación

Insertar obligación

URL:

https://{{crm_server}}/server/API/v2/collections/insertObligation.php

Descripción:

Esta API proporciona la capacidad de agregar nuevas obligaciones a las colecciones existentes en el sistema CRM. Las obligaciones representan los compromisos financieros o acuerdos de pago entre la empresa y sus clientes. Al utilizar esta API, los agentes o administradores pueden registrar y gestionar las obligaciones de manera eficiente.

¿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
  • wolkvox-id
  • fields

¿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”:”modulodeprueba”
wolkvox_id
Es el identificador del registro en collections.
“wolkvox_id”: “61fa3”
fields
Es el conjunto de atributos de la nueva obligación.
id
Código de identificación de la obligación en el registro indicado.
“id”: “obl1”
name
Nombre de la obligación.
“name”: “Factura 12345 – Pago Pendiente”
total_balance
Es el saldo total.
“total_balance”: “10000”
portfolio_type
Es el tipo de cartera asociado.
“portfolio_type”: “VIP Client”
last_pay
Indica el monto del último pago asociado.
“last_pay”: “2000”
last_pay_date
Indica la fecha del último pago asociado.
“last_pay_date”: “06-06-2023”
expiring_date
Indica la fecha de vencimiento.
“expiring_date”: “07-07-2023”
days_delay
Indica el número de días de retraso.
“days_delay”: “90”
form
Es un conjunto de datos que representa los campos adicionales (en las obligaciones) que se crearon como complementarios a los predeterminados.
“form”: [ { “name”: “Titulacion”, “value”: “valor de titulacion” }, { “name”: “Frecuencia”, “value”: “Frecuentado” } ]

REQUEST

				
					$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://{{wolkvox_server}}/server/API/v2/collections/insertObligation.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": "",
    "wolkvox_id": "",
    "fields": {
        "id": "",
        "name": "",
        "total_balance": "",
        "portfolio_type": "",
        "last_pay": "",
        "last_pay_date": "",
        "expiring_date": "",
        "days_delay": "",
        "form": [
            {
                "name": "",
                "value": ""
            }
        ]
    }
}',
  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 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": "Succesfully create record",
    "data": {
        "wolkvox_id": "123cb"
    }
}
				
			
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