API Playground

O API Playground permite que você teste a API REST do PlatoForms em um formulário específico, usando os dados reais desse formulário e um token de API preenchido automaticamente. Você pode escolher um endpoint, ver exemplos de código prontos para execução em várias linguagens e executar uma solicitação ao vivo sem escrever nenhum código. Este guia cobre como acessar o Playground e usá-lo para explorar um endpoint.

Acessar o API Playground

1. Passe o mouse sobre o formulário desejado no Dashboard e clique no ícone de Configurações (engrenagem) no canto superior direito.

2. Clique em Gerenciar formulário para abrir as configurações do formulário.

   

3. Na barra lateral esquerda, em Conectar, selecione API playground.

Pré-requisitos

Para usar o API Playground para um formulário, os seguintes requisitos devem ser atendidos:

• O formulário deve estar publicado.
• O formulário deve ter pelo menos uma submissão.
• Sua equipe deve estar em um plano de teste gratuito ou plano pago.
• Seu endereço de e-mail deve estar verificado.

Se algum desses requisitos ainda não estiver atendido, a página mostrará Algumas coisas primeiro, com cada requisito marcado como atendido ou não, junto com o motivo quando não estiver (por exemplo, “Nenhuma submissão registrada ainda.”).

Se sua equipe não concedeu acesso à API para sua conta, você também verá um cartão para sua equipe com um botão Solicitar Acesso. Clique nele para notificar o administrador da sua equipe.

Uma vez que tudo esteja atendido, a página mostra o Token de API do seu formulário no topo, pronto para uso nas solicitações abaixo.

Explorar endpoint de API

O API Playground oferece testes para a maioria dos principais endpoints de API sem a necessidade de codificação. Os endpoints são agrupados por categoria. Formulário, Formulários, Convite, Eu, Submissão e mais.

1. Clique em Escolher um endpoint de API para explorar e selecione um endpoint da lista suspensa. Cada endpoint mostra seu método HTTP (por exemplo GET), uma breve descrição do que ele faz e a rota que ele chama (por exemplo, GET /v4/form/{form_id}/).

   

   Note

   Para mais detalhes sobre cada endpoint, consulte nossa Documentação de API através do botão API docs.

2. Se você estiver familiarizado com programação, pode copiar o código de exemplo fornecido em várias linguagens, incluindo comandos de shell usando Curl, Python, JavaScript, Java ou Golang. O token de API do seu formulário já está preenchido, então a solicitação está pronta para ser executada como está.

   

3. Clique em Executar teste para fazer uma solicitação e gerar uma resposta.

   

   Uma vez que a solicitação é concluída, a resposta mostra o código de status HTTP e quanto tempo a solicitação levou, junto com o JSON retornado. Se a resposta incluir uma URL, você pode clicar nela para testar a funcionalidade ou seguir o link para visualizar o formulário submetido.

Tutorial em vídeo