Integração Geral (API)

Guia de Integração para Envio de Leads via API

Antes de enviar o lead, é recomendado consultar as credenciais necessárias (X-API-KEY e X-Agent-Name). Você pode realizar essa configuração nesta documetação do link abaixo, na sessão Integração de Acesso Geral

Habilitando Integração de Leads

Requisição

Para enviar um lead, é necessário fazer uma requisição do tipo POST para o seguinte endereço:

POST https://crm-leadmanager-leadreceiver-api.gestao.prod.olxbr.io/v1/addLeads

A requisição deve conter os seguintes parâmetros no cabeçalho:

• X-API-KEY
• X-Agent-Name
• accept: application/json: Especifica que o tipo de conteúdo esperado na resposta é JSON.
• Content-Type: application/json: Indica que o corpo da solicitação está em formato JSON.

Corpo da Solicitação (Payload)

O corpo da solicitação deve ser um objeto JSON contendo os seguintes campos:

{
  "LeadName": "string",
  "LeadEmail": "string",
  "LeadTelephone": "string",
  "Message": "string",
  "ExternalId": "string",
  "BusinessType": ["SALE", "RENTAL"],
  "BrokerEmail": "string",
  "LeadOrigin": "string"
}

Exemplo de Requisição com CURL

curl -X 'POST' \
'https://crm-leadmanager-leadreceiver-api.gestao.prod.olxbr.io/v1/addLeads' \
-H 'accept: application/json' \
-H 'X-Agent-Name: colocar-agent-name' \
-H 'X-API-KEY: colocar-api-key' \
-H 'Content-Type: application/json' \
-d '{
"LeadName": "string",
"LeadEmail": "string",
"LeadTelephone": "string",
"Message": "string",
"ExternalId": "string",
"BusinessType": "SALE",
"BrokerEmail": "string",
"LeadOrigin": "string"
}'

Substitua os valores de string no corpo da solicitação pelos dados reais do lead que você deseja adicionar. As informações de cabeçalho, como X-Agent-Name e X-API-KEY, devem ser substituídas pelos valores apropriados fornecidos a você.

Resposta

Uma solicitação bem-sucedida retornará uma resposta "HTTP 200 OK" com detalhes do lead adicionados no corpo da resposta, em formato JSON.

Teste

Para testar o envio de lead, você pode acessar o Swagger da API no seguinte endereço:

Swagger API

e inserir os valores de Agent Name e Api key respectivamente.