Pular para o conteúdo principal

Testar API

A funcionalidade Testar API disponibiliza um Swagger UI integrado diretamente no Galaxy Chat, permitindo explorar, documentar e executar chamadas reais à API da plataforma sem sair do sistema.

Onde fica: Configurações › Automação e Integrações › Testar API

🎯 Para que serve​

UsoDescrição
Explorar endpointsVeja todos os endpoints disponíveis e seus parâmetros
Testar chamadasExecute requisições reais com o token da sua empresa
Depurar integraçõesIdentifique erros antes de colocar a integração em produção
Documentação interativaVeja exemplos de requisição e resposta para cada endpoint

🔑 Autenticação​

Para executar chamadas na interface de teste, você precisará do seu token de API:

  1. Acesse Configurações › Automação e Integrações › API REST.
  2. Copie o token de acesso da sua empresa.
  3. Na tela Testar API, clique no botão Authorize (🔒).
  4. Cole o token no campo e confirme.
  5. Agora você pode executar chamadas autenticadas diretamente no Swagger UI.
⚠️

Nunca compartilhe seu token de API em prints, vídeos, grupos ou repositórios de código públicos. Ele concede acesso total aos dados da sua empresa e deve ser tratado como uma senha.

📋 Principais endpoints disponíveis​

Contatos​

  • GET /contacts — Listar todos os contatos
  • POST /contacts — Criar novo contato
  • PUT /contacts/{id} — Atualizar contato existente
  • DELETE /contacts/{id} — Remover contato

Tickets / Conversas​

  • GET /tickets — Listar tickets com filtros
  • POST /tickets — Criar novo ticket
  • PUT /tickets/{id} — Atualizar status, atribuição ou etiquetas
  • POST /tickets/{id}/messages — Enviar mensagem em um ticket existente

Mensagens​

  • POST /messages — Enviar mensagem ativa para um número
  • GET /messages/{ticketId} — Listar mensagens de um ticket

Canais​

  • GET /inboxes — Listar todos os canais conectados

Webhooks​

  • POST /webhook_subscriptions — Cadastrar URL de webhook para receber eventos

🛠️ Como executar uma chamada de teste​

  1. Na tela Testar API, localize o endpoint desejado na lista.
  2. Clique sobre ele para expandir os detalhes.
  3. Clique em Try it out.
  4. Preencha os parâmetros necessários (query, body, path params).
  5. Clique em Execute.
  6. Veja a resposta da API em tempo real, com:
    • Código de status HTTP (200, 201, 400, 401, 500...)
    • Corpo da resposta em JSON
    • Headers retornados

🔗 Veja também​

  • API REST — documentação completa da API e como integrá-la ao seu sistema
  • Webhooks — receba eventos do Galaxy Chat no seu sistema
Última atualização em