Skip to main content
Uma versão mais recente deste produto está disponível.
O português é fornecido por meio de tradução automática para sua conveniência. O inglês precede o português em caso de inconsistências.

Emissão de solicitações de API

Colaboradores
PDFs

A interface do usuário Swagger fornece detalhes completos e documentação para cada operação da API.

O que você vai precisar

  • Você deve estar conetado ao Gerenciador de Grade usando um navegador compatível.

  • Você deve ter permissões de acesso específicas.

Importante Todas as operações de API que você executa usando a página da Web do API Docs são operações ativas. Tenha cuidado para não criar, atualizar ou excluir dados de configuração ou outros dados por engano.
Passos

  1. Selecione Ajuda > Documentação da API no cabeçalho do Grid Manager.

  2. Selecione a operação desejada.

    Ao expandir uma operação de API, você pode ver as ações HTTP disponíveis, como GET, PUT, UPDATE e DELETE.

  3. Selecione uma ação HTTP para ver os detalhes da solicitação, incluindo o URL do endpoint, uma lista de todos os parâmetros necessários ou opcionais, um exemplo do corpo da solicitação (quando necessário) e as possíveis respostas.

    Exemplo de Swagger UI

  4. Determine se a solicitação requer parâmetros adicionais, como um grupo ou ID de usuário. Em seguida, obtenha esses valores. Talvez você precise emitir uma solicitação de API diferente primeiro para obter as informações de que precisa.

  5. Determine se você precisa modificar o corpo de solicitação de exemplo. Em caso afirmativo, você pode clicar em modelo para aprender os requisitos para cada campo.

  6. Clique em Experimente.

  7. Forneça quaisquer parâmetros necessários ou modifique o corpo do pedido conforme necessário.

  8. Clique em Executar.

  9. Revise o código de resposta para determinar se a solicitação foi bem-sucedida.