Skip to content

Roqueman API Client

O Roqueman é o cliente de API do RoqueOS — um Postman/Insomnia que roda dentro do seu desktop web. Monte e dispare requisições HTTP, WebSocket e GraphQL, organize tudo em coleções, use variáveis e ambientes, escreva scripts de teste, e automatize fluxos com encadeamento de respostas e o runner de coleção — sem instalar nada.

Roqueman

Por que isso é útil

Você testa suas APIs no mesmo lugar onde já trabalha, com os dados sincronizados na sua conta. Sem app separado, sem login extra — abre o Roqueman pelo Launchpad e começa.

Admins: coleção do servidor automática

Administradores conectados a um servidor recebem a coleção RoqueOS Server (todos os endpoints da API do servidor) carregada automaticamente, junto com um ambiente apontando pro servidor ativo — pronta pra rodar.


Modos de execução

Toda requisição roda em um de três modos (seletor ao lado da URL), pra contornar CORS conforme o cenário:

  • Navegador (Axios) — dispara direto do navegador. Ideal para APIs públicas com CORS liberado. É o modo necessário para upload de arquivo (o navegador monta o multipart/boundary).
  • Servidor (Proxy) — encaminha pelo seu RoqueOS Server (requer Server Mode conectado). Resolve CORS server-side.
  • Função (Proxy) — encaminha por uma Cloud Function do RoqueOS (padrão). Resolve CORS sem precisar de servidor próprio.

Toda requisição tem timeout (30s por padrão): um endpoint lento não trava mais o app — você recebe um aviso de tempo esgotado, distinto de um cancelamento manual.


Montando uma requisição

  • Método + URL: GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS.
  • Params: tabela chave/valor da query string, com liga/desliga por linha.
  • Headers: tabela chave/valor.
  • Body:
    • JSON / XML / Text — editor com realce de sintaxe.
    • Form (urlencoded) — tabela chave/valor.
    • Multipart (form-data) — cada linha alterna entre texto e arquivo (com seletor de arquivo). Upload de arquivo real requer o modo Navegador.
    • Binary — envia um arquivo cru com o content-type dele.
  • Auth: Nenhuma, Bearer, Basic, API Key (header/query), OAuth 2.0 e Digest.
  • Scripts: pré-requisição e pós-resposta (API pm compatível com Postman — pm.environment.set, pm.test, pm.expect, etc.).

OAuth 2.0 — obter token automaticamente

Na aba Auth → OAuth 2.0 → Configurações Avançadas, preencha a URL do Token, Client ID/Secret e Scope e clique em Obter token. O Roqueman busca o token via client credentials (pelo modo de execução da aba, então o proxy resolve o CORS) e preenche o Access Token automaticamente.


Variáveis e ambientes

Use em qualquer campo (URL, headers, params, body, auth). A resolução segue a ordem: globais → variáveis da coleção → ambiente ativo → runtime (scripts). Há também variáveis dinâmicas como , , , etc.

Antes de enviar, o Roqueman avisa (de forma não-bloqueante) se alguma não foi encontrada — assim um não vai silenciosamente como string vazia.

Gerencie ambientes pelo seletor no topo (engrenagem) — crie, edite, duplique, importe/exporte e troque o ambiente ativo.

Encadeamento response → variável

Na aba Extrair, defina regras para salvar valores da resposta em variáveis para a próxima requisição — sem escrever script:

  • De: Body (caminho JSON, ex.: data.token), Header (nome) ou Status.
  • Variável de destino + Escopo (Environment ou Global).

Depois de cada resposta com sucesso, o valor é extraído e salvo (toast "Variáveis salvas"). É o que permite, por exemplo, fazer login e usar o token retornado nas requisições seguintes automaticamente.


Coleções e o Runner

Organize requisições em coleções com pastas aninhadas. Salve, duplique, mova, e importe/exporte (formato Postman v2.1, cURL e RoqueOS).

No menu de contexto da coleção, Rodar coleção abre o runner: ele executa todas as requisições em sequência (raiz e pastas), roda os scripts de teste e mostra o resultado ao vivo por requisição (status, tempo, testes ✓/✕) e um resumo de aprovados/reprovados. O encadeamento response→variável funciona dentro do runner, então fluxos com dependência entre requisições rodam de ponta a ponta.


Resposta

O visualizador mostra status, tempo e tamanho, e abas de Body (com realce e modo bruto), Headers, Cookies e Testes (resultado dos scripts pós-resposta). Você pode copiar, baixar e gerar código da requisição em 9 linguagens (cURL, Fetch, Axios, Python, PHP, Go, Java, C#, Ruby).


WebSocket e GraphQL

Use o botão + (ao lado das abas) para criar uma aba WebSocket ou GraphQL:

  • WebSocket: conecte, envie texto/JSON e veja o log de mensagens. Com Reconectar automaticamente ligado (padrão), uma queda inesperada dispara reconexão com backoff exponencial — uma desconexão manual não reconecta.
  • GraphQL: editor de query + variáveis + introspection do schema.

Abas e histórico

  • Abas multi-requisição com estado "não salvo"; as abas abertas e o rascunho sobrevivem ao reload (não se perde trabalho ao recarregar).
  • Histórico das requisições enviadas, agrupado por data, com busca e replay.

FAQ

O upload de arquivo não funciona. Troque o modo de execução para Navegador (Axios) — só ele monta o multipart/form-data real. O proxy de servidor/função não encaminha upload de arquivo.

Onde meus dados ficam salvos? Coleções, requisições, ambientes, globais e histórico ficam na sua conta (Firebase), sincronizados entre dispositivos. As abas abertas ficam no navegador local.

Variáveis de ambiente são secretas? São armazenadas como texto na sua conta. Não coloque segredos de produção sensíveis em ambientes compartilhados.

Deu "tempo esgotado". A requisição passou de 30s. Verifique o endpoint, a rede ou o modo de execução.

Lançado sob a Licença MIT.