1. Getting Started
DIGISAN
  • Getting Started
    • Introdução
    • Autenticação
    • Ambiente
    • Reforma Tributária
  • Webhooks
    • Eventos disponíves
    • Cadastra webhook
      POST
    • Atualiza o cadastro de webhook
      PUT
    • Ativa/desativa um webhook
      PUT
    • Retorna os dados do webhook cadastrado
      GET
    • Lista histórico de webhooks enviados
      GET
  • Empresas
    • Obtém um emitente/prestador por CNPJ
      GET
    • Atualização de emitente/prestador
      PUT
    • Upload do certificado digital do emitente/prestador em multipart-form-data.
      POST
    • Deleta o certificado digital do emitente/prestador
      DELETE
    • Cadastro de emitente/prestador
      POST
  • NFSe
    • Emitir nota de serviço
      POST
    • Baixar XML da nota
      GET
    • Baixar PDF da nota
      GET
    • Consulta nota pelo ID
      GET
    • Solicitar cancelamento da nota
      POST
    • Solicitar cancelamento da nota
      POST
    • Consulta dados de um município homologado para emissão de NFSe
      GET
    • Consulta municípios homologados para emissão de NFSe
      GET
  • NFe
    • Emitir nota de produto
      POST
    • Baixar XML da nota
      GET
    • Baixar PDF da nota
      GET
    • Consulta nota pelo ID
      GET
    • Solicitar Carta de Correção
      POST
    • Solicitar cancelamento da nota
      POST
    • Inutilizar numeração de nota fiscal (NF-e)
      POST
  • NFC-e
    • Emitir nota de consumidor
    • Baixar XML da nota
    • Baixar PDF da nota
    • Consulta nota pelo ID
    • Solicitar cancelamento da nota
    • Inutilizar numeração de nota fiscal (NFC-e)
  • Esquemas
    • Schemas
      • Mensagem
      • Resposta
      • ObterWebhookResponseDTO
    • Raiz
    • NovoWebhookDTO
    • WebhookResponseDTO
    • AtivarEDesativarWebHookDTO
    • AlterarCompanhiaInput
    • EnderecoCompanhia
    • CadastrarEmpresaOutput
    • CancelarNFSe
    • Endereco
    • IBSCBS do Servico
    • Municipio
    • NFSe
    • NFSeIbptDTO
    • Pais
    • Prestador
    • Servico
    • ServicoInformacaoExterior
    • Tomador
    • deducao
    • obra
    • servicoAtividadeEvento
    • tributacaoTotal
    • tributacaoTotalConteudo
    • Evento
    • InutilizarDTO
    • NumeracaoDTO
    • CBS
    • CBS Total
    • Emitente
    • Frete
    • IBS Município
    • IBS Total
    • IBS UF
    • IBSCBS Total
    • IBSCBS do Item
    • ICMS
    • IPI
    • Imposto
    • Item
    • NFe
    • NFeAjusteCompetenciaDTO
    • NFeApropriacaoCreditoPresumidoIbsZfmDTO
    • NFeCompraGovernamentalDTO
    • NFeCreditoPresumidoDTO
    • NFeCreditoPresumidoOperacaoDTO
    • NFeDuplicataDTO
    • NFeEstornoCreditoDTO
    • NFeFaturaDTO
    • NFeItemDFeReferenciadoDTO
    • NFeItemISDTO
    • NFeMonofasicoDTO
    • NFeMonofasicoDiferimentoDTO
    • NFeMonofasicoPadraoDTO
    • NFeMonofasicoRetencaoDTO
    • NFeMonofasicoRetidoDTO
    • NFePagamentoAntecipadoDTO
    • NFeReferenciada
    • NFeRetencaoICMSTransporteDTO
    • NFeTransferenciaCreditoDTO
    • NFeVeiculoDTO
    • NFeVolumeDTO
    • Pagamento
    • Total
    • Transportadora
    • Destinatario NFCe
    • NFCe
    • CadastrarCompaniaInput
    • ConsultaPaginadaHistoricoWebhookInput
    • NFSeResponseDTO
    • CidadeDTO
    • NFeCancelamentoDTO
    • NFeCartaCorrecaoDTO
    • NFeResponseDTO
    • NFCeResponseDTO
  1. Getting Started

Autenticação

Todas as chamadas à API DIGISAN exigem uma chave de API enviada via header HTTP. Não há usuário ou senha: a chave é enviada diretamente no header x-api-key em todas as requisições.

Como funciona#

1.
Acesse o painel da DIGISAN e gere sua chave em Configurações → API Keys.
2.
Inclua o header x-api-key em todas as requisições com o valor da chave gerada.
3.
A mesma chave funciona nos ambientes de homologação e produção, muda apenas um campo no body chamado ambiente das requisições no envio de NFe e NFCe. Veja os detalhes em Ambiente.

Exemplo com cURL#

Exemplo com JavaScript (fetch)#

Exemplo com PHP#

Erros de autenticação#

CódigoDescriçãoO que fazer
401Chave ausente ou inválidaVerifique se o header x-api-key está presente e com o valor correto
403Chave sem permissão para o recursoVerifique se a chave pertence à empresa correta e tem acesso ao endpoint

Boas práticas#

Nunca exponha a chave no frontend — toda chamada autenticada deve ser feita pelo seu backend.
Não versione a chave no Git — use variáveis de ambiente (.env) para armazená-la.
Revogue imediatamente se suspeitar de vazamento — acesse o painel DIGISAN e gere uma nova chave.

Modificado em 2026-05-20 20:55:26
Página anterior
Introdução
Próxima página
Ambiente
Built with