Documentação da Runner API: guia de uso e recursos

📋 Introdução

Visão Geral

O Runner API é uma plataforma web para testar, organizar e executar requisições HTTP em lote. Pensado para times que precisam de velocidade e organização, sem a complexidade de ferramentas que tentam fazer tudo.

📁

Coleções organizadas

Organize requisições em coleções com pastas, subpastas e variáveis por coleção.

⚡

Runner em lote

Execute coleções inteiras com iterações, delay configurável e suporte a CSV e JSON.

🗓️

Agendamento no servidor

Programe execuções únicas ou recorrentes que continuam funcionando mesmo com o navegador fechado.

🌍

Ambientes

Alterne entre ambientes com variáveis globais e variáveis específicas por coleção.

📥

Importação

Importe coleções do Postman (JSON) ou cole um comando cURL diretamente.

👥

Equipes

Crie equipes, convide membros e compartilhe espaços de trabalho com permissões por papel.

🚀

Interface limpa

Tudo acessível sem ruído: params, headers, body, auth e resposta em abas diretas.

🚀 Início

Primeiros Passos

Em poucos minutos você já estará organizando e executando suas APIs. Sem instalação, sem configuração complexa.

1

Crie sua conta

Acesse runnerapi.com e clique em "Começar grátis". O plano Free não exige cartão de crédito.

2

Crie uma coleção

No sidebar, clique em Nova para criar uma coleção e comece a organizar suas requisições em pastas.

3

Configure um ambiente

Abra o seletor de ambientes na topbar e crie um ambiente com suas variáveis (ex: {{baseUrl}}, {{token}}).

4

Envie sua primeira requisição

Selecione o método, informe a URL, configure params/headers/body e clique em Enviar.

5

Execute com o Runner

Com a coleção montada, clique em RUNNER no sidebar e dispare todas as requisições em lote.

🔌 Requisições

Requisições HTTP

O editor de requisições é o coração do Runner API. A interface abaixo mostra a tela real do sistema com sidebar de coleções, barra de método + URL, abas de configuração e o painel de resposta.

Runner API

Sem ambiente ▾

📁

⇄

👥 Equipes

👥

🌙

K

👤 pessoal ∨

GET Consulta... ×

POST https://api.omni... ×

GET https://teste.api... ×

PUT https://homol... ×

+

COLEÇÕES

HISTÓRICO

RUNNER

⊕ Nova

⬆ Importar

⬇ Exportar

∨ Cliente

···

› 🗂️ Parceiros

› 🗂️ OMS

› 🗂️ Conexões

› 🗂️ Fiscal

› 🗂️ Webhooks Prod

› 🗂️ Frente de loja

› 🗂️ E-commerce

GET ▾

https://teste.api.com/v1/companies

💾

⧉

>_

PARAMS 1

HEADERS

BODY

AUTH

CONFIGURAÇÕES

	CHAVE	VALOR	DESCRIÇÃO
	filter	%20%22name%22%3A%20%22ACME...	Descrição	🗑

+ Adicionar linha

Envie uma requisição para ver a resposta aqui.

Ctrl/Cmd + Enter

Métodos suportados

GET, POST, PUT, PATCH, DELETE, OPTIONS, HEAD
Body nos formatos JSON, form-data, x-www-form-urlencoded e raw text
Headers customizados com suporte a variáveis {{variavel}}
Autenticação via Bearer Token, Basic Auth e API Key na aba AUTH
Atalho Ctrl/Cmd + Enter para enviar rapidamente

💡

Use {{variavel}} em qualquer campo — URL, headers, body, auth — para referenciar variáveis do ambiente ativo. Os valores são substituídos automaticamente no envio.

⚠️

Requisições GET e HEAD não enviam body. Mesmo que exista um body salvo na configuração, ele é ignorado para manter o comportamento HTTP esperado.

📁 Organização

Coleções e Pastas

Coleções são a unidade principal de organização. Cada coleção tem pastas, subpastas e pode ter variáveis próprias separadas das variáveis globais do ambiente.

Menu de opções da coleção

Clique nos ··· ao lado de qualquer coleção para acessar as ações disponíveis:

Nova requisição — adiciona uma req diretamente na coleção
Nova pasta — cria subpasta para organizar por domínio
Variáveis da coleção — abre o modal de variáveis com escopo isolado
Renomear — edita o nome da coleção
Excluir coleção — remove permanentemente

Variáveis por coleção

