Outros¶

API¶

Tela: /admin/api-docs

Objetivo¶

Consultar a especificação OpenAPI carregada no RR Flow e usar o testador integrado para validar endpoints da API.

Como usar¶

Acesse Outros > API.
Use JSON do OpenAPI quando quiser abrir a especificação bruta em outra aba.
Use Recarregar para atualizar a especificação exibida na tela.
No bloco Endpoints, selecione a rota e o método que deseja consultar.
No bloco Testar, preencha os parâmetros disponíveis.
Revise o comando em cURL para conferir a chamada que será feita.
Clique em Enviar para executar a requisição.
Analise o bloco Resposta e o status HTTP retornado.

Campos e opções¶

JSON do OpenAPI:
- abre a especificação OpenAPI publicada pelo próprio sistema.
- É o caminho mais direto para consultar o JSON bruto da API.
Recarregar:
- atualiza a especificação carregada na tela.
- Use quando houver mudança de versão, alteração de rota ou ajuste recente na documentação da API.
Meta da especificação:
- ao lado dos botões superiores, a tela mostra o título e a versão da especificação carregada.
Endpoints:
- lista todos os endpoints documentados no OpenAPI interno.
- Cada item mostra:
  - método HTTP
  - rota
  - resumo do endpoint
Testar:
- mostra o endpoint selecionado com:
  - método
  - rota
  - descrição
  - parâmetros disponíveis
Parâmetros:
- a tela monta os campos com base no OpenAPI.
- Dependendo do endpoint, o usuário pode ver:
  - campos livres
  - listas de seleção
  - calendário para data e hora
  - listas múltiplas
- Em algumas rotas, o sistema também carrega opções dinâmicas do próprio RR Flow, como fontes e grupos cadastrados.
Enviar:
- executa a chamada do endpoint selecionado pelo testador integrado.
Autenticação automática:
- quando a API está com token configurado, o testador adiciona automaticamente o cabeçalho Authorization: Bearer ... na chamada exibida e na requisição enviada.
cURL:
- mostra o comando correspondente aos parâmetros preenchidos no formulário.
- Ele é atualizado automaticamente conforme os campos mudam.
Copiar:
- copia o conteúdo atual do bloco cURL.
Resposta:
- mostra o status HTTP e o conteúdo retornado pela chamada.
- Quando a resposta é JSON válido, a tela já apresenta o conteúdo formatado.

Validação¶

O endpoint selecionado deve aparecer na lista de Endpoints.
O bloco cURL deve refletir exatamente os parâmetros preenchidos.
O status HTTP em Resposta deve ser compatível com a chamada executada.
Quando houver retorno JSON, o conteúdo exibido deve bater com a rota e os parâmetros informados.

Problemas comuns¶

Endpoint ausente: revisar a especificação OpenAPI carregada no sistema.
Falha ao carregar dados: revisar a disponibilidade da própria rota /admin/api-docs/openapi.json.
Erro na chamada de teste: revisar parâmetros, permissões e, quando aplicável, autenticação por token.
O cURL não representa o que você esperava: revisar os campos preenchidos no bloco Testar.
Resposta inesperada: comparar o retorno com o comportamento real do endpoint e com os parâmetros enviados.
Copiar falha: tentar novamente após atualizar a página ou copiar manualmente o bloco cURL.