Como conseguir a chave
A chave é emitida pela equipe da RMF. Peça ao seu contato comercial. Este portal não tem cadastro, formulário nem emissão de chave, e troca e revogação também são pedidas à equipe.
O que informar no pedido
- Se a conta é de rede (cliente direto, com as empresas da própria rede) ou de parceiro (a carteira de clientes).
- Para o que você vai usar a API: consultas de ICMS e da Reforma, envio de SPED e XML, relatórios, webhooks. É isso que define o plano da conta e os escopos que as chaves podem receber.
- Que você quer começar pelo sandbox. Toda conta nasce com o espelho no sandbox, com o mesmo plano.
O que você recebe
| Sandbox | Produção | |
|---|---|---|
| Endereço | https://sandbox.api.rmfestrategia.com/v1 | https://api.rmfestrategia.com/v1 |
| Prefixo da chave | rmf_test_ | rmf_live_ |
| Chamada do navegador | só a partir de docs.rmfestrategia.com (o "testar agora" da referência) | não: chame do seu servidor |
A chave tem 75 caracteres. Só o prefixo e o comprimento são documentados; o resto é opaco. O segredo aparece uma única vez, quando a equipe emite a chave: guarde-o em RMF_API_KEY, no cofre de segredos do seu sistema.
Boas práticas
- Peça uma chave só para cada uso (integração, teste, assistente de código) e com o escopo mínimo do que ela faz. Para consultar alíquota, basta
consultas:ler. - Use o vencimento e, se puder, a lista de IPs da chave.
- Até 2 chaves ativas por ambiente: peça a nova antes de revogar a antiga, para trocar sem parar.
- Para achar uma chave vazada num repositório, use este padrão de busca de segredo:
rmf_(live|test)_[0-9A-HJKMNP-TV-Z]{26}_[0-9A-Za-z]{32}_[0-9A-Za-z]{6}
Com a chave em mãos, siga para a primeira chamada. Para entender escopos e erros de autenticação, veja Autenticação e escopos.
Esta página em Markdown: https://docs.rmfestrategia.com/comecar/chave.md