Cada coleção pode ter suas próprias variáveis, separadas das variáveis globais do ambiente. Útil para tokens específicos de uma integração.

Use {{variavel}} nas requisições desta coleção.

	VARIÁVEL	VALOR	DESCRIÇÃO
	token	sdf1241asdf121	token por coleção	🗑

+ Adicionar linha

📌

Variáveis de coleção têm prioridade sobre variáveis globais de mesmo nome. Use isso para sobrescrever o token ou URL base de uma integração específica sem afetar as demais coleções.

⚡ Runner

Runner em Lote

O Runner executa as requisições selecionadas de uma coleção ou pasta em lote, registrando status, tempo e resultado de cada requisição em tempo real. No modo manual, até cinco requisições podem ser processadas em paralelo; a ordem original é preservada na lista de resultados.

Acessando o Runner

Na aba RUNNER do sidebar, clique em Abrir Runner para abrir o modal de execução em lote.

Após a execução

Clique em qualquer linha do log para ver a resposta completa da requisição — body, headers, status e tamanho.

COLEÇÃO PASTA REQUISIÇÕES

GET Consulta produto

GET Consulta Categorias

GET Consulta caracterist...

GET Consulta SKU

GET Consulta SKUs por o...

POST Insere Produto

1 selecionada(s)

ITERAÇÕES

DELAY (MS)

Parar em caso de erro

DADOS (CSV/JSON) — OPCIONAL

Última execução — 1 total

1 ok 0 erro média 555ms

ITER	REQUISIÇÃO	STATUS	TEMPO
1	GET Consulta características https://homologation....	200	555ms

GET https://homologation....

×

200 OK 555ms1.2 KBiter #1

Body

Headers (12)

{
  "product_features": [
    {
      "id": 487,
      "name": "Cor",
      "applied_on": "sku"
    }
  ]
}

Dados dinâmicos com CSV ou JSON

Faça upload de um .csv ou .json na seção DADOS do Runner
O CSV deve ter cabeçalho e pelo menos uma linha; no JSON, envie um array de objetos
Cada linha do CSV ou objeto do JSON representa uma iteração da execução
Cada coluna/chave vira automaticamente uma variável {{nome}}
Os uploads respeitam o limite do plano; no agendamento, o limite é de 5 MB e 1.000 linhas
Ideal para cadastrar usuários em lote, testar múltiplos cenários ou validar dados reais

🗓️ Automação

Agendamentos no Servidor

Programe execuções do Runner para acontecerem mesmo quando o navegador estiver fechado. O servidor mantém a configuração, executa a coleção no horário definido e registra um histórico detalhado de cada execução.

👥

Disponível apenas no plano Equipes. O agendamento é associado ao workspace e à coleção escolhidos. O Runner manual continua disponível conforme os limites do seu plano.

Criando um agendamento

1

Abra Agendamentos

No sidebar, abra a aba RUNNER e clique em Agendamentos.

2

Escolha a coleção e as requisições

Selecione uma coleção e marque uma ou mais requisições. Elas aparecem agrupadas por pasta; as pastas começam fechadas para facilitar a seleção.

3

Defina quando executar

Informe um nome, escolha Uma vez, Diária ou Semanal, defina o horário e selecione o fuso horário. Na recorrência semanal, marque os dias desejados.

4

Adicione dados, se necessário

Carregue um CSV ou JSON opcional. Cada linha ou objeto alimenta uma iteração e seus campos podem ser usados como {{nome}} na URL, headers, autenticação e body.

5

Salve e guarde o token

Ao criar o agendamento, o token de acesso é exibido uma única vez. Copie-o antes de fechar o diálogo: ele não pode ser recuperado depois.

Recorrência e fuso horário

Uma vez — executa na data e horário informados e depois fica como Concluído.
Diária — executa todos os dias no horário escolhido.
Semanal — executa somente nos dias da semana selecionados.
O horário é interpretado no fuso escolhido, independentemente do fuso do servidor ou do navegador.
Em uma transição de horário de verão, um horário local inexistente é ignorado; se um horário ocorrer duas vezes, a primeira ocorrência é usada.

Dados do agendamento

Formatos aceitos: .csv com cabeçalho e pelo menos uma linha ou .json contendo um array de objetos.
Limite de 1.000 linhas e 5 MB por arquivo.
Cada campo é interpolado nas URLs, headers, autenticação e bodies das requisições selecionadas.
Quando um arquivo é carregado, a quantidade de linhas define o número de iterações e substitui o valor manual de iterações.

