Pular para o conteúdo principal

API de Emissão de NFSe (1.0.0)

Primeiros Passos

Bem-vindo à nossa plataforma de emissão de Nota Fiscal de Serviços Eletrônica (NFSe)!

Estamos aqui para simplificar sua experiência, tornando o processo de emissão rápido, intuitivo, seguro e eficiente. Nossa API proporciona a melhor comunicação entre as softhouses e prefeituras, tirando a burocracia na preparação dos dados essenciais para emissão das notas fiscais.

Com nossa solução, informações recorrentes, como os dados do prestador, regime tributário e certificado digital, serão previamente configuradas no portal, enquanto nossa API facilitará a integração, solicitando apenas informações específicas, como tomador, serviços e valores de impostos, em um formato JSON simples.

É importante mencionar que o município precisa estar homologado com a nossa plataforma. Caso o município desejado não esteja na lista de estados e cidades homologadas, você poderá entrar em contato com nossa equipe comercial para viabilizar a homologação.

Vamos começar?

Cadastro

Para seguir nos passos abaixo é preciso do cadastro da empresa em nossa plataforma. Esse é um requisito para obter as credenciais de homologação e produção para utilização de nossos serviços.

Acesse nosso portal de parceiros Integro Parceiros para cadastro de sua empresa:

Informar os seguintes dados no formulário:

  • Razão Social
  • CNPJ
  • Inscrição Municipal
  • Endereço completo
  • ...Imagem do Formulário de Cadastro...

Importação do Certificado Digital

O certificado digital é uma peça fundamental para garantir a autenticidade e validade jurídica das notas fiscais emitidas. Ele é utilizado exclusivamente para assinar os documentos fiscais, assegurando sua conformidade com os padrões legais e proteção contra alterações indevidas.

Passos para Importação

  1. Acesse o portal e faça login com suas credenciais.
  2. No menu de configurações, selecione a opção Certificado Digital.
  3. Faça o upload do arquivo do certificado (A1 ou A3) e insira a senha correspondente.
  4. Conclua o processo para associar o certificado ao cadastro do prestador.

Segurança do Certificado

Entendemos que a segurança do seu certificado digital é essencial. Por isso, nossa plataforma foi projetada para utilizar o certificado apenas durante o processo de assinatura dos documentos fiscais, mantendo-o armazenado de forma segura e criptografada. Não realizamos nenhum uso indevido ou acesso não autorizado aos seus dados.

Emitente

Upload de Certificado Digital

Realiza o upload de um certificado digital no formato Base64, valida a senha e armazena o certificado com uma chave única gerada pelo sistema.

Request Body schema: application/json
required
cnpjEmissor
required
string

CNPJ da empresa emitente associada ao certificado

base64
required
string

Conteúdo do certificado digital codificado em Base64 (formato .pfx)

senha
required
string

Senha de acesso ao certificado digital

Responses

Response Schema: application/json
chaveCertificado
string

Identificador único gerado para o certificado armazenado

Response Schema: application/json
mensagem
string

Mensagem explicando o motivo da inconsistência. Exemplos:

  • "Base64 e Senha devem ser preenchidos"
  • "O certificado não contém uma chave privada."
Response Schema: application/json
mensagem
string

Mensagem de erro gerada pela exceção

Request samples

Content type
application/json
{
  • "cnpjEmissor": "string",
  • "base64": "string",
  • "senha": "string"
}

Response samples

Content type
application/json
{
  • "chaveCertificado": "string"
}

Notas de Serviço - NFSe

Envio de NFSe

Este endpoint permite enviar notas fiscais de serviço.

Request Body schema:
identificacaoEmitente
required
string non-empty

Identificação única do emitente do lote

required
Array of objects (NotaFiscalResumida) non-empty

Lista de notas fiscais que compõem o lote

enviarParaProducao
boolean

Define se a nota será enviada para produção (true) ou apenas homologação/teste (false)

Responses

Response Schema: application/json
protocolo
string

Protocolo de envio da NFSe

mensagens
Array of strings

Mensagens informativas ou de alerta

Response Schema: application/json
mensagem
string

Mensagem de erro gerada pela exceção

Request samples

Content type
{
  • "identificacaoEmitente": "string",
  • "notas": [
    ],
  • "enviarParaProducao": true
}

Response samples

Content type
application/json
{
  • "protocolo": "string",
  • "mensagens": [
    ]
}

Usuario

Revalidação de token

Gera um novo token de autenticação para o usuário já autenticado. Este endpoint só pode ser acessado com um token válido. O novo token é enviado via cookie.

Responses

Response Schema: application/json
codigo
integer

Código identificador do usuário

nome
string

Nome completo do usuário

cnpj
string

CNPJ associado ao usuário (quando aplicável)

papel
string

Papel do usuário no sistema (ex: Administrador, Prestador, etc.)

login
string

Login utilizado para autenticação

ativo
boolean

Indica se o usuário está ativo no sistema

Response samples

Content type
application/json
{
  • "codigo": 0,
  • "nome": "string",
  • "cnpj": "string",
  • "papel": "string",
  • "login": "string",
  • "ativo": true
}

Autenticação de usuário

Este endpoint permite autenticar um usuário e retornar suas informações cadastrais em caso de sucesso.

Request Body schema: application/json
required
login
required
string

Login do usuário

senha
required
string

Senha do usuário

Responses

Response Schema: application/json
codigo
integer

Código identificador do usuário

nome
string

Nome completo do usuário

cnpj
string

CNPJ associado ao usuário (quando aplicável)

papel
string

Papel do usuário no sistema (ex: Administrador, Prestador, etc.)

login
string

Login utilizado para autenticação

ativo
boolean

Indica se o usuário está ativo no sistema

Response Schema: application/json
mensagem
string

Mensagem de erro gerada pela exceção

Request samples

Content type
application/json
{
  • "login": "string",
  • "senha": "string"
}

Response samples

Content type
application/json
{
  • "codigo": 0,
  • "nome": "string",
  • "cnpj": "string",
  • "papel": "string",
  • "login": "string",
  • "ativo": true
}