API

---

Autenticação

Esse procedimento envolve a autenticação do usuário, permitindo a realização das próximas requisições com parâmetros de segurança.

Ao acessar o swager API documentation, preencha os parâmetros como consta na imagem a abaixo:

Get /solution/token/basic/{plataform_id}

Retorna um token complexo com base na autenticação básica.

Parameters Name Description

platform_id (path) Platform_id string

time (query) Time parameter string time

Responses

Code Description

🟢200 Successful operation

Exemplo de Successful operation:

{
  "token": "string"
}

---

Seleção do server

O acesso à API é feito através de um token de uso exclusivo enviado para cada cliente.

Ao acessar o swager API documentation, selecione o server em que deseja acionar a API.

Caso queira testar antes de subir para produção, selecione a opção Development server.

Server

https://dev-api.weclever.co - Development server https://api.weclever.co - Production server

---

Busca dos leads por data

Essa chamada permite que você busque todos os leads com atendimentos finalizados entre uma data específica de início e fim.

Em seguida preencha os dados com os seguintes parâmetros:

Get /lead/find/finalized/{firstDate}/{lastDate}

Get Todos os leads finalizados entre duas datas

Returns Todos os leads finalizados entre duas datas

Parameters Name Description

First date (path) Date in the format YYYY-MM-DD or YYYY-MM-DD+HH:mm:ss

Last date (path) Date in the format YYYY-MM-DD or YYYY-MM-DD+HH:mm:ss

Responses

Code Description

🟢200 Successful operation

Exemplo de Successful operation:

  {"leads": [
    {
      "weclever_lead_id": 0,
      "mapped_status": "string",
      "client_lead_id": "Unknown Type: string,integer,null"
    }
  ]
} 

---

Busca por informações do lead

A próxima requisição, refere-se a busca por todas as informações referentes aos leads através do weclever_id.

Get /lead/find/weclever_id/{id}

Get todas as informações disponíveis do lead Returns todas as informações disponíveis do lead por weclever_id

Parameters

Name Description

Id O parametro id é um número inteiro como 123456

Responses

Code Description

🟢500 Successful operation.

Exemplo:

{
  "lead": {
    "email": "string",
    "name": "string",
    "phone": "string",
    "state": "string",
    "regional": "string",
    "chats": {
      "metrics": {
        "date_difference": "string",
        "total_messages": 0
      },
      "messages": [
        {
          "id_chat": 0,
          "body": "string",
          "media_url": "string",
          "content_type": "string",
          "date_created": "string",
          "sid": "string",
          "message_type": "string",
          "direction": "string",
          "status": "string"
        }
      ]
    },
    "feelings": {
      "total_messages": 0,
      "positive_feeling": 0,
      "neutral_feeling": 0,
      "negative_feeling": 0
    },
    "csat": {
      "message": "string",
      "rating": "string"
    },
    "status": "string"
  }
}

Após os dados preenchidos selecione o ícone try out para receber as insformações solicitadas na requisição.

Dúvidas em como realizar as integrações? Fale com nossa equipe pelo email [email protected] e vamos auxiliá-lo nesse processo! 🤗