Estados e ações

Ativo — aguardando a próxima execução conforme a recorrência.
Pausado — não executa até ser reativado; a configuração é preservada.
Falhou — uma execução única terminou com falhas; pode ser reativada para calcular uma nova próxima execução.
Cancelar — interrompe novas execuções, revoga o token e mantém o histórico.
Excluir — remove o agendamento e a credencial associada. Essa ação não pode ser desfeita.
Se o workspace deixar o plano Equipes, os agendamentos são pausados sem apagar a configuração.
Agendamentos ativos ou pausados podem ser editados. A edição é bloqueada enquanto a execução atual estiver em andamento.

Histórico, falhas e entrega

Abra Histórico em um agendamento para consultar cada execução e o detalhe de cada requisição. A tela mostra as últimas 50 execuções; o botão Exportar baixa um relatório JSON com todo o histórico daquele agendamento.

Sucesso confirmado — respostas HTTP 200, 201 ou 202.
Falha confirmada — a API respondeu com outro status HTTP; 401, por exemplo, é falha da aplicação, não entrega incerta.
Não enviada — ocorreu uma falha conhecida antes de a chamada ser enviada.
Envio não confirmado — o envio começou, mas não foi possível confirmar a resposta. A chamada não é repetida automaticamente e exige verificação manual.
Depois de verificar o serviço externo, use Confirmar entrega. A confirmação registra o usuário e o horário, não repete a chamada e mantém a evidência original somente para leitura.

🔐

O token do agendamento é mostrado somente na criação. Apenas o hash é persistido; o token completo não pode ser recuperado. Trate-o como uma credencial e revogue o agendamento se ele for exposto.

🌍 Ambientes

Ambientes e Variáveis

Ambientes permitem alternar entre contextos (dev, staging, produção) sem alterar nenhuma requisição. Troque o ambiente ativo no seletor da topbar e todas as variáveis são substituídas automaticamente.

Gerenciando ambientes

Clique no seletor de ambiente na topbar (ex: Ambiente 1 ▾) para abrir o modal de gerenciamento.

	VARIÁVEL	VALOR	DESCRIÇÃO
	token	1sdf1sdf1212	token teste	🗑

+ Adicionar linha

Crie múltiplos ambientes (dev, homologação, produção) pelo botão +
Cada ambiente tem suas próprias variáveis com nome, valor e descrição
Ative um ambiente pelo seletor da topbar — todas as requisições passam a usar as variáveis daquele ambiente
Variáveis de coleção têm prioridade sobre variáveis de ambiente de mesmo nome

🔄

Use "Sem ambiente" quando quiser testar sem nenhuma variável injetada automaticamente.

📥 Importação

Importar cURL ou Coleção

O Runner API suporta dois modos de importação acessíveis pelo botão Importar no sidebar: colar um comando cURL diretamente, ou importar uma coleção JSON do Postman.

Modo cURL

Cole qualquer comando curl e ele será convertido em uma requisição configurada automaticamente
Método, URL, headers e body são extraídos do comando
Escolha em qual coleção salvar ou crie uma nova na hora

Modo Coleção (JSON / Postman)

Exporte sua coleção do Postman em formato JSON v2.1
Estrutura completa de pastas e subpastas é preservada
Variáveis de coleção e ambiente também são importadas

⚠️

A importação de coleções JSON/Postman pode variar conforme a configuração da sua conta. Você também pode importar via cURL e criar coleções manualmente.

👥 Colaboração

Equipes e Espaços Compartilhados

Crie equipes para colaborar com seu time e organize o trabalho em espaços compartilhados com acesso controlado por permissão.

Criando e gerenciando equipes

Acesse o botão Equipes na topbar para abrir o modal de gerenciamento.

Espaços compartilhados

Crie espaços de trabalho vinculados a uma equipe. Todos os membros da equipe terão acesso às coleções do espaço.

Espaço Pessoal — visível apenas para você, sem vínculo com equipe
Espaço Compartilhado — vinculado a uma equipe; todos os membros têm acesso
Papéis disponíveis: Owner, Editor e Viewer
Alterne entre espaços pelo seletor pessoal ∨ no topo do sidebar

👤 Conta

Perfil

Acesse seu perfil clicando no avatar no canto superior direito da topbar. Ali você visualiza os dados da sua conta e as opções de sessão.