Planejando sua integração

Essa seção fornece uma visão geral dos requisitos do selo de certificação para o conector Inbound necessário para ser tornar um parceiro certificado.

Revise esta seção para ajudar a planejar sua integração.

Aviso: Antes de iniciar sua integração, é importante definir o escopo de acordo com os requisitos listados para esse programa de certificação.

Requisitos de Administração e utilidades

Obrigatório/ Sugerido	Requerimentos	Notas	Nível
Obrigatório	Tela de Configuração	De acordo com as melhores práticas, é desejável ter uma tela de configurações para as credenciais, conforme listado abaixo: - Token de ID do cliente - Token Secreto	UI
Obrigatório	Teste de Autenticação de Conexão - Serviço de Health (PING)	Existe um método disponível para verificação de estabilidade do serviço utilizando PING	UI
Obrigatório	Serviços de Log Compreensivos	Dado que todas as transações são baseadas em JSON de solicitação/resposta, o conector deve fornecer logs das transações para solução de problemas, se necessário. Os parceiros podem definir o tempo necessário para manter esses dados no sistema	UI
Obrigatório	Selecionar opções de ambiente	Fornecer opção de ambiente para permitir que o usuário-chave possa alternar entre os ambientes de sandbox e ambiente de produção	UI
Obrigatório	Verificação de ambiente	Disponibilizar evidências que demonstrem em qual ambiente (produção ou sandBox) o cliente/parceiro está operando	UI
Obrigatório	Tela para monitorar as transações	Desenvolver uma tela que permita ao usuário acompanhar (painel/cockpit) os documentos extraídos da aplicação Avalara e ações fiscais (POST) à partir do sistema de origem	UI
Sugerido	Configuração de tempo de expiração da chamada	Configurar um tempo de expiração para cada chamada realizada pela API (timeout)	Configuração oculta
Obrigatório	API Base URL	As URLs devem ser configurações do sistema	Configuração oculta
Obrigatório	Versão	Informar a compatibilidade da versão com o ERP e a arquitetura do conector	Documentação
Obrigatório	Arquitetura	Fornecer informações sobre a arquitetura do conector e os pré-requisitos necessários para o seu funcionamento	Documentação

Cenários Nota Fiscal Eletrônica (NFE)

Obrigatório/ Sugerido	Cenários
Obrigatório	Retorna uma lista de notas fiscais (NFE)
Obrigatório	Recupera o conteúdo da nota fiscal eletrônica (NFE)
Obrigatório	Recupera o XML da nota fiscal eletrônica (NFE)
Obrigatório	Recupera o DANFE da nota fiscal eletrônica (NFE)
Obrigatório	Consulta a lista de notas fiscais canceladas
Obrigatório	Registra o evento de Manifesto da nota fiscal eletrônica (NFE)
Obrigatório	Recupera o XML da carta de correção da nota fiscal eletrônica (NFE)
Sugerido	Posta um evento da nota fiscal eletrônica (NFE)
Sugerido	Posta um registro de recebimento da nota fiscal eletrônica (NFE)

Cenários Conhecimento de Transporte Eletrônico (CTE)

Obrigatório / Sugerido	Cenários
Obrigatório	Retorna uma lista de conhecimento de transporte eletrônico (CTE)
Obrigatório	Recupera o conteúdo do conhecimento de transporte eletrônico (CTE)
Obrigatório	Recupera o XML do conhecimento de transporte eletrônico (CTE)
Obrigatório	Recupera o DACTE do conhecimento de transporte eletrônico (CTE)
Sugerido	Atualiza o status de um conhecimento de transporte eletrônico (CTE) na SEFAZ

Cenários Nota Fiscal Eletrônica de serviços (NFS-e)

Obrigatório/Sugerido	Cenários
Obrigatório	Retorna uma lista de notas fiscais de serviços (NFS-e)
Obrigatório	Recupera o conteúdo da nota fiscal eletrônica de serviços (NFS-e)
Obrigatório	Recupera o XML da nota fiscal eletrônica de serviços (NFS-e)
Obrigatório	Recupera o PDF da nota fiscal de serviços eletrônica (NFS-e)