Pular para o conteúdo principal

API Integração Space

Aqui você encontrará todas as informações necessárias para integrar o seu software ao NDD Space, a plataforma que simplifica e agiliza a gestão de documentos fiscais. Com nossa API, você terá controle total sobre as operações fiscais da sua empresa e poderá desfrutar de recursos poderosos para facilitar o processo.

Utilizamos o padrão REST e todas as respostas da API são retornadas em JSON.

Ao utilizar a API NDD Space, você terá acesso a uma ampla gama de funcionalidades que permitirão a recepção eficiente de documentos fiscais, gerenciamento de documentos e muito mais. Este guia detalhado fornecerá informações sobre os endpoints disponíveis, os parâmetros necessários, exemplos claros de solicitação e resposta, além de dicas úteis para garantir uma integração bem-sucedida. Estamos comprometidos em tornar sua experiência de integração tranquila e eficiente.

Caso tenha alguma dúvida ou precise de suporte durante o processo, nossa equipe de suporte técnico estará pronta para ajudá-lo.

Estamos entusiasmados em ter você como parceiro e esperamos que a API NDD Space facilite e aprimore suas operações fiscais. Vamos começar a integração!

Visão Geral​

Através da nossa API, você poderá realizar a recepção de diversos documentos de forma rápida e fácil.

Ao integrar o seu ERP com a API NDD Space, você poderá aproveitar as seguintes possibilidades:

  • Recepção de NF-e (Nota Fiscal Eletrônica): Receba notas fiscais eletrônicas de forma automática, agilizando o processo de faturamento e cumprindo com as obrigações fiscais.
  • Recepção de CT-e (Conhecimento de Transporte Eletrônico): Receba documentos fiscais de transporte de carga de forma eficiente e simplificada.
  • Recepção de NFS-e (Nota Fiscal de Serviço Eletrônica): Receba notas fiscais de serviço eletrônicas para atender às obrigações fiscais relacionadas à prestação de serviços.
  • Recepção de NF3-e (Nota Fiscal de Energia Elétrica Eletrônica): Receba notas Fiscais de Energia Elétrica Eletrônica para atender às obrigações fiscais relacionadas à documentação eletrônica de operações de energia elétrica, garantindo a conformidade com a legislação tributária e facilitando o controle e gestão fiscal para a transmissão e recepção segura dos dados de consumo e cobrança.

Explore nossa documentação completa e comece a simplificar seus processos fiscais hoje mesmo!

Requisitos Iniciais​

  • Cadastro na Plataforma: Antes de tudo, é fundamental possuir um cadastro válido na plataforma NDD. Caso ainda não tenha feito o seu cadastro, entre em contato com o suporte técnico ou administrativo da NDD para obter as informações necessárias para criar sua conta de acesso. O cadastro permitirá a identificação correta das interações entre seu aplicativo e a API NDD Space.

  • Certificado Digital: A utilização de um certificado digital válido é obrigatória para a assinatura de documentos fiscais eletrônicos. Certificados digitais asseguram a autenticidade e a confidencialidade das informações transmitidas entre a plataforma Space e a Sefaz. Certifique-se de possuir um certificado digital válido e configurá-lo corretamente no seu ambiente de integração.

  • Chaves de Autenticação: Para acessar a API NDD Space, você precisará das chaves de autenticação, que consistem no Client_Id e no Secret_Id. Essas chaves são fornecidas após o cadastro na plataforma e são essenciais para obter o token de acesso, necessário para realizar chamadas aos endpoints da API. Mantenha essas chaves em sigilo absoluto e utilize-as de forma adequada em suas solicitações de autenticação.

Autenticação​

A API de Integração da NDD opera por meio do protocolo de autenticação OAuth 2.0, uma abordagem que permite que aplicativos obtenham acesso restrito a informações usando o protocolo HTTP.

Para iniciar a integração com sucesso, você precisará utilizar o Client_Id, um identificador único do cliente, e o Secret_Id, uma senha exclusiva. Essas credenciais desempenham um papel vital na garantia da segurança e autenticidade dos aplicativos que se conectam à plataforma NDD.

Uma vez que você tenha em mãos o Client_Id e o Secret_Id, o próximo passo é gerar um token de acesso. Esse token será então inserido nas chamadas aos endpoints da API, permitindo que suas solicitações sejam devidamente autenticadas e processadas. Lembre-se de que, como prática recomendada, é aconselhável obter o token uma única vez durante todo o ciclo de operações, ao invés de gerar um novo token a cada chamada, esse token tem validade de 1 hora. Essa abordagem otimiza o processo, melhora a eficiência da integração e contribui para um fluxo de trabalho mais eficaz.

Formato e Conteúdo​

A tag "ConteudoDocumento" no corpo das chamadas pode ser tanto JSON quanto XML (Conforme configuração na Plataforma), conferindo flexibilidade na escolha da estrutura de dados mais apropriada para a aplicação, e o retorno da solicitação é em Gzip.

O layout da string de “ConteudoDocumento” de documentos "Sefaz" (NF-e/CT-e/NFCom/NF3e/DCe/NFAg/NFAGAs) segue o layout padrão conforme documentação fornecida pela Secretaria de Fazenda (SEFAZ), através dos Schemas XSD distribuídos com os pacotes de liberação (PL).

O layout da string de “ConteudoDocumento” de documentos de Prefeituras (NFS-e) segue o layout único padrão NDD.

Endereço da API Plataforma​

Massa de Testes​

Para simplificar e acelerar seus testes com a API de Integração da NDD, disponibilizamos uma collection de massa de testes pronta para uso no Postman. Essa coleção contém uma variedade de solicitações pré-configuradas que abrangem cenários comuns de integração. Para utilizar, basta importar no Postman alterar os dados de autenticação conforme sua necessidade e adequar os conteúdos de documentos conforme necessidade de sua empresa. Collection Postman (Clique aqui)

Recomendações​

As APIs da Plataforma Space oferecem diversos métodos GET para consulta de dados. Para garantir a performance e a disponibilidade da plataforma para todos os usuários, é importante seguir algumas boas práticas ao utilizar estes métodos.

Recomendações:

  • Planeje suas requisições: Determine quais dados você precisa e faça o menor número possível de requisições para obtê-los.

  • Para evitar sobrecarga na plataforma, recomendamos que em consultas específicas, filtradas, que trazem apenas um documento, sejam limitadas a 6 consultas por minuto. Consultas que retornam lotes de documentos, recomendamos que sejam limitadas a 1 consulta por minuto.

Essa medida garante que todos os usuários tenham acesso aos recursos da API de forma eficiente.

A Plataforma Space monitora o uso das APIs e pode tomar medidas em caso de consumo indevido, como o restrições ou limitações do acesso à API.

Limite de Requisições​

Para garantir a estabilidade, segurança e alta performance a API de Integração da NDD opera um sistema de limitações de chamadas simultâneas.
Esse mecanismo é essencial para controlar o volume de solicitações que nossa API pode processar em um determinado período de tempo.
Quando o limite de uma chamada é atingido, a API barra novas requisições e traz por sua vez o código padrão 429 (too many requests) em sua resposta.

Última atualização em