RN Integracao Shopee v2: mudanças entre as edições

De Base de Conhecimentos da DataPlus Sistemas
Ir para navegação Ir para pesquisar
Vinicius (discussão | contribs)
Sem resumo de edição
Vinicius (discussão | contribs)
Sem resumo de edição
 
(12 revisões intermediárias pelo mesmo usuário não estão sendo mostradas)
Linha 3: Linha 3:
Para a versão 2 da API da Shopee, foi incluído um novo processo de autenticação de usuário/aplicativo.
Para a versão 2 da API da Shopee, foi incluído um novo processo de autenticação de usuário/aplicativo.


== 1° Passo - Acessar Aplicativos ==
== Acoplamento ==
Essa regra de negócio só poder acoplada à entidade Comum.IntegracaoDadosExternos. Ela está preparada para funcionar com o elemento '''ExecutaOperacao''', sendo seu designador por '''Execução''' e tempo de execução '''Depois'''.


Acessar Link:
== Parâmetros ==
[https://open.business.accounts.shopee.com/authenticate/login?client_id=11&should_hide_back=true&next=https%3A%2F%2Fopen.shopee.com%2Fopservice%2Fapi%2Fv1%2Faccount%2Finit_session%3Fredirect_url%3Dhttps%253A%252F%252Fopen.shopee.com%252F Shopee - Login]
'''UrlEcommerce:'''
<br>


Após acessar a conta, basta ir no Ícone de configurações -> Todas as configurações:
URL de homologação -> https://openplatform.sandbox.test-stable.shopee.sg
[[Arquivo:Configurações Bling - Preferências.png|centro]]
<br>


Depois basta ir em Cadastro -> Cadastro de Aplicativos: https://www.bling.com.br/login?r=https%3A%2F%2Fwww.bling.com.br%2Fcadastro.aplicativos.php
URL de produção -> https://openplatform.shopee.com.br
[[Arquivo:Configurações Bling - Cadastro de Aplicativos.png|centro]]


Depois basta selecionar o aplicativo ou criar um novo:
'''UrlAutorizacao:'''
[[Arquivo:Configurações Bling - Aplicativos.png|centro]]
<br>


Para criar um novo basta seguir as seguintes instruções: <ref>https://developer.bling.com.br/homologacao#inscri%C3%A7%C3%A3o</ref>
URL de homologação -> https://partner.test-stable.shopeemobile.com
<br>


Ao criar um novo aplicativo, a URL de Callback será essa: <ref>https://ws32.dataplussistemas.com.br/DataPlusERP.svc/AuthorizationEcommerce</ref>. Será uma URL definida no servidor da DataPlus.
URL de produção -> https://openplatform.shopee.com.br


Após a criação do aplicativo, você poderá obter as credenciais de acesso a API, como o ClientId e o ClientSecret:
[[Arquivo:Configurações Bling - Credenciais de Acesso.png|centro]]


== 2° Passo - Configuração no ERP ==
'''PartnerId:''' Partner ID (Identificador do aplicativo da Shopee);


No ERP basta informar as credencias ClientId e ClientSecret e uma identificação para recebimento do Token de autorização temporário '''(O token tem o tempo de expiração de 1 minuto)''' para a configuração do E-commerce:
'''PartnerKey:''' Partner Key (Chave Secreta do aplicativo da Shopee);
[[Arquivo:Info configuração e-commerce ERP.png|centro]]


Após informar o as credenciais e a identificação para recebimento do token, basta clicar no botão '''Gerar Token Autorização''', após o click uma tela na Web será aberta, para a autorização do aplicativo com o ERP:
'''ShopId:''' ID da Loja Shopee (ShopID);
[[Arquivo:Autorização Aplicativo E-commerce Bling - scopos.png|centro]]


Basta selecionar autorizar logo abaixo:
'''NumeroListaPrecoProdutos:''' Lista de Preços para realizar o envio dos produtos para o web service;
[[Arquivo:Autorização Aplicativo E-commerce Bling - Autorizar.png|centro]]


Após a autorização, você será redirecionado para o webservice da DataPlus, com a mensagem de '''ok''' você pode fechar a página e prosseguir com o segundo passo:
'''EmpresaReceptora:''' Empresa em que o pedido será integrado.
[[Arquivo:Retorno webservice ecommerce.png|centro]]


'''Lembrando que o token gerado após a aparição da mensagem expira em 1 minuto, caso o token expire será necessário repetir o processo.'''
'''QtdeEstoque:''' Quantidade de estoque fixa a ser enviada. Se for zero ou vazio, enviará o estoque atual individual de cada produto.
 
Após gerar o token de acesso temporário, basta clicar em '''Gerar Token Acesso''':
[[Arquivo:Mensagem sucesso configuração ecommerce.png|centro]]
 
Com a mensagem o ecommerce está configurado corretamente. '''As credenciais de acesso é guardado em um XML na pasta do usuário (C:\Users\Vinicius\AppData\Local) no arquivo ApiConfig no nó <ApiBlingV3>.'''
 
== Acoplamento ==
Essa regra de negócio só poder acoplada à entidade Comum.IntegracaoDadosExternos. Ela está preparada para funcionar com o elemento '''ExecutaOperacao''', sendo seu designador por '''Execução''' e tempo de execução '''Depois'''.
 
== Parâmetros ==
'''UrlEcommerce:''' Url do e-commerce https://api.bling.com.br/Api/v3;
 
'''ClientId:''' Credencial ClientId do aplicativo;
 
'''ClientSecret:''' Credencial ClientSecret do aplicativo;
 
'''CodigoStatusPedido:''' Código de status do pedido (do e-commerce) a ser considerado na busca de dados. Mais de um separados por vírgula;<br>
Códigos verificados e possíveis para utilização: <br>
'''6''': em aberto<br>
'''9''': atendido<br>
'''12''': cancelado<br>
'''15''': em andamento<br>
'''18''': venda agenciada<br>
'''21''': em digitação<br>
'''24''': verificado


'''CodigoStatusPedido:''' Código de status do pedido (do e-commerce) a ser considerado na busca de dados (Ex.: READY_TO_SHIP);


'''SituacaoCodigo:''' Código da situação padrão para a gravação dos pedidos;
'''SituacaoCodigo:''' Código da situação padrão para a gravação dos pedidos;


'''PortadorCodigo:''' Código do portador padrão para a gravação dos pedidos;
'''PortadorCodigo:''' Código do portador padrão para a gravação dos pedidos;
'''CondicaoPagto:''' Código da condicao de pagamento padrão para a gravação dos pedidos;


'''TransportadoraCodigo:''' Código da transportadora padrão para a gravação dos pedidos;
'''TransportadoraCodigo:''' Código da transportadora padrão para a gravação dos pedidos;
Linha 89: Linha 63:


'''DefinirEnqFiscal:''' Define o enquadramento fiscal do cliente ao integrá-lo;
'''DefinirEnqFiscal:''' Define o enquadramento fiscal do cliente ao integrá-lo;
'''EnqFiscalPessoaFisica:''' Código do enquadramento fiscal padrão para Pessoa Fisica ao integrar o cliente;
'''EnqFiscalPessoaJuridica:''' Código do enquadramento fiscal padrão para Pessoa Jurídica ao integrar o cliente;


'''FamiliasKit:''' Define quais famílias serão consideradas para kits na integração;
'''FamiliasKit:''' Define quais famílias serão consideradas para kits na integração;


'''NumeroListaPrecoProdutos:''' Lista de Preços para realizar o envio dos produtos para o web service;
'''CanaisVenda:''' Define quais serão os canais de venda dos produtos. Separar por vírgulas (Ex.: 91008, 91009);
 
'''Classificacao:''' Classificação utilizada no adiantamento;
 
'''Divisao:''' Divisão utilizada no adiantamento;
 
'''CentroCusto:''' Centro de Custo utilizada no adiantamento;
 
'''ContaBancaria:''' Conta utilizada no adiantamento;
 
'''NomeImpressoraEtiquetas:''' Nome da impressora para impressão de etiquetas;
 
'''ImpostoCodigoComissao:''' Código do imposto para comissão do marketplace.
 
'''ImpostoCodigoFreteCusto:''' Código do imposto para custo de frete que o vendedor paga.
 
== 1° Passo - Criar um Aplicativo ==
 
Acessar Link:
[https://open.business.accounts.shopee.com/authenticate/login?client_id=11&should_hide_back=true&next=https%3A%2F%2Fopen.shopee.com%2Fopservice%2Fapi%2Fv1%2Faccount%2Finit_session%3Fredirect_url%3Dhttps%253A%252F%252Fopen.shopee.com%252F Shopee - Login]
 
Após acessar a conta, basta ir até o "Personal Center"
[[Arquivo:Personal Center - Shopee Developer.png|Personal Center - Shopee Developer]]
 
<br>
<br>
 
Depois basta ir em Cadastro -> Cadastro de Aplicativos: [https://open.shopee.com/console/app Shopee - Aplicativo]
 
<br>
<br>
 
[[Arquivo:App - Shopee Developer.png|App - Shopee Developer]]
 
Depois basta selecionar o aplicativo ou criar um novo:
 
<br>
<br>
 
[[Arquivo:New App - Shopee Developer.png|New App - Shopee Developer]]
 
<br>
<br>
Ao criar um novo aplicativo, a URL de Callback (Redirect URL Domain) será essa: <ref>https://google.com</ref>.
 
Após a criação do aplicativo, você poderá obter as credenciais de acesso a API, como o Partner_id e o Partner_key:
 
<br>
<br>
 
[[Arquivo:Credenciais - Shopee Developer.png|Credenciais - Shopee Developer]]
 
== 2° Passo - Criar uma loja ==
Este procedimento é necessário prioritariamente em ambiente de homologação, visto que, em produção, a loja do cliente já estará previamente configurada e ativa.
 
<br>
<br>
 
[[Arquivo:Loja - Shopee Developer.png|Loja - Shopee Developer]]
 
 
== 3° Passo - Configuração no ERP ==
 
No ERP basta informar as credencias ClientId (Partner_id) e ClientSecret (Partner_key) para receber um código de identificação para a coleta do Token de autorização (Access Token) '''(o code obtido tem duração de 5 minutos)''' para a configuração do E-commerce.
 
Após informar o as credenciais e a identificação para recebimento do token, basta clicar no botão '''Gerar Token Autorização''', após o click uma tela na Web será aberta, para a autorização do aplicativo:
[[Arquivo:Credenciais (Code) Part.1 - Shopee Developer.png|Credenciais (Code) Part.1 - Shopee Developer]]
 
[[Arquivo:Credenciais (Code) Part.2 - Shopee Developer.png|Credenciais (Code) Part.2 - Shopee Developer]]
 
[[Arquivo:Credenciais (Code) Part.3 - Shopee Developer.png|Credenciais (Code) Part.3 - Shopee Developer]]


'''IdsLojas:''' ID das lojas (separadas por ;), que são utilizadas em questão de preço de produto;
Após realizar as confirmações necessárias, é preciso coletar a URL que foi retornada no site do '''Google''' e informar no campo '''Identificação Token Temporário'''
[[Arquivo:Credenciais (Code) Part.4 - Shopee Developer.png|Credenciais (Code) Part.4 - Shopee Developer]]


'''PercentualLojas:''' Percentuais (separados por ;) a serem aplicados nos preços da lista de preços para cada loja (relacionado com IdsLojas);
Após gerar o token de acesso temporário, basta clicar em '''Gerar Token Acesso''':
[[Arquivo:Credenciais (Code) Part.5 - Shopee Developer.png|Credenciais (Code) Part.5 - Shopee Developer]]


'''QtdeEstoque:''' Quantidade de estoque fixa a ser enviada. Se for zero ou vazio, enviará o estoque atual individual de cada produto.
<br>
 
Com a mensagem o ecommerce está configurado corretamente. As credenciais de acesso é armazenada em um XML na pasta do usuário '''(C:\Users\USUARIO\AppData\Local)''' no arquivo ApiConfig no nó <Shopee_Shop_PARTNER_ID>.


'''EmpresaReceptora:''' Empresa em que o pedido será integrado.
== Requisitos ==


'''DepositoId:''' Id do deposito para lançamento de estoque. Se 0 coleta o deposito padrão.
'''Produtos:'''
  Atributo adicional: J:\Vb.Net\Scripts\Atributos Adicionais\Adiciona campos adicionais no cadastro de Produto - Shopee.sql; <br>
  Marcar o produto para o aceite de integrações; <br>
  Informar embalagem com as dimensões; <br>
  E obrigatóriamente informar imagem(ns) no produto (ao menos uma) marcada como desenho.

Edição atual tal como às 16h45min de 20 de abril de 2026

Regra de negócio do tipo habilitadora, acoplável ao DataPlus ERP, com o objetivo de configurar e manipular a integração entre a API da Shopee (versão 2) e o DataPlusERP. Ela pode ser acessada por meio da tela de integração do sistema.

Para a versão 2 da API da Shopee, foi incluído um novo processo de autenticação de usuário/aplicativo.

Acoplamento

Essa regra de negócio só poder acoplada à entidade Comum.IntegracaoDadosExternos. Ela está preparada para funcionar com o elemento ExecutaOperacao, sendo seu designador por Execução e tempo de execução Depois.

Parâmetros

UrlEcommerce:

URL de homologação -> https://openplatform.sandbox.test-stable.shopee.sg

URL de produção -> https://openplatform.shopee.com.br

UrlAutorizacao:

URL de homologação -> https://partner.test-stable.shopeemobile.com

URL de produção -> https://openplatform.shopee.com.br


PartnerId: Partner ID (Identificador do aplicativo da Shopee);

PartnerKey: Partner Key (Chave Secreta do aplicativo da Shopee);

ShopId: ID da Loja Shopee (ShopID);

NumeroListaPrecoProdutos: Lista de Preços para realizar o envio dos produtos para o web service;

EmpresaReceptora: Empresa em que o pedido será integrado.

QtdeEstoque: Quantidade de estoque fixa a ser enviada. Se for zero ou vazio, enviará o estoque atual individual de cada produto.

CodigoStatusPedido: Código de status do pedido (do e-commerce) a ser considerado na busca de dados (Ex.: READY_TO_SHIP);

SituacaoCodigo: Código da situação padrão para a gravação dos pedidos;

PortadorCodigo: Código do portador padrão para a gravação dos pedidos;

CondicaoPagto: Código da condicao de pagamento padrão para a gravação dos pedidos;

TransportadoraCodigo: Código da transportadora padrão para a gravação dos pedidos;

OpSaidaCodigo: Código da operação de saída padrão para a gravação dos pedidos;

RepresentanteCodigo: Código do representante padrão para a gravação dos pedidos;

TelevendasCodigo: Código do televendas padrão para a gravação dos pedidos;

CaracteristicaCodigo: Código da característica de venda padrão para a gravação dos pedidos;

DiasPrazoEntrega: Prazo de entrega padrão, a partir da emissão, para pedidos (quantidade de dias);

TipoFrete: Tipo de frete;

StatusCliente: Código do status de pessoa para clientes trazidos do e-commerce;

RamoAtividadeCodigo: Código do ramo de atividade padrão para a gravação dos clientes;

DefinirEnqFiscal: Define o enquadramento fiscal do cliente ao integrá-lo;

EnqFiscalPessoaFisica: Código do enquadramento fiscal padrão para Pessoa Fisica ao integrar o cliente;

EnqFiscalPessoaJuridica: Código do enquadramento fiscal padrão para Pessoa Jurídica ao integrar o cliente;

FamiliasKit: Define quais famílias serão consideradas para kits na integração;

CanaisVenda: Define quais serão os canais de venda dos produtos. Separar por vírgulas (Ex.: 91008, 91009);

Classificacao: Classificação utilizada no adiantamento;

Divisao: Divisão utilizada no adiantamento;

CentroCusto: Centro de Custo utilizada no adiantamento;

ContaBancaria: Conta utilizada no adiantamento;

NomeImpressoraEtiquetas: Nome da impressora para impressão de etiquetas;

ImpostoCodigoComissao: Código do imposto para comissão do marketplace.

ImpostoCodigoFreteCusto: Código do imposto para custo de frete que o vendedor paga.

1° Passo - Criar um Aplicativo

Acessar Link: Shopee - Login

Após acessar a conta, basta ir até o "Personal Center" Personal Center - Shopee Developer



Depois basta ir em Cadastro -> Cadastro de Aplicativos: Shopee - Aplicativo



App - Shopee Developer

Depois basta selecionar o aplicativo ou criar um novo:



New App - Shopee Developer



Ao criar um novo aplicativo, a URL de Callback (Redirect URL Domain) será essa: <ref>https://google.com</ref>.

Após a criação do aplicativo, você poderá obter as credenciais de acesso a API, como o Partner_id e o Partner_key:



Credenciais - Shopee Developer

2° Passo - Criar uma loja

Este procedimento é necessário prioritariamente em ambiente de homologação, visto que, em produção, a loja do cliente já estará previamente configurada e ativa.



Loja - Shopee Developer


3° Passo - Configuração no ERP

No ERP basta informar as credencias ClientId (Partner_id) e ClientSecret (Partner_key) para receber um código de identificação para a coleta do Token de autorização (Access Token) (o code obtido tem duração de 5 minutos) para a configuração do E-commerce.

Após informar o as credenciais e a identificação para recebimento do token, basta clicar no botão Gerar Token Autorização, após o click uma tela na Web será aberta, para a autorização do aplicativo: Credenciais (Code) Part.1 - Shopee Developer

Credenciais (Code) Part.2 - Shopee Developer

Credenciais (Code) Part.3 - Shopee Developer

Após realizar as confirmações necessárias, é preciso coletar a URL que foi retornada no site do Google e informar no campo Identificação Token Temporário Credenciais (Code) Part.4 - Shopee Developer

Após gerar o token de acesso temporário, basta clicar em Gerar Token Acesso: Credenciais (Code) Part.5 - Shopee Developer


Com a mensagem o ecommerce está configurado corretamente. As credenciais de acesso é armazenada em um XML na pasta do usuário (C:\Users\USUARIO\AppData\Local) no arquivo ApiConfig no nó <Shopee_Shop_PARTNER_ID>.

Requisitos

Produtos:

 Atributo adicional: J:\Vb.Net\Scripts\Atributos Adicionais\Adiciona campos adicionais no cadastro de Produto - Shopee.sql; 
Marcar o produto para o aceite de integrações;
Informar embalagem com as dimensões;
E obrigatóriamente informar imagem(ns) no produto (ao menos uma) marcada como desenho.