Passo a Passo

Legal! Que bom que você deseja integrar sua solução com a gente! Nesta página nós iremos te auxiliar em como realizar este processo.

Contato Inicial

Primeiramente precisamos criar um usuário para você. Para isto, basta entrar em contato conosco através desta página!

Com a criação de um usuário, você terá acesso às nossas APIs!

Pré-Requisitos

Para iniciar os seus testes, você precisará ter uma empresa credenciada na prefeitura do município onde deseja emitir NFS-e e o certificado digital da mesma.

Após isso, basta seguir os seguintes passos:

Tudo em ordem? Então podemos começar os testes!

Conhecendo as APIs

Antes de iniciar seu desenvolvimento, separamos algumas APIs para que você possa testar pelo Swagger, afim de que possa conhecer suas características e retornos.

Etapas

Descrição

Utilizado para obter o token de acesso.

Você poderá cadastrar uma empresa ou prestador de serviço.

Será atribuído a um prestador de serviço.

Utilizado para realizar a emissão da nota.

Usado para realizar a emissão da nota.

Retorna o status do documento diretamente na Prefeitura do município.

Utilizando o ID RPS, é possível consultar detalhadamente os dados da mesma.

Retorna uma lista de documentos fiscais. Pode ser parametrizada de diversas formas.

Utilizando o ID do Prestador de Serviço, é usado para cancelar uma NFS-e.

Utilizando o CNPJ do Prestador de Serviço, é usado para cancelar uma NFS-e​.

Testou e entendeu como tudo funciona? Então já podemos iniciar o desenvolvimento.

Desenvolvimento

Da mesma forma proposta na etapa de testes, nós deixaremos um passo-a-passo de desenvolvimento como guia. Nele, você verá todos os fluxos operacionais e as APIs que devem ser utilizadas.

Checklist - Modelo Completo

Etapa

Descrição

A autenticação será utilizada para obter o token de acesso que será passado em todas as chamadas de API.

Tudo o que envolve o envio síncrono de uma NFS-e.

Tudo o que envolve o envio assíncrono de uma NFS-e​.

Desde o seu envio, até a consulta de seu status na SEFAZ.​

Checklist - Modelo Híbrido

Etapa

Descrição

A autenticação será utilizada para obter o token de acesso que será passado em todas as chamadas de API.

Tudo o que envolve o envio normal da NFC-e.

Todas as chamadas necessárias para validar o envio em contingência Off-Line.

Desde o seu envio, até a consulta de seu status na SEFAZ.

Last updated