Chat Pró Oratrix: Como encontrar a API

Chatbot Pró da Oratrix
1

Chat Pró Oratrix: Como encontrar a API do Chat Pró Oratrix

:warning: Atenção: este artigo é voltado para desenvolvedores

A API do Chat Pró Oratrix é indicada para pessoas com conhecimento técnico em integração de sistemas, requisições HTTP, tokens de acesso, endpoints e ferramentas como Postman.

Caso você não seja desenvolvedor ou não tenha familiaridade com integração de sistemas, é aconselhável contratar um desenvolvedor ou solicitar apoio técnico especializado antes de realizar qualquer configuração.

:parrot: SERVIÇO

Serviço: Chat Pró Oratrix

:receipt: VISÃO GERAL

A API do Chat Pró Oratrix permite que sistemas externos se comuniquem com a plataforma do Chat Oratrix. Ela pode ser usada para integrações com CRMs, ERPs, sistemas próprios, automações e outras ferramentas externas.

Neste artigo, você aprenderá onde encontrar o endereço principal da API e onde acessar a documentação no Postman, que mostra os exemplos de uso, rotas disponíveis e informações necessárias para integração.

Este procedimento deve ser feito com cuidado, pois o uso incorreto da API pode causar falhas na integração, envio incorreto de informações ou dificuldades no funcionamento esperado do sistema.

:compass: PASSO A PASSO GUIADO

1. Entenda o que é a API do Chat Pró Oratrix

  1. A API é um endereço técnico usado para comunicação entre sistemas.
  2. Ela não é uma tela comum do painel de atendimento.
  3. Ela normalmente é usada por desenvolvedores para conectar outro sistema ao Chat Pró Oratrix.
  4. O uso da API pode envolver envio e recebimento de informações automaticamente.

:pushpin: Exemplo: um sistema externo pode usar a API para consultar informações, enviar dados ou integrar processos com o Chat Pró Oratrix.

2. Acesse o endereço da API

  1. Abra o navegador de internet no computador.
  2. Clique na barra de endereço do navegador.
  3. Digite ou copie o endereço abaixo:
https://pro1.oratrixchat.com.br/api-service
  1. Pressione Enter no teclado.
  2. Aguarde o carregamento da página.

:white_check_mark: Esse é o endereço base do serviço de API do Chat Pró Oratrix.

3. Entenda o que pode aparecer ao abrir o link da API

Ao acessar o link da API pelo navegador, pode acontecer uma destas situações:

  • A página pode abrir com uma resposta técnica.
  • A página pode mostrar uma mensagem simples.
  • A página pode retornar erro de acesso.
  • A página pode não exibir uma tela visual parecida com o painel do Chat.

:warning: Isso é normal. A API não funciona como uma página comum para o usuário clicar e navegar. Ela foi feita para ser acessada por sistemas, integrações ou ferramentas técnicas.

4. Acesse a documentação da API no Postman

  1. Abra uma nova aba no navegador. Copie o link abaixo:
  1. Cole o link na barra de endereço do navegador.
  2. Pressione Enter.
  3. Aguarde a documentação carregar.

:white_check_mark: A documentação no Postman é o local onde o desenvolvedor poderá consultar os exemplos e instruções de uso da API.

5. Entenda para que serve o Postman

O Postman é uma ferramenta muito usada por desenvolvedores para testar APIs.

Na documentação do Postman, o desenvolvedor poderá encontrar informações como:

  • Endereços de acesso da API.
  • Tipos de requisição, como GET, POST, PUT ou DELETE.
  • Exemplos de envio de dados.
  • Exemplos de resposta da API.
  • Campos obrigatórios.
  • Estrutura dos dados.
  • Possíveis retornos do sistema.

:pushpin: O Postman ajuda o desenvolvedor a testar a integração antes de colocar o sistema em funcionamento definitivo.

6. Verifique se você possui as credenciais necessárias

Confirme com a Oratrix se sua conta possui permissão para usar a API.
Verifique se foi fornecido algum token, chave de acesso ou credencial.
Nunca compartilhe essas informações em grupos, mensagens públicas ou com pessoas não autorizadas.
Caso não tenha recebido os dados de acesso, solicite orientação ao suporte da Oratrix.

