> For the complete documentation index, see [llms.txt](https://ajuda.consistem.com.br/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://ajuda.consistem.com.br/consistem-integracoes/areas-de-negocio/comercial/arroba.md). # Arroba Integração | Comercial ### Visão geral A integração entre o Consistem ERP e a plataforma Arroba tem como objetivo principal automatizar e centralizar a troca eletrônica de dados entre os ecossistemas. A solução permite otimizar o fluxo de trabalho, eliminando o preenchimento manual de informações, reduzindo custos operacionais e evitando inconsistências por digitação duplicada. Neste modelo de arquitetura, a plataforma Arroba consome ativamente as rotinas da Consistem API (método *pull/push*). Através dessa comunicação, o Arroba consulta informações cadastrais atualizadas (como clientes, fornecedores e produtos) e envia movimentações de negócio (como pedidos de venda e títulos financeiros), recebendo atualizações e confirmações operacionais em tempo real. ### Requisitos
Consistem ERPArroba

Compatibilidade: 7.5 ou superiores do Consistem ERP.

Módulos: Cadastros Gerais, Comercial e Financeiro.

Licença: Aquisição de licença ARRO ativa junto à Consistem.

Orientamos o acompanhamento da nossa equipe de consultores.

Aquisição de licença e implantação deve ser verificada com a empresa fornecedora.
Serviço Consistem API: Camada de Web Services ativada e publicada no servidor do cliente.Motor de Consumo: Aplicação/Script capaz de realizar requisições HTTP REST com envio de cabeçalhos de autenticação (Headers).
Infraestrutura: URL pública e canal seguro (HTTPS) liberados para o endereço IP da Arroba.Credenciais de Acesso: Disponibilidade da Chave de Acesso (API Key) ou Token gerado pelo ERP.
Mapeamento de Tabelas: Tabelas de conversão (De/Para) parametrizadas para alinhar domínios e regras.
### Configuração da integração Pelo fato de a plataforma Arroba consumir ativamente as interfaces da Consistem API, não é necessário realizar parametrizações de envio no programa [Integração (CSINTEGRACAO010)](/modulos/componentes/manuais-de-telas/cadastros-gerais-de-componentes/integracao.md) dentro do Consistem ERP. A configuração limita-se à liberação do serviço de API no ERP e ao direcionamento dos endpoints no Arroba. #### No Consistem ERP: 1. **Ativação e Validação do Serviço Consistem API:** Certifique-se de que a infraestrutura da Consistem API está devidamente instalada, publicada e com licenciamento ativo. 2. **Geração de Chaves de Acesso (*****API Key / Token*****):** Acessar o painel de gerenciamento do barramento da Consistem API e gerar a chave/token de autenticação exclusiva para a aplicação Arroba. 3. **Definição de Permissões de Acesso:** Associar a chave gerada às permissões de leitura (GET) e gravação (POST/PUT) necessárias aos módulos do negócio (Comercial, Financeiro, Cadastros Gerais). 4. **Disponibilização de URLs e Endpoints:** Fornecer à equipe técnica do Arroba a URL Base do ambiente do cliente (Homologação e Produção) acompanhada da documentação dos endpoints ativos. #### No Arroba: 1. **Parametrização da URL de Conexão:** No painel de configurações do Arroba, informar a URL Base da Consistem API. 2. **Inserção do Token de Autenticação:** Cadastrar a chave de acesso gerada no ERP no cabeçalho (*Header*) de todas as requisições enviadas pelo Arroba. 3. **Mapeamento de Tabelas (De/Para):** Configurar as correspondências de códigos (ex: tipos de pagamento, modalidades de frete, categorias de clientes) para corresponderem aos domínios e regras do Consistem ERP. 4. **Definição do Cronograma de Leitura/Envio:** Configurar no Arroba a periodicidade e o intervalo das chamadas automáticas para busca ou envio de informações. ### Como a integração funciona A troca de mensagens entre o Consistem ERP e a plataforma Arroba é estabelecida sob o modelo arquitetural API REST utilizando o protocolo seguro HTTPS: * **Formato de Comunicação:** Toda a estrutura de requisições e respostas é formatada em JSON, organizando atributos e objetos de acordo com as especificações técnicas das rotinas da Consistem. * **Processamento de Requisição (Consumo Ativo):** O Arroba dispara chamadas para buscar registros (*endpoints de consulta*) ou efetuar inclusões/alterações (*endpoints de gravação*). * **Validação e Segurança:** A Consistem API intercepta as requisições, valida a chave de acesso no cabeçalho, verifica a sintaxe e executa as validações de regra de negócio no banco de dados do ERP antes de persisti-las. * **Respostas HTTP:** * **200 OK / 201 Created:** Requisição efetuada e processada com sucesso. * **400 Bad Request:** Inconsistência de validação ou erro nas regras do payload. * **401 Unauthorized / 403 Forbidden:** Falha nas credenciais ou falta de permissão de acesso. ### Fluxo do processo O fluxo de trabalho descreve os passos operacionais executados quando a plataforma Arroba se comunica com a Consistem API, utilizando a estrutura padronizada de dados do ERP (denominada leiaute): 1. **Início do Evento no Arroba:** A plataforma Arroba dispara uma rotina agendada ou uma ação de usuário para consultar ou enviar informações ao Consistem ERP. 2. **Chamada ao Endpoint da Consistem API:** O Arroba efetua uma requisição HTTPS (GET, POST ou PUT) para o endpoint da Consistem API, contendo as credenciais no cabeçalho e os parâmetros necessários. 3. **Recepção e Validação do Leiaute Consistem:** A Consistem API recebe a requisição e valida se a estrutura trafegada está em conformidade com o leiaute padrão da Consistem: * O que o Leiaute Consistem contempla: * *Leiaute de Pessoas/Clientes:* Razão Social, Nome Fantasia, CPF/CNPJ, Inscrições Fiscais, Endereços, Contatos e Representante. * *Leiaute de Produtos:* Código do item, Descrição, Unidade de Medida, NCM, Tabelas de Preço e Saldos. * *Leiaute Comercial/Pedidos:* Cabeçalho do pedido, dados do cliente, itens, valores unitários e totais, impostos e condição de pagamento. * *Leiaute Financeiro:* Títulos de contas a receber/pagar, movimentações, vencimentos e dados de liquidação. 4. **Processamento no Banco de Dados do ERP:** A Consistem API processa as informações aplicando as regras de negócio do ERP. Em consultas (GET), extrai os dados do banco; em gravações (POST/PUT), persiste ou atualiza os registros nas tabelas do ERP. 5. **Resposta e Confirmação ao Arroba:** A Consistem API retorna o resultado da transação em formato JSON: * **Em caso de Sucesso:** Código HTTP 200/201 acompanhado das chaves gravadas e dados estruturados no leiaute Consistem. * **Em caso de Inconsistência:** Código HTTP 400/500 acompanhado da mensagem explicativa para tratamento da exceção no Arroba. 6. **Finalização do Ciclo:** O Arroba recebe o retorno da Consistem API, atualiza os status em seu banco de dados local com o protocolo recebido e encerra o ciclo do processo.

Esse conteúdo foi útil?

Sim Não

--- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://ajuda.consistem.com.br/consistem-integracoes/areas-de-negocio/comercial/arroba.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.