Conexão adaptada de leads

Introdução

A conexão adaptada entre portais imobiliários e o Tecimob pode ser feita através da nossa API Rest. É necessário o portal envie ao Tecimob uma requisição http a cada novo lead que deseje cadastrar, a requisição deve ser feita utilizando o verbo http POST e o corpo da requisição deve ser um json, por fim é necessário utilizar o padrão de autenticação Basic Auth. Caso você não conheça o Basic Auth, segue o link da documentação: https://en.wikipedia.org/wiki/Basic_access_authentication.

Autorização

Somente serão autorizadas pela API Tecimob as requisições que utilizar o Basic Auth, que resumidamente se trata da adição do header Authorization no cabeçalho na requisição http, junto com um usuário e senha codificados em base64, como no exemplo a seguir Authorization:
Basic dml2YXJlYWw6NTk0RjgwM0IzODBBNDEzOTZFRDYzREM1ND=

Durante a fase de homologação do portal devem ser utilizadas as seguintes credenciais, usuário: portal-teste e senha: 1234. Após a homologação ser feita, deve ser solicitado a equipe do tecimob um usuário e senha definitivos para o portal, com o qual a API do tecimob irá utilizar para identificar o portal de origem do lead.

E-mail de contato da equipe: suporte@tecimob.com.br.

Montagem do header Authorization

- Junção das credenciais: portal-teste:1234
- Codificação para base64: cG9ydGFsLXRlc3RlOjEyMzQ=
- Adição do prefixo: Basic cG9ydGFsLXRlc3RlOjEyMzQ=

Corpo da Requisição

O corpo da requisição deve ser um json com os seguintes campos:
- clientListingId: identificador do imóvel no tecimob;
- name: nome do cliente;
- email: e-mail de contato do cliente;
- phoneNumber: número de telefone do cliente com o DDD;
- message: mensagem enviada pelo cliente no contato.

URL

Durante a fase de homologação as requisições deverão ser feitas para POST https://api.gerenciarimoveis-cf.com.br/api/integrations/portals/leads/2

Após homologado serão liberadas pela equipe do tecimob as credenciais de autenticação do portal. A partir deste ponto as requisições deverão ser feitas para POST https://api.gerenciarimoveis-cf.com.br/api/integrations/portals/leads/{serial-imob}.

O trecho da url {serial-imob} deve ser substituído pelo serial da imobiliária no tecimob.

Exemplo para Teste

Url
POST https://api.gerenciarimoveis-cf.com.br/api/integrations/portals/leads/2

Headers
Authorization: Basic cG9ydGFsLXRlc3RlOjEyMzQ=
Content-Type: application/json

Body
{
"clientListingId": "128",
"email": "billiejoe@teste.net",
"message": "Olá, Gostaria de ter mais informações sobre o apartamento",
"name": "Billie Joe",
"phoneNumber": "48998565592"
}

Tipos de respostas

A api irá responder com diferentes HTTP Status caso a requisição tenha sido bem sucedida ou tenha ocorrido um erro.
- 204 No Cotent: Sucesso;
- 400 Bad Request: normalmente ocorre quando está faltando um campo no body;
- 401 Unauthorized: credenciais inválidas;
- 5XX: erro interno do servidor.