:warning: Sem as credenciais corretas, a integração pode não funcionar.

7. Informe os links ao desenvolvedor responsável

Caso outra pessoa vá realizar a integração, envie para ela estas informações:

Endereço base da API:

Documentação Postman:

Também informe ao desenvolvedor:

  • Qual integração precisa ser feita.
  • Qual sistema será conectado ao Chat Pró Oratrix.
  • Quais informações devem ser enviadas ou recebidas.
  • Qual canal será usado na integração.
  • Se já existem credenciais de acesso disponíveis.

:white_check_mark: Quanto mais claras forem as informações, mais fácil será para o desenvolvedor realizar a integração corretamente.

8. Teste a API antes de usar em produção

  • 1. Peça ao desenvolvedor para testar a API no Postman.
  • 2. Confirme se as respostas estão corretas.
  • 3. Verifique se os dados enviados estão chegando corretamente.
  • 4. Confira se o sistema externo está interpretando as respostas da API.
  • 5. Somente depois dos testes, coloque a integração em uso real.

:warning: Nunca coloque uma integração em funcionamento sem testes. Isso ajuda a evitar erros no atendimento e perda de informações.

9. Em caso de erro, registre as informações antes de chamar o suporte

Se a API apresentar erro, colete estas informações antes de abrir chamado:

  • Link utilizado.
  • Horário do teste.
  • Método usado na requisição.
  • Mensagem de erro exibida.
  • Print da tela, se possível.
  • Corpo da requisição enviada, ocultando dados sensíveis.
  • Resposta recebida da API.
  • Nome do sistema que está tentando integrar.

:pushpin: Essas informações ajudam o suporte ou o desenvolvedor a identificar o problema com mais rapidez.

:warning: OBSERVAÇÕES IMPORTANTES

  • :warning: A API é uma ferramenta técnica e deve ser usada por desenvolvedores.
  • :warning: O link da API não é uma tela comum do painel do Chat Pró Oratrix.
  • :warning: O Postman serve para consulta e testes técnicos.
  • :warning: Credenciais, tokens e chaves de acesso são informações sensíveis.
  • :warning: Nunca compartilhe tokens em grupos, prints públicos ou conversas sem segurança.
  • :warning: O uso incorreto da API pode causar falhas na integração.
  • :warning: A disponibilidade de recursos pode variar conforme o plano contratado.
  • :warning: Algumas rotas podem exigir permissão específica da conta.

:gear: DICAS E BOAS PRÁTICAS

  • Contrate um desenvolvedor caso não tenha conhecimento técnico em APIs.
  • Teste todas as rotas no Postman antes de usar em produção.
  • Guarde tokens e credenciais em local seguro.
  • Não exponha dados sensíveis em prints ou mensagens.
  • Documente quais sistemas estão integrados ao Chat Pró Oratrix.
  • Evite alterar integrações que já estão funcionando sem antes fazer backup ou testes.
  • Abra chamado com informações completas caso precise de suporte.

:bar_chart: RESULTADO ESPERADO

Após seguir este guia, o usuário ou desenvolvedor saberá onde encontrar o endereço da API do Chat Pró Oratrix e onde consultar a documentação oficial no Postman.

Com isso, será possível iniciar os testes técnicos e preparar integrações entre o Chat Pró Oratrix e outros sistemas externos.

:white_check_mark: O resultado esperado é que o desenvolvedor tenha acesso aos links corretos para iniciar a integração com segurança.

:receipt: RESUMO FINAL

Com este procedimento, você aprendeu onde encontrar a API do Chat Pró Oratrix e como acessar a documentação no Postman.

A API está disponível em:

A documentação está disponível em:

Este recurso é indicado para desenvolvedores. Caso você não tenha conhecimento técnico, é recomendável contratar um profissional para realizar a integração corretamente.

:label: KEYWORDS

API, Chat Pró Oratrix, Postman, integração, desenvolvedor

:robot: Peça ajuda ao ChatGPT da Oratrix

A I.A. da Oratrix no ChatGPT poderá tirar dúvidas e te guiar passo a passo no suporte.