Autenticação e permissões
Uma chave representa uma integração de um único Space.
Reportar problema nesta página
Copie o relato, descreva a dificuldade e envie pelo suporte disponível no RuralZap. Não inclua chaves ou dados financeiros.
Abrir RuralZap para acessar o suporteEnvie a chave no cabeçalho
Authorization: Bearer RURALZAP_API_KEY
Use uma chave de integração criada pelo proprietário do Space em API e integrações. JWT da sessão e credenciais MCP não autenticam esta API.
Em contas de parceiros institucionais, a chave é criada nessa seção do painel do parceiro. A documentação e o contrato da API são os mesmos.
Space e escopos
O Space isola os dados financeiros. A chave identifica automaticamente a integração, o reseller, o Space e os escopos autorizados. A API não usa o domínio do painel para escolher esses dados. Para outro Space, obtenha outra integração autorizada.
Não envie x-space-id, x-reseller-id, x-user-id ou x-api-key, nem identificadores de tenant ou credenciais na query: a API rejeita essas tentativas com 400 INVALID_REQUEST. Autentique somente por Authorization: Bearer.
| Consulta | Escopo |
|---|---|
| Contexto | Chave válida e acesso à API |
| Carteiras e saldos | balances:read |
| Lançamentos | transactions:read |
| Resumo e fluxo de caixa | reports:read e recurso de fluxo de caixa |
A habilitação da API e os direitos do plano são conferidos em cada chamada. Ter um escopo na chave não substitui o acesso ao recurso. Use contexto para descobrir as capacidades atuais.
O card API e integrações nas Configurações aparece somente com a API habilitada para o ambiente e incluída no plano contratado, ou com a API habilitada para o ambiente e uma liberação manual vigente para esse Space. Habilitar a API no ambiente sem incluí-la no plano não concede acesso automaticamente. Solicite a liberação à equipe responsável pelo seu ambiente. Após perder o acesso, a gestão pelo link direto continua permitindo suspender integrações e revogar chaves antigas.
Ambientes
Chaves de teste e produção não são intercambiáveis. A origem de produção é https://api.finance.meyje.com.br. Para testes com API real, utilize exclusivamente o ambiente disponibilizado para sua conta. Não há cadastro de sandbox público neste portal.
Na mesma instalação, essa origem é comum a RuralZap e seus parceiros. Um domínio ou subdomínio próprio do painel não exige outra URL de integração. O portal https://docs.ruralzap.com.br serve a documentação, não as consultas de dados.
Rotação e revogação
Faça a rotação na gestão da integração, atualize o segredo no seu servidor e confira o contexto novamente. Respeite o prazo de sobreposição informado pelo produto; não presuma validade indefinida da chave anterior.
Se houver exposição, revogue a chave. Não inclua credenciais em URLs, logs, exemplos, prompts ou chamados de suporte. Revogação, expiração, perda de acesso do responsável e alteração de direitos podem interromper consultas.