API REST¶

Os administradores criam tokens Bearer com âmbitos definidos para aplicações externas.

Vista geral¶

Esta página descreve a utilização e os principais efeitos de API REST. Se as alterações afetarem tickets, permissões, notificações ou automatizações existentes, devem ser verificadas primeiro num ambiente de teste.

Fluxo de trabalho típico¶

Pesquisar um utilizador para um token. Utilize as vistas disponíveis de pesquisa, filtro e detalhe. Limpe ou altere os filtros se os registos esperados não aparecerem.
Criar um token com nome e âmbitos. Abra o formulário de administração ou ação correspondente, introduza os valores necessários e guarde apenas depois de verificar as associações e os campos obrigatórios.
Obter de forma segura o valor do token. Execute a função no formulário previsto e verifique imediatamente o resultado na vista correspondente ou no ticket afetado.
Desativar o token. Verifique primeiro quais os registos ou utilizadores existentes que serão afetados. Sempre que possível, utilize a desativação em vez da remoção definitiva.
Compreender o registo de pedidos e a idempotência. Execute a função no formulário previsto e verifique imediatamente o resultado na vista correspondente ou no ticket afetado.
Abrir a descrição OpenAPI. Execute a função no formulário previsto e verifique imediatamente o resultado na vista correspondente ou no ticket afetado.

Notas¶

Os itens de menu e as ações visíveis dependem das permissões de grupo e de programa do agente com sessão iniciada.
As entradas desativadas são frequentemente mantidas para tickets e avaliações existentes, mas deixam de estar disponíveis para novas atribuições.
Após as alterações, teste pelo menos um caso de utilização realista com um utilizador da função afetada.