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.

Válido para os módulos: CCT Aéreo e e-AWB

Como configurar uma nova integração Web Service

1. Acessar

• Faça login na plataforma Lead Comex com o perfil indicado na tabela acima, de acordo com o módulo (CCT Aéreo ou e-AWB)

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

• Acesse Configurar Integrações pelo caminho indicado na tabela acima para o seu módulo

• 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)

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

• Renovar Token: Consulte a data de vencimento do token e clique no botão Renovar para atualizá-lo antes que expire.

• 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

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

4.2. URL de Resposta

Campos:

• URL de retorno: Insira a URL fornecida pelo cliente

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

• 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 (Módulo CCT Aéreo)

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

Veja abaixo a tela de configuração em cada módulo: