O Harry possui API's (Application Programming Interface) para integração com parceiros e clientes, todas nossas API's seguem a arquitetura REST e sua comunicação é através do protocolo https.

Para ter acesso as nossas API's, solicite ao nosso suporte através do e-mail developer@goharry.com.br

Ambiente de HOMOLOGAÇÃO

https://apihml.goharry.com.br

Ambiente de PRODUÇÃO

https://api.goharry.com.br

Aqui no Harry utilizamos as melhores práticas de desenvolvimento pensando nos nossos clientes e parceiros.

Todas as nossas APIs seguem um ciclo de vida para absorver a constante evolução dos nossos produtos, para que isso não impacte nossos clientes as APIs são versionadas garantindo a retrocompatibilidade com todos os nossos consumidores.

Este documento está na versão 1.6.0 da API, na qual foi adicionado a API para consulta de atendimentos pela imobiliária. Use está tabela para encontrar a descrição das versões anteriores:

Atualmente utilizamos os métodos de autenticação:

HTTP Basic que consiste em adicionar o usuário e senha no header Authorization da requisição HTTP

Authorization: Basic <credenciais em Base64 no formato: usuário:senha>

Api Key que consiste em enviar um ApiKey como query string.

https://host/path?api_key=102930405060708089

Todas API's utilizam o padrão HTTP status codes para indicar o sucesso ou erro da requisição. O corpo da resposta será JSON no seguinte formato:

{
  "code": "400",
  "status": "Bad Request",
  "message": "MISSING_REQUEST_PARAMETER",
  "description": "Erro de validação",
  "correlationId": "d3e37230-10eb-47a6-a43e-88f5bbc2de58"
}

O webhook é a maneira mais simples do Harry se comunicar com o seu sistema quando um evento ocorrer. Cadastrando um webhook, o seu sistema será avisado pelo Harry sempre que um dos eventos abaixo ocorrer.

O Harry irá realizar uma requisição POST para sua aplicação e a mesma deve retornar o um status da classe 200 quando receber um webhook, caso contrário o Harry irá retentar 3 vezes.

O Harry envia os seguintes eventos por webhook:

• customer_service_created (enviado quando um atendimento é criado)
• customer_service_status_changed (enviado quando a etapa de um atendimento é alterada)

Você poderá diferenciar o evento pelo atributo "eventType".

Exemplos:

{
  "eventType": "customer_service_created", // tipo do evento que gerou a chamada
  "customerService": {
    "id": 1234567, // Identificador do atendimento
    "businessType": "Vendas", // tipo do negócio
    "status": "Em atendimento", // nome da etapa atual do atendimento
    "createdAt": "2022-04-01T10:00:00", // data e hora da criação do atendimento
    "createdByAcquisitionChannel": "Site", // nome do canal de aquisição inicial
    "scheduledAt": "2022-04-15", // data para retornar depois
    "temperature": "morno", // temperatura do atendimento
    "updatedAt": "2022-04-01T10:15:00" // última atualização
    "customer": {  // dados do lead
      "email": "jose.silva@sememail.com",
      "name": "José da Silva",
      "phone": "11999990000"
    },
    "estateAgent": {  // dados do corretor dono do atendimento
      "email": "jose.almeida@sememail.com",
      "name": "José Almeida"
    },
    "properties": [  // lista de imóveis do atendimento
      {
        "acquisitionChannel": "Site", // Canal de aquisição que gerou o contato
        "createdAt": "2022-04-01T10:00:00", // Data e hora que o contato foi realizado
        "message": "Olá, gostaria de visitar o imóvel", // Mensagem enviada pelo lead na hora do contato
         "property": { // Dados do imóvel
          "code": "string",
          "url": "string",
          "amount": 0,
        },
        "interest": { // Dados do interesse do lead
          "level": "Baixo",
          "reason": "Busca outra localização",
          "observation": "Cliente não gostou do bairro"
        },
        "visit": {  // lista de visitas do atendimento
          "date":"2022-04-02", // Data da visita
          "startHour": "11:00", // Hora da visita
          "canceled": true, // Se a visita foi cancelada
          "canceledAt": "2022-04-01T11:00:00", // Quando a visita foi cancelada
          "finished": true, // Se a visita foi finalizada
          "finishedAt": "2022-04-01T12:00:00", // Quando a visita foi finalizada
          "reason": "Analisando a compra", // Motivo da finalização ou cancelamento da visita
          "feedback": "Cliente gostou do imóvel", // Feedback da visita
          "visitOwner": { // Corretor responsável pela visita
            "email": "jose.almeida@sememail.com",
            "name": "José Almeida"
          }
        },
        "customFields": [
            {
                "name": "Campanha",
                "value": "Lançamento"
            },
            {
                "name": "Plataforma",
                "value": "Facebook"
            },
            {
                "name": "Anúncio",
                "value": "Vídeo lançamento"
            }
        ]
      }
    ]
  },
  "originUser": { // dados do usuário que gerou o evento
    "email": "jose.almeida@sememail.com",
    "name": "José Almeida"
  }
}

Recursos utilizado pelos canais de aquisição para envio de novos leads

Recursos utilizado pela imobiliária para criação e leitura dos atendimentos

Recursos utilizado pelos parceiros para manipulação de visitas