Documentação da API

Bem-vindo à documentação da API do Runner. Aqui você encontra a referência completa dos serviços REST disponíveis para integração.

Todos os endpoints exigem autenticação via API Key enviada no header x-api-key.

Serviços

Central de Processamento

Cofre

Webhook

Autenticação

Todas as requisições devem incluir o header:

x-api-key: sua-chave-de-api

Cada API Key possui permissões específicas que controlam o acesso aos endpoints. As permissões são configuradas no momento da criação da chave pelo painel administrativo.

Códigos de Erro Comuns

Código	Status	Descrição
`API_KEY_REQUIRED`	401	Header `x-api-key` não foi enviado
`UNAUTHORIZED`	401	API Key inválida
`INVALID_API_KEY`	401	API Key não encontrada no sistema
`INSUFFICIENT_PERMISSIONS`	403	API Key não possui a permissão necessária
`NO_ORGANIZATION`	403	API Key não está associada a uma organização
`INVALID_PARAMETERS`	400	Parâmetros da requisição inválidos