API REST¶

Administradores criam tokens Bearer com escopos definidos para aplicativos externos.

Visão geral¶

Esta página descreve o uso e os principais efeitos de API REST. Se as alterações afetarem tickets, permissões, notificações ou automações existentes, elas deverão ser verificadas primeiro em um ambiente de teste.

Fluxo de trabalho típico¶

Pesquisar um usuário para um token. Use as visões disponíveis de pesquisa, filtro e detalhes. Limpe ou altere os filtros se os registros esperados não aparecerem.
Criar token com nome e escopos. Abra o formulário de administração ou ação correspondente, informe os valores necessários e salve somente depois de verificar as atribuições e os campos obrigatórios.
Copiar com segurança o valor do token. Execute a função no formulário previsto e verifique imediatamente o resultado na visão correspondente ou no ticket afetado.
Desativar o token. Verifique primeiro quais registros ou usuários existentes serão afetados. Sempre que possível, use a desativação em vez da remoção definitiva.
Entender o registro de requisições e a idempotência. Execute a função no formulário previsto e verifique imediatamente o resultado na visão correspondente ou no ticket afetado.
Abrir a descrição OpenAPI. Execute a função no formulário previsto e verifique imediatamente o resultado na visão correspondente ou no ticket afetado.

Observações¶

Os itens de menu e as ações visíveis dependem das permissões de grupo e de programa do agente conectado.
As entradas desativadas geralmente são mantidas para tickets e avaliações existentes, mas não ficam mais disponíveis para novas atribuições.
Após as alterações, teste pelo menos um caso de uso realista com um usuário da função afetada.