# Planejando sua integração

Source: https://developer.avalara.com/invoice_services_pt/como_comecar/planejando_integracao/

# Planejando sua integração

Esta seção fornece uma visão geral dos requisitos do selo de **Mensageria Eletrônica de Serviços** necessários para se tornar um parceiro certificado. Revise esta seção para ajudá-lo a planejar sua integração.

**Aviso:** Antes de iniciar a sua integração, é importante definir o tipo de operação principal e o tipo de uso coberto durante o programa de certificação.

Telas administrativas e melhores práticas

A tabela abaixo apresenta uma lista de requisitos que abrangem, desde a experiência do usuário, até as melhores práticas recomendadas da aplicação.

**Condição**

**Requerimentos**

**Notas**

**Nível**

Obrigatório

[Tela de configuração](/invoice_services_pt/experiencia_usuario/credenciais)

De acordo com as melhores práticas, é desejável ter uma tela de configurações para as credenciais, conforme listado abaixo:

-   Token de Assinatura
-   Segredo de Token

UI

Obrigatório

[Teste de autenticação de conexão - Serviço Health (PING)](/invoice_services_pt/experiencia_usuario/teste_conexao)

Existe um método disponível para verificação de estabilidade do serviço de usando PING.

UI

Obrigatório

[Habilitar/Desabilitar a Utilização dos Serviços](/invoice_services_pt/experiencia_usuario/utilizacao_servico)

O usuário poderá habilitar / desabilitar os serviços do AvaTax a qualquer momento. É indicado a criação de um flag para operacionalizar isso.

UI

Obrigatório

[Serviços de Log Compreensivos](/invoice_services_pt/experiencia_usuario/logging)

Dado que todas as transações são baseadas em solicitação e resposta de JSON, os parceiros deverão providenciar logs dessas transações, caso seja necessário a verificação de dados ou cálculos. Fica a critério do parceiro definir o tempo de permanência desses dados no sistema.

UI

Obrigatório

[Selecionar opções de ambiente](/invoice_services_pt/experiencia_usuario/selecionar_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

Sugerido

[Painel de Controle de Nota Fiscal Eletronica](/invoice_services_pt/experiencia_usuario/painel)

Disponibilizar um cockpit de controle de emissão de nota fiscal eletrônica, que permita ao cliente consultar se a nota fiscal eletrônica foi autorizada, ou rejeitada, e ainda, realizar cancelamentos, quando o municipio dispoe dessa funcionalidade. Este painel de controle deve fornecer qualquer outra funcionalidade que seja exigida pelos municípios no que tange à funcionalidades de mensageria.

UI

Obrigatório

[Verificação de ambiente](/invoice_services_pt/experiencia_usuario/check_de_ambiente)

Disponibilizar evidencias que demonstrem em qual ambiente (Produção ou SandBox) o cliente/parceiro está operando.

UI

Sugerido

[Configuração de Tempo de Expiração da Chamada](/invoice_services_pt/experiencia_usuario/tempo_limite)

Ser possível configurar um tempo de expiração para cada chamada realizada pela API (timeout).

Configuração oculta

Obrigatório

[API base URL](/invoice_services_pt/experiencia_usuario/api_base)

As URLs devem ser configuráveis.

Configuração oculta

Obrigatório

[Versão](/invoice_services_pt/experiencia_usuario/versao)

Informar compatibilidade de versão com o ERP com o conector.

Documentação

Obrigatório

[Guia de Implementação do Usuário](/invoice_services_pt/experiencia_usuario/guia-de-implementacao)

Disponibilizar um Guia de Implementação ao Usuário contendo todos os passos necessários para que seja realizada a configuração do integrador.

Documentação

Obrigatório

[Arquitetura](/invoice_services_pt/experiencia_usuario/arquetetura)

Fornecer informações sobre a arquitetura do conecotor, bem como os pré-requisitos necessários para seu funcionamento.

Documentação

Transações de Venda

A tabela abaixo apresenta uma lista com as transações de venda da Nota Fiscal Eletrônica de Serviços (NFS-e). 

**Condição**

**Cenários**

**Transações**

Obrigatório

[Serviços Dentro da Cidade de Origem da Empresa](/invoice_services_pt/transacoes/servicos_dentro_da_cidade)

Venda

Obrigatório

[Serviços Fora da Cidade de Origem da Empresa](/invoice_services_pt/transacoes/servicos_fora_cidade)

Venda

Sugerido

[Exportação de Serviços](/invoice_services_pt/transacoes/exporracao_servicos)

Venda

Sugerido

[Prestação de Serviços com Deduções](/invoice_services_pt/transacoes/servicos_com_deducao)

Venda

Sugerido

[Construção Civil](/invoice_services_pt/transacoes/setor-de-construcao-civil)

Venda

[Anterior](/invoice_services_pt/como_comecar/sobre_o_programa)

[Próxima](/invoice_services_pt/como_comecar/recursos_adicionais/doc_api)