Configurar Integração Web Service

Este artigo apresenta as orientações para configuração de integrações de sistemas externos com a plataforma Lead Comex, destinado aos usuários com perfil Administrador responsáveis por estabelecer conexões entre a plataforma e sistemas de clientes.

Palavras chave:

• Cliente: quando apenas a palavra “cliente” aparecer no artigo, ele se refere ao cliente indireto da Lead Comex, ou seja, o cliente do nosso cliente, que pode ser, por exemplo, um agente de carga ou transportador.
  O “cliente” é quem terá a configuração de integração registrada.

• Cliente Lead Comex: quando o termo “cliente Lead Comex” aparecer no artigo, se refere ao cliente direto da plataforma, que opera e utiliza nossos serviços diretamente.

• Empresa: referente à Empresa do cliente Lead Comex, o CNPJ da conta.

Perfil administrador

O Administrador é o usuário, cliente Lead Comex, responsável pela administração e configuração da plataforma.

Um usuário administrador, cliente da Lead Comex, pode realizar por conta própria, a configuração de integração.

Como configurar uma nova integração Web Service

Pré-requisitos

• Acesso como usuário Administrador

• Dados completos do cliente (nome, CNPJ, URL de retorno)

1. Acessar a Empresa Cliente

• Faça login na plataforma Lead Comex

• Localize e acesse a empresa que solicitou a integração e é responsável pelo cliente que terá a integração configurada.

• Certifique-se de estar logado com o perfil Administrador

2. Navegar para Configurações de Integração

• No menu de Funcionalidades, acesse Configurar Integrações

• Visualize as integrações existentes (se houver) e consulte pelo CNPJ do cliente

3. Verificar Integração

• Se o cliente já possui configuração:

  • Revise a configuração existente e se os dados serão atualizados

  • Prossiga para edição ou confirme antes com o cliente, sobre as mudanças, se necessário

• Se o cliente não possui configuração:

  • Clique em INSERIR

  • Prossiga com a criação de nova configuração

4. Configurar Integração Web Service

Na aba de CONFIGURAR WEBSERVICE, configure:

4.1. Geração do Token

Observações:

• O sistema gerará automaticamente um token único

• Este token será utilizado para autenticação nas chamadas da API

• Importante: Anote o token gerado para envio ao cliente

Campos:

• Prazo de validade do token: recomendamos selecionar o maior prazo (Anual)

• Utiliza retorno SOAP: indica se o retorno será enviado com o envelope SOAP

• Token de acesso: Campo onde o token, após ser gerado, estará disponível para ser compartilhado com o cliente Lead Comex e utilizado nos retornos

• GERAR TOKEN / BLOQUEAR TOKEN: Botão de ação para gerar um novo token ou bloquear o token atual. É possível gerar um novo token após o bloqueio

4.2. URL de Resposta

Campos:

• URL de retorno: insira a URL fornecida pelo cliente Lead Comex

• Token de retorno: caso seja necessário a plataforma da Lead enviar um token ao sistema externo durante o retorno, preencha o campo conforme fornecido pelo cliente Lead Comex

• Marque a flag “Deseja enviar automaticamente os arquivos de integração para a Receita Federal?“ para que a integração realize os envios ao CCT automaticamente

5. Salvar e Validar Configurações

• Revise todas as informações inseridas

• Salve as configurações

Informações de Entrega ao Cliente

Após finalizar a configuração, forneça ao cliente:

• Cliente e CNPJ configurados

• Token gerado pelo sistema

• URL configurada para retorno

• Utiliza SOAP ou não