Integração com Venda+

Realize a habilitação do módulo do e-commerce conforme instruções da documentação de Módulos.

Crie uma nova aplicação, conforme descrito na documentação do nosso Portal de APIs.

Durante a criação da aplicação, é necessário selecionar as opções abaixo:

• Foundation;
• Autenticação;
• Autorização;
• Pedido;
• Produto.

Após realizar essa parametrização, guarde a informação do client_id, pois esse dado será importante para os próximos passos.

O cadastro de uma aplicação é equivalente a de um usuário, tendo como diferença que uma aplicação não possui usuário e senha, mas sim chave e segredo. Deste modo, essas informações não seguem a política de senha e, portanto, não expiram.

Para cadastrar uma aplicação, acesse o menu Tecnologia > Administração > Gerenciamento de Aplicações.

Clique em Nova aplicação e informe o Nome e a Descrição.

Após salvar a aplicação, as chaves são geradas.

Uma aplicação quando cadastrada, não possui permissões associadas. Elas podem ser configuradas através da tela de gerenciamento de papéis, onde é possível adicionar e remover uma aplicação em um ou mais papéis.

Ao processar requisições de uma aplicação, a plataforma envia o nome da aplicação na mensagem como um usuário comum. Desse modo, a verificação de permissões é a mesma, não importanto se é um usuário ou uma aplicação que está fazendo a chamada para a plataforma.

O login de uma aplicação deve ser feito através da primitiva https://api.senior.com.br/platform/authentication/anonymous/loginWithKey que recebe como parâmetro: chave, segredo, nome do tenant (obrigatório) e escopo (opcional).

É necessário relacionar o usuário de aplicação com um papel para conceder as permissões necessárias. Para isso, consulte nossa documentação de Gestão de papéis.

Inclua as definições para o usuário de aplicação. Essa ação deve ser feita no caminho Cadastro > Definições de usuário, habilitando as permissões na guia Comercial. Para mais detalhes sobre essa rotina, consulte nossa documentação de Definições de usuário;

O caminho para acessar a tela de cadastro de webhook é: Tecnologia > Customização > Events hub > Webhooks

Cada webhook da listagem deve ser configurado para que as integrações ocorram corretamente.

Caso o webhook desejado não apareça na listagem de webhooks, é possível adicioná-lo clicando no botão Novo.

Para editar um webhook que já está cadastrado clique em Ações, e em seguida em Editar.

A tela a seguir mostra os dados do webhook, onde é possível ver qual a Url utilizada, se ele está ativo ou não e ativar ou inativar. É possível também editar as configurações clicando no botão da coluna Ações.

Os campos devem ser preenchidos com as seguintes informações:

• URL: URL de publicação da function a ser acionada pelo webhook e que será responsável por inserir, atualizar e/ou remover os dados do firebase.

• Username: Insira o valor gerado na chave de acesso, conforme orientado no passo 3 - Cadastrar aplicação.

• Password: Preencha com o valor do secret gerado durante o cadastro da aplicação, conforme descrito no passo 3 - Cadastrar aplicação.

• Cabeçalho HTTP: Deve possuir um campo com a chave id e valor idCompanyDoCliente. O idCompany preenchido deve ser o mesmo gerado para o cliente no momento do cadastro do usuário master.

Clientes

Os webhooks responsáveis pela integração de cadastro de clientes são:

• erpx/foundation/customerCreated
  • https://us-central1-mega-retaguardaweb.cloudfunctions.net/api/g7/webhooks/customercreated
• erpx/foundation/customerUpdated
  • https://us-central1-mega-retaguardaweb.cloudfunctions.net/api/g7/webhooks/customerupdated

• erpx/foundation/personUpdated
  • https://us-central1-mega-retaguardaweb.cloudfunctions.net/api/g7/webhooks/personupdated

Endereço de entrega

Os webhooks responsáveis pela integração de endereço de entrega são:

• erpx/foundation/addressCreated
  • https://us-central1-mega-retaguardaweb.cloudfunctions.net/api/g7/webhooks/addresscreated
• erpx/foundation/addressUpdated
  • https://us-central1-mega-retaguardaweb.cloudfunctions.net/api/g7/webhooks/addressupdated

Condições de pagamento

Os webhooks responsáveis pela integração de cadastro de condições de pagamento são:

• erpx/foundation/paymentTermsCreated
  • https://us-central1-mega-retaguardaweb.cloudfunctions.net/api/g7/webhooks/paymenttermscreated

• erpx/foundation/paymentTermsUpdated
  • https://us-central1-mega-retaguardaweb.cloudfunctions.net/api/g7/webhooks/paymenttermsupdated

Formas de cobrança

Os webhooks responsáveis pela integração de cadastro de formas de cobrança são:

