X-Api-Key com a chave de API da
sua empresa. Não há OAuth, tokens temporários ou assinatura de requisição — é
uma chave estática por empresa.
- Cidades integradas e Configurações de emissão por município, que mostram quais municípios a Spedy atende e o que cada um exige;
- o download do XML e do PDF das notas emitidas (NF-e, NFC-e e NFS-e).
X-Api-Key, ela precisa ser
válida: uma chave inválida recebe 401.
Chaves e empresas
Cada empresa tem sua própriaX-Api-Key, que opera e emite notas apenas
para aquela empresa.
Quando você assina a Spedy, a primeira empresa — a empresa titular da
conta — é criada automaticamente. A chave dela fica no dashboard, em menu do
perfil do usuário → Minha empresa → Credenciais de API. Além de emitir as
próprias notas, a chave da empresa titular é
a única que pode gerenciar empresas (criar, listar, alterar e excluir) via
/v1/companies. Veja Configuração
inicial.
Se você emite em nome de outras empresas (por exemplo, um SaaS que emite pelos
seus clientes), pode criar empresas adicionais: cada POST /v1/companies
(feito com a chave da titular) retorna a X-Api-Key da nova empresa no campo
apiCredentials.apiKey.
Usando a chave
Ambientes
Cada ambiente tem sua própria base URL e suas próprias chaves de API — uma chave de produção não funciona em sandbox, e vice-versa.
Veja mais detalhes sobre as diferenças entre os ambientes em Ambiente de
testes.
Erros de autenticação
Se a chave for inválida, ausente ou não corresponder ao ambiente usado, a API responde403 Forbidden. Veja a lista completa de códigos de erro em Erros e
respostas.