Glossário

Trabalhando com tecnologia, nos deparamos com diversos termos durante a rotina de criação de uma documentação. Para tornar o processo de entendimento mais ágil, aqui você encontrará alguns termos dessas nomenclaturas e também um glossário com palavras utilizadas no conteúdo criado.

API

Conjunto de protocolos e ferramentas que possibilitam a comunicação e interação entre diferentes softwares, permitindo que aplicativos e serviços se conectem e troquem informações de maneira padronizada e eficiente.

Assíncrono

Sem depender do tempo real; ações ocorrem independentemente, não exigindo espera pela conclusão para prosseguir.

Certificado Digital

Arquivo digital para assinatura eletrônica de documentos.

Chave de Acesso

Conjunto de 44 caracteres numéricos que representam um documento fiscal eletrônico, contendo informações como UF do emitente, data de emissão, CNPJ, modelo, série, número e dígito verificador.

Client_Id

Código encriptado para controle de uso dos clientes NDD. Cada empresa possui uma chave de ativação própria para uso do sistema.

CNPJ

Cadastro Nacional de Pessoa Jurídica, composto por 14 caracteres numéricos, identificando empresas.

CPF

Cadastro de Pessoa Física, com 11 caracteres numéricos, identificando pessoas.

CT-e

Conhecimento de Transporte Eletrônico.

cStat

Código numérico que representa o status ou resultado de uma operação na comunicação com órgãos fiscalizadores, fornecendo informações sobre o sucesso ou falha da transmissão ou processamento de documentos fiscais eletrônicos.

DACTE

Documento Auxiliar do Conhecimento de Transporte Eletrônico.

DAMDFE

Documento Auxiliar do Manifesto Eletrônico de Documentos Fiscais.

DANFE

Documento Auxiliar da Nota Fiscal Eletrônica.

DF-e

Documento Fiscal Eletrônico.

Endpoints

URLs específicas de uma API usadas por clientes para acessar recursos e realizar operações por meio de métodos HTTP, como GET, POST, PUT ou DELETE.

ERP

Enterprise Resource Planning ou Sistema de Gestão Empresarial.

Homologação

Ambiente de testes com dados fictícios.

JSON

Formato de dados simples para comunicação entre sistemas.

MD-e/MDe

Manifestação do Destinatário Eletrônica.

NF-e

Nota Fiscal Eletrônica

OAuth 2.0

Um protocolo de autorização para permitir que aplicativos acessem recursos em nome de um usuário sem expor suas credenciais.

Postman

Plataforma para desenvolvedores testarem e documentarem APIs por meio do envio de requisições, validação de respostas e execução de testes automatizados.

Produção

Ambiente com dados reais.

REST

Abordagem web para comunicação entre computadores usando padrões HTTP, permitindo interações simples e eficientes entre clientes e servidores.

Schemas XSD

Estruturas que definem o formato e a validade dos dados em documentos XML, assegurando a consistência na troca de informações entre sistemas.

Sefaz

Secretaria de Fazenda.

Síncrono

Em tempo real; ações ocorrem imediatamente e em sequência, aguardando conclusão antes de prosseguir.

SSL

Secure Sockets Layer, protocolo de encriptação de dados na Internet.

Swagger

Ferramenta que auxilia na documentação, no desenvolvimento e na visualização de APIs, facilitando a comunicação entre desenvolvedores e permitindo testes diretos.

Tag

Etiqueta ou marcador que identifica, categoriza ou descreve algo, frequentemente usada em programação para organizar e identificar elementos

Token

Um código único e temporário concedido após a autenticação bem-sucedida, usado para acessar recursos e serviços da API de maneira segura e autorizada

UF

Unidade Federativa, representando um estado ou o Distrito Federal.

XML

Linguagem de marcação para representação eletrônica de DF-e