• erpx/foundation/paymentMethodCreated
  • https://us-central1-mega-retaguardaweb.cloudfunctions.net/api/g7/webhooks/paymentmethodcreatedorupdated
• erpx/foundation/paymentMethodUpdated
  • https://us-central1-mega-retaguardaweb.cloudfunctions.net/api/g7/webhooks/paymentmethodcreatedorupdated

Produtos

Os webhooks responsáveis pela integração de cadastro de produtos são:

• erpx/foundation/productUpdated
  • https://us-central1-mega-retaguardaweb.cloudfunctions.net/api/g7/webhooks/productupdated

• erpx/foundation/commercialProductCreated
  • https://us-central1-mega-retaguardaweb.cloudfunctions.net/api/g7/webhooks/commercialproductcreated
• erpx/foundation/commercialProductUpdated
  • https://us-central1-mega-retaguardaweb.cloudfunctions.net/api/g7/webhooks/commercialproductupdated
• erpx/foundation/stockProductCreated
  • https://us-central1-mega-retaguardaweb.cloudfunctions.net/api/g7/webhooks/stockproductcreated

• erpx/foundation/stockProductUpdated
  • https://us-central1-mega-retaguardaweb.cloudfunctions.net/api/g7/webhooks/stockproductupdated

Famílias

O webhook responsáveis pela integração de cadastro de famílias é:

• erpx/foundation/familyUpdated
  • https://us-central1-mega-retaguardaweb.cloudfunctions.net/api/g7/webhooks/familyupdated

Tabelas de preço

Os webhooks responsáveis pela integração de cadastro de tabelas de preço são:

• erpx/foundation/salePriceListItemCreated
  • https://us-central1-mega-retaguardaweb.cloudfunctions.net/api/g7/webhooks/salepricelistitemcreated

• erpx/foundation/salePriceListItemUpdated
  • https://us-central1-mega-retaguardaweb.cloudfunctions.net/api/g7/webhooks/salepricelistitemupdated

• erpx/foundation/salePriceListUpdated
  • https://us-central1-mega-retaguardaweb.cloudfunctions.net/api/g7/webhooks/salepricelistupdated

• erpx/foundation/salePriceListValidityUpdated
  • https://us-central1-mega-retaguardaweb.cloudfunctions.net/api/g7/webhooks/salepricelistvalidityupdated

• erpx/foundation/salePriceListDeleted
  • https://us-central1-mega-retaguardaweb.cloudfunctions.net/api/g7/webhooks/salepricelistdeleted

• erpx/foundation/salePriceListValidityDeleted
  • https://us-central1-mega-retaguardaweb.cloudfunctions.net/api/g7/webhooks/salepricelistvaliditydeleted

• erpx/foundation/salePriceListItemDeleted
  • https://us-central1-mega-retaguardaweb.cloudfunctions.net/api/g7/webhooks/salepricelistitemdeleted

Transportadoras

Os webhooks responsáveis pela integração de cadastro de transportadora são:

• erpx/foundation/shippingCompanyCreated
  • https://us-central1-mega-retaguardaweb.cloudfunctions.net/api/g7/webhooks/shippingcompanycreated

• erpx/foundation/shippingCompanyUpdated
  • https://us-central1-mega-retaguardaweb.cloudfunctions.net/api/g7/webhooks/shippingcompanyupdated

Sincronização de pedidos de venda

Integração com o ERP

Os webhooks responsáveis pelo retorno do status da integração de pedidos de venda são:

• erpx_com_ven/pedido/orderGenerationSuccess
  • https://us-central1-mega-retaguardaweb.cloudfunctions.net/api/g7/webhooks/ordergenerationsuccess

• erpx_com_ven/pedido/orderGenerationError
  • https://us-central1-mega-retaguardaweb.cloudfunctions.net/api/g7/webhooks/ordergenerationerror

Alteração de status

Os webhooks responsáveis pela sincronização das atualizações de status do pedido de venda são:

• erpx_com_ven/pedido/saleOrderClosed
  • https://us-central1-mega-retaguardaweb.cloudfunctions.net/api/g7/webhooks/saleorderclosed

• erpx_com_ven/pedido/saleOrderCanceled
  • https://us-central1-mega-retaguardaweb.cloudfunctions.net/api/g7/webhooks/saleordercanceled

• erpx_com_ven/pedido/saleOrderInvoiced
  • https://us-central1-mega-retaguardaweb.cloudfunctions.net/api/g7/webhooks/saleorderinvoiced
• erpx_com_ven/pedido/saleOrderDeleted
  • https://us-central1-mega-retaguardaweb.cloudfunctions.net/api/g7/webhooks/saleorderdeleted