Tote
HomeAPIsGuiasRelease Notes
HomeAPIsGuiasRelease Notes
Fale conosco
Manuais
Artigos
Manuais
Artigos
  1. Manuais
  • Boas vindas!
  • Visão geral da plataforma
  • Como se autenticar
  • Testando APIs
  • Respostas e status
  • Nossas APIs
  • Glossário
  • Webhook
  • FAQ
  1. Manuais

Testando APIs

É possível testar nossos serviços aqui na plataforma para sentir um pouco a experiência dos nossos produtos.
O passo a passo abaixo fornece todas as informações necessárias, desde a obtenção do token de acesso até o envio de requisições e a interpretação das respostas recebidas.

Antes de começar a testar, é necessário obter o token de autenticação. Acesse o endpoint de autenticação. Clique aqui para ler o passo a passo de como se autenticar.

Passo a passo#

1
Escolha a API e o endpoint:
Você deve escolher a API desejada e o endpoint específico que quer acessar. No exemplo, o endpoint escolhido é o "Enviar mensagem SMS", parte da API Broker.
teste-broker.png
Figura 1. Endpoint e botão para acesso à plataforma de testes
2
Adicione o token de acesso no header
Copie o access_token obtido através do endpoint de autenticação e o insira no campo Token na aba Auth.
auth-teste.png
Figura 3. Aba Auth para inserção do acess_token.
3
Preencha os campos obrigatórios
Insira os dados nos campos obrigatórios no corpo da requisição. No exemplo, os campos já estão preenchidos para facilitar o teste, proporcionando uma experiência mais simples e rápida.
Os campos são:
mensagem: Mensagem a ser enviada.
numeroCelular: Número de celular do destinatário.
teste-teqbody.png
Figura 2. Envio de requisição para obter a resposta do endpoint.
Para garantir uma experiência mais rápida e eficiente durante o teste, os campos já estão preenchidos com as informações de exemplo disponibilizadas na documentação. Caso algum campo não esteja preenchido ou precise ser alterado, é possível inserir as informações manualmente.
teste-paramreqbody.png
Figura 3. Documentação do request body contendo os valores de exemplo usados para o teste
4
Envie a requisição
Clique no botão enviar para enviar a requisição.
teste-enviar.png
Figura 4. Ambiente de teste com todas as informações necessárias para requisição.
5
Receba a resposta
O sistema retorna uma resposta indicando o sucesso ou falha da operação, junto com os detalhes necessários. Leia o guia sobre códigos de erros e respostas para saber mais!
teste-response.png
Figura 5. Resposta obtida pela requisição. Código 200 significa sucesso.
É válido lembrar que o Horizon não retorna campos vazios. Para mais detalhes, você pode verificar nossas diretrizes básicas.
Após testar as APIs no nosso ambiente de teste, você pode obter um ambiente de homologação exclusivo para suas necessidades. Para isso, entre em contato com o time de Customer Supply.
O ambiente de teste possui um .sb em sua URL. Verifique sempre qual ambiente está sendo usado para uma melhor experiência!

Materiais relacionados#

Como se autenticar para testar APIs
Nossas APIs
Sobre nossas APIs
Precisa de mais ajuda? Entre em contato com o nosso suporte.

Clique no botão abaixo para nos contar o que achou da nova plataforma. Você será redirecionado para um formulário rápido.
Enviar feedback
Página anterior
Como se autenticar
Próxima página
Respostas e status