Conectando o Findor.ai com a sua API

Siga as instruções abaixo para integrar seu personagem via API.

Configuração inicial

Antes de começar a enviar e receber mensagens através da nossa API, você precisa configurar a integração corretamente. Abaixo estão os detalhes sobre os campos que você precisa preencher:

Token:

• Descrição: Você precisará nos fornecer um token de autenticação que enviaremos na requisição da resposta do personagem para confirmar que as mensagens enviadas para o seu webhook são originadas do nosso serviço.
• Utilização: Este token será enviado no cabeçalho da requisição HTTP, na chave Authentication, precedido pelo prefixo “Bearer”.

URL:

• Descrição: URL do webhook que receberá as respostas das mensagens enviadas.
• Utilização: Esta URL será utilizada como destino para as respostas das mensagens processadas.

Métodos

Enviar Mensagem para o Personagem

• Método: POST
• URL: https://company-gateway-dot-findor-chat.uc.r.appspot.com/message_webhook
• Cabeçalhos:
  • Authorization: Bearer {token que informamos}
• Corpo da Requisição:

Parâmetro	Tipo	Obrigatório	Descrição	Valores válidos
user_identifier	String	Sim	Identificador único do cliente que está enviando a mensagem.
username	String	Sim	Nome do cliente associado a essa mensagem.
msg_id	Number	Sim	ID da mensagem.
msg_type	String	Sim	Tipo da mensagem.	“text”, “image”, “video”, “doc”
msg_content	Object/String	Sim	Conteúdo da mensagem.

Se o msg_type for diferente de “text”, o msg_content deve ser um objeto contendo a chave “url” com a URL do arquivo enviado. Caso contrário, msg_content deve ser uma string com o conteúdo da mensagem.

• Resposta:
  • Sucesso: 200 OK
  • Corpo da Resposta: Vazio
• Possíveis códigos de Erro:
  • 400 Bad Request: Requisição inválida. Verifique se todos os parâmetros obrigatórios foram fornecidos corretamente.
  • 401 Unauthorized: Falha na autenticação. Verifique se o token de autenticação está correto.
  • 500 Internal Server Error: Erro interno do servidor.

Exemplo de requisição via cURL:

curl --location 'https://company-gateway-dot-findor-chat.uc.r.appspot.com/company/message_webhook' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZF9hZ2VudCI6MjUwLCJjaGFubmVsIjoiY29tcGFueV9hcGkifQ.i7X7oXhMFQ__dGN7SSb96WZgsqRKzdd3YDjAsD' \
--header 'Content-Type: application/json' \
--data '{
    "user_identifier": "uuid123",
    "username": "Carlos",
    "msg_id": 4,
    "msg_content": "enviando mensagemd de teste",

    "msg_type": "text"

}'

Receber Resposta do Personagem

Após receber e processar a mensagem, o serviço enviará a resposta do personagem para o webhook cadastrado.

• Método: POST
• URL: (enviaremos a resposta do personagem para a url definida nas configurações)
• Cabeçalhos:
  • Authorization: (enviaremos o token que foi definido por vocẽ nas configurações)
• Corpo da Requisição:

Campo	Tipo	Descrição
id_message	Number	ID da mensagem correspondente.
msg_type	String	Tipo da mensagem. Pode ser “text”, “image”, “video” ou “doc”.
msg_content	String/Object	Conteúdo da mensagem.
user_sender	String	Identificador único do remetente da mensagem.

Se o msg_type for diferente de “text”, o msg_content terá um objeto contendo a chave “url” com a URL do arquivo. Caso contrário, msg_content será uma string com o conteúdo da mensagem.