Esta API foi desenvolvida com o propósito de proporcionar uma maneira assíncrona de enviar leads para o Zenvia Conversion, permitindo receber um webhook contendo os resultados. Saiba neste artigo os requisitos e como utilizar esta API na sua conta.
⚠️ Atenção: A integração de uma API demanda conhecimento técnico avançado, portanto, é importante contar com a ajuda de um desenvolvedor.
Authentication
As solicitações feitas à API devem incluir uma chave de API válida como um parâmetro de cabeçalho. Por exemplo:
Para acessar a API, é importante incluir uma chave de API válida no cabeçalho das solicitações. Isso ajuda a garantir a segurança e o correto processamento das informações. Veja um exemplo:
var headers = {
'x-api-key': 'YOUR-API-KEY',
'Content-Type': 'application/json'
}Endpoint
O Endpoint desta API está disponível em: https://conversion.zenvia.com/#tag/Leads
Request
Send Retail Lead
Production API server: https://conversion.zenvia.com/#operation/newRetailLead
Processa dados de leads e retorna o prospect correspondente. Se o prospect já existir, os dados anteriores do lead não serão retornados. Apenas para a indústria varejista.
Send Insurance Lead
Production API server: https://conversion.zenvia.com/#operation/newInsuranceLead
Processa dados de leads e retorna o prospect correspondente. Se o prospect já existir, os dados anteriores do lead não serão retornados. Apenas para a indústria de seguros.
Send Automotive Lead
Production API server: https://conversion.zenvia.com/#operation/newVehicleLead
Processa dados de leads e retorna o prospect correspondente. Se o prospect já existir, os dados anteriores do lead não serão retornados. Apenas para a indústria automotiva (veículos).
Send Saving Plan Lead
Production API server: https://conversion.zenvia.com/#operation/newSavingPlanLead
Processa dados de leads e retorna o prospect correspondente. Se o prospect já existir, os dados anteriores do lead não serão retornados. Apenas para a indústria de planos de economia/investimento.
Send Real Estate Lead
Production API server: https://conversion.zenvia.com/#operation/newRealEstateLead
Processa dados de leads e retorna o prospect correspondente. Se o prospect já existir, os dados anteriores do lead não serão retornados. Apenas para a indústria imobiliária.
Response
202 ACCEPTED
{
"message": "Lead accepted",
"code": "202",
"correlationId": "{Generated UUID for webhook reference}"
}É importante que o usuário salve o correlationId para correlacionar a resposta que será enviada posteriormente na sessão do Webhook.
403 FORBIDDEN
{
"message": "{MESSAGE}",
"error": "Forbidden",
"statusCode": 403
}Where {MESSAGE} can be:
- 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
Quando o cliente envia um lead com sucesso, um correlationId será fornecido e aqui será usado para correlacionar a resposta à postagem feita pelo cliente. Ele possui o seguinte formato:
{
"response": "{RESPONSE}",
"correlationId": "{Generated UUID for webhook reference}"
}Where {RESPONSE} has the same format as the response from the v1 API, with one added response:
{
"code": "500",
"message": "The server is temporarily unavailable. Please try again later.",
