API#

A seção API permite consultar a documentação para conexão ao servidor pela API e criar tokens de acesso.

Abra API no menu esquerdo. Se o item não aparecer, clique na engrenagem ao lado do seu nome de usuário e fixe API nas configurações do menu.

1. Documentação Swagger#

A guia Swagger contém a referência da API no formato Swagger.

As informações estão agrupadas por seção do Sherpa Process Discovery.

2. Documentação ReDoc#

A guia ReDoc contém a referência da API no formato ReDoc.

As informações também estão agrupadas por seção do Sherpa Process Discovery.

3. Tokens#

A guia Token lista os tokens de API criados no sistema.

A tabela mostra o nome, as funções atribuídas, a data e a hora de expiração e a data de criação de cada token. É possível criar, filtrar, editar e excluir tokens.

Criar um token#

Clique em Criar token para abrir a janela de criação.

Informe um nome, selecione a função que define as ações permitidas e defina a data de expiração. Se necessário, marque Sem prazo de validade. Clique em Criar token para concluir ou Cancelar para fechar sem salvar.

4. Uso de tokens e datas na API#

Para chamar um método protegido da API, envie o token criado no cabeçalho Authorization: Basic <Base64(token)>: codifique em Base64 o valor do próprio token, sem nome de usuário, dois pontos ou senha. Por exemplo, para example-token o cabeçalho é Authorization: Basic ZXhhbXBsZS10b2tlbg==. O token permite apenas as ações concedidas pelos seus Papéis. Procure um administrador se precisar de permissões adicionais. Envie o cabeçalho somente por HTTPS e armazene o token original como segredo.

As respostas da API v1 retornam datas e horários em UTC com o sufixo Z, por exemplo 2026-05-15T10:00:00.123456Z. Nos filtros e campos de data das requisições, use RFC 3339 com fuso horário explícito: Z ou um deslocamento como +03:00. Não envie valores sem fuso horário, pois eles não identificam um instante único.