Esta API fue desarrollada con el propósito de proporcionar una manera asíncrona de enviar leads a Zenvia Conversion, permitiendo recibir un webhook que contiene los resultados. Conozca en este artículo los requisitos y cómo utilizar esta API en su cuenta.
⚠️ Atención: La integración de una API demanda conocimiento técnico avanzado, por lo tanto, es importante contar con la ayuda de un desarrollador.
Authentication
Las solicitudes hechas a la API deben incluir una clave de API válida como un parámetro de encabezado (header). Por ejemplo:
Para acceder a la API, es importante incluir una clave de API válida en el encabezado de las solicitudes. Esto ayuda a garantizar la seguridad y el correcto procesamiento de la información. Vea un ejemplo:
var headers = {
'x-api-key': 'YOUR-API-KEY',
'Content-Type': 'application/json'
}Endpoint
El Endpoint de esta API está disponible en: https://conversion.zenvia.com/#tag/Leads
Request
Send Retail Lead
Production API server: https://conversion.zenvia.com/#operation/newRetailLead
Procesa datos de leads y devuelve el prospecto correspondiente. Si el prospecto ya existe, los datos anteriores del lead no serán devueltos. Solo para la industria minorista (retail).
Send Insurance Lead
Production API server: https://conversion.zenvia.com/#operation/newInsuranceLead
Procesa datos de leads y devuelve el prospecto correspondiente. Si el prospecto ya existe, los datos anteriores del lead no serán devueltos. Solo para la industria de seguros.
Send Automotive Lead
Production API server: https://conversion.zenvia.com/#operation/newVehicleLead
Procesa datos de leads y devuelve el prospecto correspondiente. Si el prospecto ya existe, los datos anteriores del lead no serán devueltos. Solo para la industria automotriz (vehículos).
Send Saving Plan Lead
Production API server: https://conversion.zenvia.com/#operation/newSavingPlanLead
Procesa datos de leads y devuelve el prospecto correspondiente. Si el prospecto ya existe, los datos anteriores del lead no serán devueltos. Solo para la industria de planes de ahorro/inversión.
Send Real Estate Lead
Production API server: https://conversion.zenvia.com/#operation/newRealEstateLead
Procesa datos de leads y devuelve el prospecto correspondiente. Si el prospecto ya existe, los datos anteriores del lead no serán devueltos. Solo para la industria inmobiliaria.
Response
202 ACCEPTED
{
"message": "Lead accepted",
"code": "202",
"correlationId": "{Generated UUID for webhook reference}"
}Es importante que el usuario guarde el correlationId para correlacionar la respuesta que será enviada posteriormente en la sesión del Webhook.
403 FORBIDDEN
{
"message": "{MESSAGE}",
"error": "Forbidden",
"statusCode": 403
}Donde {MESSAGE} puede ser:
- API key is missing
- There is not any integration available with the API Key provided
- The API Key provided is disabled
- This route does not have a scope associated to it
- The API Key provided has invalid scope: {SCOPE}, you need {SCOPE1} or {SCOPE2} permissions.
- This integration does not have an assigned group
- Invalid industry {INDUSTRY}. The API Key provided requires {INDUSTRY1} or {INDUSTRY2}.
400 BAD REQUEST
{
"message": [
"utmSource must be a string"
],
"error": "Bad Request",
"statusCode": 400
}Webhook
Cuando el cliente envía un lead con éxito, un correlationId será proporcionado y aquí será usado para correlacionar la respuesta a la publicación (post) hecha por el cliente. Tiene el siguiente formato:
{
"response": "{RESPONSE}",
"correlationId": "{Generated UUID for webhook reference}"
}Donde {RESPONSE} tiene el mismo formato que la respuesta de la API v1, con una respuesta añadida:
{
"code": "500",
"message": "The server is temporarily unavailable. Please try again later.",
