EME4 – Integração Externa – Integração WS – Configurações Integração WS
Confiança da documentação: Alta
Visão Geral
Cadastra as configurações de integração com serviços externos via Web Service. Utilize esta tela para registrar layouts, credenciais de acesso e parâmetros específicos de cada integração disponível.
Caminho no Sistema
Menu: Integração Externa > Integração WS > Configurações Integração WS
Ações disponíveis
Confirmar
Onde usar: Aba "Cabeçalho"
Descrição: Grava as informações preenchidas na tela.Cancelar
Onde usar: Aba "Cabeçalho"
Descrição: Descarta as alterações e fecha a tela sem salvar.
h Param Int Bling
Ao selecionar um registro na lista principal, o sistema exibe os detalhes em grade nesta aba:
- [Data Última Nota Fiscal Integrada] – Informe a data da última nota fiscal integrada.
- [Hora Última Nota Fiscal Integrada] – Informe a hora da última nota fiscal integrada.
- [Chave Última Nota Fiscal Integrada] – Informe a chave da última nota fiscal integrada.
Estrutura da Tela
Cabeçalho
Reúne os dados principais da configuração de integração.
Campos
| Campo | Obrigatório | Descrição |
|---|---|---|
| Nome Físico (Controle Interno) | Não | Informe o identificador interno da configuração. |
| Descrição | Não | Informe a descrição da configuração. |
| Layout | Não | Selecione o layout da integração entre as opções disponíveis. — Opções: WSys / KMM / Mormaii / AgriOne / Correios / Fujilabs / e-Sign / SkyHub / Totali / Shopify / API Banco do Brasil / Intelipost / WhatsApp Z-API / API SGU / LojaTray / Sicoob Pix Token / Sicoob Pix / VTigger CRM / Pagar.me V5 / Cobrança Hibrida Pix / Galaxy Pay - Celcoin / PagSeguro - PagBank EDI / Unicred / Vindi |
| URL Namespace | Não | Informe a URL do namespace do serviço. |
| Utiliza WSDL | Não | Indique se a integração utiliza WSDL. |
| Identificação Email Erros Integração | Não | Informe o e-mail para envio de notificações de erros da integração. |
| Almox. Prod. WS | Não | Selecione o almoxarifado de produtos vinculado ao Web Service. |
| Refresh Token | Não | Informe o refresh token utilizado na autenticação. |
| Data Expira Token | Não | Informe a data de expiração do token. |
| Hora Expira Token | Não | Informe a hora de expiração do token. |
| Client ID | Não | Informe o Client ID utilizado na autenticação. |
| Client Secret | Não | Informe o Client Secret utilizado na autenticação. — Opções: SENHA |
| State | Não | Informe o valor de state utilizado na autenticação. |
| Tipo Response | Não | Selecione o tipo de resposta esperada: Code ou Token. — Opções: Code / Token |
| URL Callback | Não | Informe a URL de callback da autenticação. |
| Ativo | Não | Indique se a configuração está ativa. |
Esta aba pode depender de configurações do sistema.
Botões disponíveis:
Confirmar
Onde usar: Aba "Cabeçalho"
Descrição: Grava as informações preenchidas na tela.Cancelar
Onde usar: Aba "Cabeçalho"
Descrição: Descarta as alterações e fecha a tela sem salvar.
Aba: Métodos WS
Lista os métodos do Web Service vinculados à configuração.
A tela é dividida em duas áreas: na parte superior, o formulário de edição; na parte inferior, a lista de registros vinculados.
Campos
| Campo | Obrigatório | Descrição |
|---|---|---|
| Nome Lógico/Descrição | Não | Informe o nome lógico ou descrição do método. |
| Nome Físico (Controle Interno) | Não | Informe o identificador interno da configuração. |
| Recurso (complemento da URL) | Não | Informe o complemento da URL do recurso. |
| Verbo HTTP | Não | Selecione o verbo HTTP do método. — Opções: GET / POST / PUT / PATCH / DELETE / WEBHOOK |
| Tipo | Não | Selecione o tipo do registro. — Opções: Nenhum / SOAP / Rest / GraphQL |
| Query Filter/Parameters | Não | Informe os filtros ou parâmetros da requisição. |
Aba: Produtos WS
Agrupa campos complementares do registro.
Os campos desta aba não puderam ser identificados automaticamente. Isso pode ocorrer devido a carregamento dinâmico ou regras condicionais do sistema.
Aba: Serviços Correios
Lista os serviços dos Correios vinculados à configuração.
A tela é dividida em duas áreas: na parte superior, o formulário de edição; na parte inferior, a lista de registros vinculados.
Campos
| Campo | Obrigatório | Descrição |
|---|---|---|
| Código | Não | Informe o código do serviço. |
| Descrição | Não | Informe a descrição da configuração. |
| ID Serviço Correios | Não | Informe o ID do serviço dos Correios. |
Aba: Parâmetros Autenticação/Autorização
Agrupa parâmetros de autenticação e autorização da integração.
A tela é dividida em duas áreas: na parte superior, o formulário de edição; na parte inferior, a lista de registros vinculados.
Campos
| Campo | Obrigatório | Descrição |
|---|---|---|
| Formato | Não | Selecione o formato do parâmetro. |
| Impressora | Não | Selecione a impressora vinculada. |
| Tipo | Não | Selecione o tipo do registro. — Opções: Pré-Matrícula / Ficha de Treino |
Aba: Parâmetros Bling
Agrupa parâmetros específicos da integração com o Bling.
A tela é dividida em duas áreas: na parte superior, o formulário de edição; na parte inferior, a lista de registros vinculados.
Campos
| Campo | Obrigatório | Descrição |
|---|---|---|
| Data Última Nota Fiscal Integrada | Não | Informe a data da última nota fiscal integrada. |
| Hora Última Nota Fiscal Integrada | Não | Informe a hora da última nota fiscal integrada. |
| Chave Última Nota Fiscal Integrada | Não | Informe a chave da última nota fiscal integrada. |
Sub-aba: Tipo Doc X Padrao Doc
Lista
- [Empresa] – Selecione a empresa vinculada.
- [Tipo Documento] – Selecione o tipo de documento.
- [Descrição] – Informe a descrição da configuração.
- [Centro Custo] – Selecione o centro de custo.
- [Manter Valores do XML] – Indique se os valores do XML devem ser mantidos.
- [Importar Unidade Padrão Caso Unidade XML Inválida] – Indique se a unidade padrão deve ser importada quando a unidade do XML for inválida.
- [IDF Parâmetro Empresa Geral] – Informe o identificador do parâmetro de empresa geral.
- [Representante] – Selecione o representante vinculado.
- [Série da Nota Fiscal] – Informe a série da nota fiscal.
Aba: Parâmetros Unicred
Agrupa parâmetros específicos da integração com a Unicred.
A tela é dividida em duas áreas: na parte superior, o formulário de edição; na parte inferior, a lista de registros vinculados.
Campos
| Campo | Obrigatório | Descrição |
|---|---|---|
| Tipo Documento Integração | Sim | Selecione o tipo de documento da integração. |
| Data Último Webhook Recebido | Não | Informe a data do último webhook recebido. |
| Hora Último Webhook Recebido | Não | Informe a hora do último webhook recebido. |
Aba: Parâmetros EDI
Agrupa parâmetros específicos da integração EDI.
A tela é dividida em duas áreas: na parte superior, o formulário de edição; na parte inferior, a lista de registros vinculados.
Campos
| Campo | Obrigatório | Descrição |
|---|---|---|
| Tipo Movimento | Não | Selecione o tipo de movimento. — Opções: Transactional / Financial / Cashouts / Balances |
| Última Data do Movimento de EDI | Não | Informe a data do último movimento de EDI. |
Aba: Parâmetros Vindi
Agrupa parâmetros específicos da integração com a Vindi.
A tela é dividida em duas áreas: na parte superior, o formulário de edição; na parte inferior, a lista de registros vinculados.
Campos
| Campo | Obrigatório | Descrição |
|---|---|---|
| Tipo de Documento Integração | Sim | Selecione o tipo de documento da integração. |
Aba: Produtos WS Mormaii
Lista os produtos vinculados à integração Mormaii.
A tela é dividida em duas áreas: na parte superior, o formulário de edição; na parte inferior, a lista de registros vinculados.
Campos
| Campo | Obrigatório | Descrição |
|---|---|---|
| Inativo | Não | Indique se o produto está inativo. |
| Produto | Sim | Selecione o produto vinculado. |
Pré-requisitos
- Client ID preenchido para autenticação do Token.
- Client Secret preenchido para autenticação do Token.
- Refresh Token preenchido para autenticação do Token.
- URL preenchida para autenticação do Token.
Regras do Sistema
Validações gerais
- Campo URL é obrigatório para autenticação do Token. Preencha e tente novamente. (campo: [Definição URL Serviço])
- Campo Client FID é obrigatório para autenticação do Token. Preencha e tente novamente. (campo: [Client ID])
- Campo Client Secret é obrigatório para autenticação do Token. Preencha e tente novamente. (campo: [Client Secret])
- Campo Refresh Token é obrigatório para autenticação do Token. Preencha e tente novamente. (campo: [Refresh Token])
- Não é possível finalizar o apontamento com as operações vazias.
- Houve um erro na validação da URL do token, necessario verificar se está preenchida.
- API Bling não retornou o access token na revalidação do acesso.
- API Bling não retornou o refresh token na revalidação do acesso.
- API Bling não retornou o expires_in na revalidação do acesso.
Ações Especiais
- Confirmar: Confirma e grava as alterações do registro.
- Cancelar: Cancela a edição atual.
Como Usar
- Acesse pelo menu: Integração Externa > Integração WS > Configurações Integração WS
- Informe os filtros ou parâmetros do cabeçalho: [Nome Físico (Controle Interno)], [Descrição], [Layout], [URL Namespace], [Utiliza WSDL], [Identificação Email Erros Integração]
- Clique para carregar os dados e revise os resultados em: Métodos WS, Serviços Correios, Parâmetros Autenticação/Autorização, Parâmetros Bling, Parâmetros Unicred, Parâmetros EDI, Parâmetros Vindi, Produtos WS Mormaii
- Quando necessário, utilize Cancelar para Cancela a edição atual.
- Conclua a operação clicando em Confirmar
Observações
- Abas sem campos confirmados: Produtos WS
- Campos ocultos por padrão foram omitidos da estrutura inicial: Definição WSDL, Definição URL Serviço, Definição Serviço, Usuário Autenticação, Senha, API Key (Token), Account Manager Key (Token), Usuario
Documentos Relacionados
Pré-requisitos
- Importar Identificações - pode ser necessário quando o processo depende de Identificação Email Erros Integração.