https://wiki.dataplussistemas.com.br/api.php?action=feedcontributions&feedformat=atom&user=ViniciusBase de Conhecimentos da DataPlus Sistemas - Contribuições do usuário [pt-br]2026-05-15T05:06:36ZContribuições do usuárioMediaWiki 1.45.3https://wiki.dataplussistemas.com.br/index.php?title=RN_Integracao_Shopee_v2&diff=16277RN Integracao Shopee v22026-04-20T19:45:19Z<p>Vinicius: </p>
<hr />
<div>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.<br />
<br />
Para a versão 2 da API da Shopee, foi incluído um novo processo de autenticação de usuário/aplicativo.<br />
<br />
== Acoplamento ==<br />
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'''.<br />
<br />
== Parâmetros ==<br />
'''UrlEcommerce:'''<br />
<br><br />
<br />
URL de homologação -> https://openplatform.sandbox.test-stable.shopee.sg<br />
<br><br />
<br />
URL de produção -> https://openplatform.shopee.com.br<br />
<br />
'''UrlAutorizacao:'''<br />
<br><br />
<br />
URL de homologação -> https://partner.test-stable.shopeemobile.com<br />
<br><br />
<br />
URL de produção -> https://openplatform.shopee.com.br<br />
<br />
<br />
'''PartnerId:''' Partner ID (Identificador do aplicativo da Shopee);<br />
<br />
'''PartnerKey:''' Partner Key (Chave Secreta do aplicativo da Shopee);<br />
<br />
'''ShopId:''' ID da Loja Shopee (ShopID);<br />
<br />
'''NumeroListaPrecoProdutos:''' Lista de Preços para realizar o envio dos produtos para o web service;<br />
<br />
'''EmpresaReceptora:''' Empresa em que o pedido será integrado.<br />
<br />
'''QtdeEstoque:''' Quantidade de estoque fixa a ser enviada. Se for zero ou vazio, enviará o estoque atual individual de cada produto.<br />
<br />
'''CodigoStatusPedido:''' Código de status do pedido (do e-commerce) a ser considerado na busca de dados (Ex.: READY_TO_SHIP);<br />
<br />
'''SituacaoCodigo:''' Código da situação padrão para a gravação dos pedidos;<br />
<br />
'''PortadorCodigo:''' Código do portador padrão para a gravação dos pedidos;<br />
<br />
'''CondicaoPagto:''' Código da condicao de pagamento padrão para a gravação dos pedidos;<br />
<br />
'''TransportadoraCodigo:''' Código da transportadora padrão para a gravação dos pedidos;<br />
<br />
'''OpSaidaCodigo:''' Código da operação de saída padrão para a gravação dos pedidos;<br />
<br />
'''RepresentanteCodigo:''' Código do representante padrão para a gravação dos pedidos;<br />
<br />
'''TelevendasCodigo:''' Código do televendas padrão para a gravação dos pedidos;<br />
<br />
'''CaracteristicaCodigo:''' Código da característica de venda padrão para a gravação dos pedidos;<br />
<br />
'''DiasPrazoEntrega:''' Prazo de entrega padrão, a partir da emissão, para pedidos (quantidade de dias);<br />
<br />
'''TipoFrete:''' Tipo de frete;<br />
<br />
'''StatusCliente:''' Código do status de pessoa para clientes trazidos do e-commerce;<br />
<br />
'''RamoAtividadeCodigo:''' Código do ramo de atividade padrão para a gravação dos clientes;<br />
<br />
'''DefinirEnqFiscal:''' Define o enquadramento fiscal do cliente ao integrá-lo;<br />
<br />
'''EnqFiscalPessoaFisica:''' Código do enquadramento fiscal padrão para Pessoa Fisica ao integrar o cliente;<br />
<br />
'''EnqFiscalPessoaJuridica:''' Código do enquadramento fiscal padrão para Pessoa Jurídica ao integrar o cliente;<br />
<br />
'''FamiliasKit:''' Define quais famílias serão consideradas para kits na integração;<br />
<br />
'''CanaisVenda:''' Define quais serão os canais de venda dos produtos. Separar por vírgulas (Ex.: 91008, 91009);<br />
<br />
'''Classificacao:''' Classificação utilizada no adiantamento;<br />
<br />
'''Divisao:''' Divisão utilizada no adiantamento;<br />
<br />
'''CentroCusto:''' Centro de Custo utilizada no adiantamento;<br />
<br />
'''ContaBancaria:''' Conta utilizada no adiantamento;<br />
<br />
'''NomeImpressoraEtiquetas:''' Nome da impressora para impressão de etiquetas;<br />
<br />
'''ImpostoCodigoComissao:''' Código do imposto para comissão do marketplace.<br />
<br />
'''ImpostoCodigoFreteCusto:''' Código do imposto para custo de frete que o vendedor paga.<br />
<br />
== 1° Passo - Criar um Aplicativo ==<br />
<br />
Acessar Link:<br />
[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]<br />
<br />
Após acessar a conta, basta ir até o "Personal Center"<br />
[[Arquivo:Personal Center - Shopee Developer.png|Personal Center - Shopee Developer]]<br />
<br />
<br><br />
<br><br />
<br />
Depois basta ir em Cadastro -> Cadastro de Aplicativos: [https://open.shopee.com/console/app Shopee - Aplicativo]<br />
<br />
<br><br />
<br><br />
<br />
[[Arquivo:App - Shopee Developer.png|App - Shopee Developer]]<br />
<br />
Depois basta selecionar o aplicativo ou criar um novo:<br />
<br />
<br><br />
<br><br />
<br />
[[Arquivo:New App - Shopee Developer.png|New App - Shopee Developer]]<br />
<br />
<br><br />
<br><br />
Ao criar um novo aplicativo, a URL de Callback (Redirect URL Domain) será essa: <ref>https://google.com</ref>.<br />
<br />
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 />
<br><br />
<br><br />
<br />
[[Arquivo:Credenciais - Shopee Developer.png|Credenciais - Shopee Developer]]<br />
<br />
== 2° Passo - Criar uma loja ==<br />
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 />
<br><br />
<br><br />
<br />
[[Arquivo:Loja - Shopee Developer.png|Loja - Shopee Developer]]<br />
<br />
<br />
== 3° Passo - Configuração no ERP ==<br />
<br />
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.<br />
<br />
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:<br />
[[Arquivo:Credenciais (Code) Part.1 - Shopee Developer.png|Credenciais (Code) Part.1 - Shopee Developer]]<br />
<br />
[[Arquivo:Credenciais (Code) Part.2 - Shopee Developer.png|Credenciais (Code) Part.2 - Shopee Developer]]<br />
<br />
[[Arquivo:Credenciais (Code) Part.3 - Shopee Developer.png|Credenciais (Code) Part.3 - Shopee Developer]]<br />
<br />
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'''<br />
[[Arquivo:Credenciais (Code) Part.4 - Shopee Developer.png|Credenciais (Code) Part.4 - Shopee Developer]]<br />
<br />
Após gerar o token de acesso temporário, basta clicar em '''Gerar Token Acesso''':<br />
[[Arquivo:Credenciais (Code) Part.5 - Shopee Developer.png|Credenciais (Code) Part.5 - Shopee Developer]]<br />
<br />
<br><br />
<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>.<br />
<br />
== Requisitos ==<br />
<br />
'''Produtos:'''<br />
Atributo adicional: J:\Vb.Net\Scripts\Atributos Adicionais\Adiciona campos adicionais no cadastro de Produto - Shopee.sql; <br><br />
Marcar o produto para o aceite de integrações; <br><br />
Informar embalagem com as dimensões; <br><br />
E obrigatóriamente informar imagem(ns) no produto (ao menos uma) marcada como desenho.</div>Viniciushttps://wiki.dataplussistemas.com.br/index.php?title=RN_Integracao_Bling_V3&diff=16276RN Integracao Bling V32026-04-20T19:34:37Z<p>Vinicius: </p>
<hr />
<div>Regra de negócio do tipo habilitadora que pode ser acoplada ao [[DataPlus ERP]] e tem o objetivo configurar e manipular a integração entre API Bling na versão 3 e o DataPlusERP, podendo ser acessada pela tela de integração do sistema.<br />
<br />
== Acoplamento ==<br />
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'''.<br />
<br />
== Parâmetros ==<br />
'''UrlEcommerce:''' Url do e-commerce https://api.bling.com.br/Api/v3;<br />
<br />
'''IntegracaoMagalu:''' Possui integração com a Magalu (se marcada esta opção, é removido os pontos do código do produto);<br />
<br />
'''ClientId:''' Credencial ClientId do aplicativo;<br />
<br />
'''ClientSecret:''' Credencial ClientSecret do aplicativo;<br />
<br />
'''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><br />
Códigos verificados e possíveis para utilização: <br><br />
'''6''': em aberto<br><br />
'''9''': atendido<br><br />
'''12''': cancelado<br><br />
'''15''': em andamento<br><br />
'''18''': venda agenciada<br><br />
'''21''': em digitação<br><br />
'''24''': verificado <br />
<br />
<br />
'''SituacaoCodigo:''' Código da situação padrão para a gravação dos pedidos;<br />
<br />
'''PortadorCodigo:''' Código do portador padrão para a gravação dos pedidos;<br />
<br />
'''TransportadoraCodigo:''' Código da transportadora padrão para a gravação dos pedidos;<br />
<br />
'''OpSaidaCodigo:''' Código da operação de saída padrão para a gravação dos pedidos;<br />
<br />
'''RepresentanteCodigo:''' Código do representante padrão para a gravação dos pedidos;<br />
<br />
'''TelevendasCodigo:''' Código do televendas padrão para a gravação dos pedidos;<br />
<br />
'''CaracteristicaCodigo:''' Código da característica de venda padrão para a gravação dos pedidos;<br />
<br />
'''DiasPrazoEntrega:''' Prazo de entrega padrão, a partir da emissão, para pedidos (quantidade de dias);<br />
<br />
'''TipoFrete:''' Tipo de frete;<br />
<br />
'''StatusCliente:''' Código do status de pessoa para clientes trazidos do e-commerce;<br />
<br />
'''RamoAtividadeCodigo:''' Código do ramo de atividade padrão para a gravação dos clientes;<br />
<br />
'''DefinirEnqFiscal:''' Define o enquadramento fiscal do cliente ao integrá-lo;<br />
<br />
'''EnqFiscalPessoaFisica:''' Código do enquadramento fiscal padrão para Pessoa Fisica ao integrar o cliente;<br />
<br />
'''EnqFiscalPessoaJuridica:''' Código do enquadramento fiscal padrão para Pessoa Jurídica ao integrar o cliente;<br />
<br />
'''FamiliasKit:''' Define quais famílias serão consideradas para kits na integração;<br />
<br />
'''NumeroListaPrecoProdutos:''' Lista de Preços para realizar o envio dos produtos para o web service;<br />
<br />
'''IdsLojas:''' ID das lojas (separadas por ;), que são utilizadas em questão de preço de produto;<br />
<br />
'''PercentualLojas:''' Percentuais (separados por ;) a serem aplicados nos preços da lista de preços para cada loja (relacionado com IdsLojas);<br />
<br />
'''QtdeEstoque:''' Quantidade de estoque fixa a ser enviada. Se for zero ou vazio, enviará o estoque atual individual de cada produto.<br />
<br />
'''EmpresaReceptora:''' Empresa em que o pedido será integrado.<br />
<br />
'''DepositoId:''' Id do deposito para lançamento de estoque. Se 0 coleta o deposito padrão.<br />
<br />
'''ImpostoCodigoComissao:''' Código do imposto para comissão do marketplace.<br />
<br />
'''ImpostoCodigoFreteCusto:''' Código do imposto para custo de frete que o vendedor paga.<br />
<br />
<br />
Para a versão 3 da API da Bling, foi incluído um novo processo de autenticação de usuário/aplicativo.<br />
<br />
== 1° Passo - Acessar Aplicativos ==<br />
<br />
Acessar Link:<br />
<ref>https://www.bling.com.br/login</ref><br />
<br />
Após acessar a conta, basta ir no Ícone de configurações -> Todas as configurações:<br />
[[Arquivo:Configurações Bling - Preferências.png|centro]]<br />
<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<br />
[[Arquivo:Configurações Bling - Cadastro de Aplicativos.png|centro]]<br />
<br />
Depois basta selecionar o aplicativo ou criar um novo:<br />
[[Arquivo:Configurações Bling - Aplicativos.png|centro]]<br />
<br />
Para criar um novo basta seguir as seguintes instruções: <ref>https://developer.bling.com.br/homologacao#inscri%C3%A7%C3%A3o</ref><br />
<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.<br />
<br />
Após a criação do aplicativo, você poderá obter as credenciais de acesso a API, como o ClientId e o ClientSecret:<br />
[[Arquivo:Configurações Bling - Credenciais de Acesso.png|centro]]<br />
<br />
== 2° Passo - Configuração no ERP ==<br />
<br />
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:<br />
[[Arquivo:Info configuração e-commerce ERP.png|centro]]<br />
<br />
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:<br />
[[Arquivo:Autorização Aplicativo E-commerce Bling - scopos.png|centro]]<br />
<br />
Basta selecionar autorizar logo abaixo:<br />
[[Arquivo:Autorização Aplicativo E-commerce Bling - Autorizar.png|centro]]<br />
<br />
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:<br />
[[Arquivo:Retorno webservice ecommerce.png|centro]]<br />
<br />
'''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.'''<br />
<br />
Após gerar o token de acesso temporário, basta clicar em '''Gerar Token Acesso''':<br />
[[Arquivo:Mensagem sucesso configuração ecommerce.png|centro]]<br />
<br />
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>.'''</div>Viniciushttps://wiki.dataplussistemas.com.br/index.php?title=Arquivo:Mercado_Livre_-_URL_de_callback.png&diff=16230Arquivo:Mercado Livre - URL de callback.png2026-04-08T12:54:51Z<p>Vinicius: </p>
<hr />
<div>Mercado Livre - URL de callback</div>Viniciushttps://wiki.dataplussistemas.com.br/index.php?title=Arquivo:Mercado_Livre_-_N%C3%A3o_foi_poss%C3%ADvel_conectar_o_aplicativo.png&diff=16229Arquivo:Mercado Livre - Não foi possível conectar o aplicativo.png2026-04-08T12:52:09Z<p>Vinicius: </p>
<hr />
<div>Mercado Livre - Não foi possível conectar o aplicativo</div>Viniciushttps://wiki.dataplussistemas.com.br/index.php?title=RN_Integracao_Shopee_v2&diff=16217RN Integracao Shopee v22026-04-07T11:36:08Z<p>Vinicius: </p>
<hr />
<div>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.<br />
<br />
Para a versão 2 da API da Shopee, foi incluído um novo processo de autenticação de usuário/aplicativo.<br />
<br />
== Acoplamento ==<br />
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'''.<br />
<br />
== Parâmetros ==<br />
'''UrlEcommerce:'''<br />
<br><br />
<br />
URL de homologação -> https://openplatform.sandbox.test-stable.shopee.sg<br />
<br><br />
<br />
URL de produção -> https://openplatform.shopee.com.br<br />
<br />
'''UrlAutorizacao:'''<br />
<br><br />
<br />
URL de homologação -> https://partner.test-stable.shopeemobile.com<br />
<br><br />
<br />
URL de produção -> https://openplatform.shopee.com.br<br />
<br />
<br />
'''PartnerId:''' Partner ID (Identificador do aplicativo da Shopee);<br />
<br />
'''PartnerKey:''' Partner Key (Chave Secreta do aplicativo da Shopee);<br />
<br />
'''ShopId:''' ID da Loja Shopee (ShopID);<br />
<br />
'''NumeroListaPrecoProdutos:''' Lista de Preços para realizar o envio dos produtos para o web service;<br />
<br />
'''EmpresaReceptora:''' Empresa em que o pedido será integrado.<br />
<br />
'''QtdeEstoque:''' Quantidade de estoque fixa a ser enviada. Se for zero ou vazio, enviará o estoque atual individual de cada produto.<br />
<br />
'''CodigoStatusPedido:''' Código de status do pedido (do e-commerce) a ser considerado na busca de dados (Ex.: READY_TO_SHIP);<br />
<br />
'''SituacaoCodigo:''' Código da situação padrão para a gravação dos pedidos;<br />
<br />
'''PortadorCodigo:''' Código do portador padrão para a gravação dos pedidos;<br />
<br />
'''CondicaoPagto:''' Código da condicao de pagamento padrão para a gravação dos pedidos;<br />
<br />
'''TransportadoraCodigo:''' Código da transportadora padrão para a gravação dos pedidos;<br />
<br />
'''OpSaidaCodigo:''' Código da operação de saída padrão para a gravação dos pedidos;<br />
<br />
'''RepresentanteCodigo:''' Código do representante padrão para a gravação dos pedidos;<br />
<br />
'''TelevendasCodigo:''' Código do televendas padrão para a gravação dos pedidos;<br />
<br />
'''CaracteristicaCodigo:''' Código da característica de venda padrão para a gravação dos pedidos;<br />
<br />
'''DiasPrazoEntrega:''' Prazo de entrega padrão, a partir da emissão, para pedidos (quantidade de dias);<br />
<br />
'''TipoFrete:''' Tipo de frete;<br />
<br />
'''StatusCliente:''' Código do status de pessoa para clientes trazidos do e-commerce;<br />
<br />
'''RamoAtividadeCodigo:''' Código do ramo de atividade padrão para a gravação dos clientes;<br />
<br />
'''DefinirEnqFiscal:''' Define o enquadramento fiscal do cliente ao integrá-lo;<br />
<br />
'''EnqFiscalPessoaFisica:''' Código do enquadramento fiscal padrão para Pessoa Fisica ao integrar o cliente;<br />
<br />
'''EnqFiscalPessoaJuridica:''' Código do enquadramento fiscal padrão para Pessoa Jurídica ao integrar o cliente;<br />
<br />
'''FamiliasKit:''' Define quais famílias serão consideradas para kits na integração;<br />
<br />
'''CanaisVenda:''' Define quais serão os canais de venda dos produtos. Separar por vírgulas (Ex.: 91008, 91009);<br />
<br />
'''Classificacao:''' Classificação utilizada no adiantamento;<br />
<br />
'''Divisao:''' Divisão utilizada no adiantamento;<br />
<br />
'''CentroCusto:''' Centro de Custo utilizada no adiantamento;<br />
<br />
'''ContaBancaria:''' Conta utilizada no adiantamento;<br />
<br />
'''NomeImpressoraEtiquetas:''' Nome da impressora para impressão de etiquetas;<br />
<br />
== 1° Passo - Criar um Aplicativo ==<br />
<br />
Acessar Link:<br />
[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]<br />
<br />
Após acessar a conta, basta ir até o "Personal Center"<br />
[[Arquivo:Personal Center - Shopee Developer.png|Personal Center - Shopee Developer]]<br />
<br />
<br><br />
<br><br />
<br />
Depois basta ir em Cadastro -> Cadastro de Aplicativos: [https://open.shopee.com/console/app Shopee - Aplicativo]<br />
<br />
<br><br />
<br><br />
<br />
[[Arquivo:App - Shopee Developer.png|App - Shopee Developer]]<br />
<br />
Depois basta selecionar o aplicativo ou criar um novo:<br />
<br />
<br><br />
<br><br />
<br />
[[Arquivo:New App - Shopee Developer.png|New App - Shopee Developer]]<br />
<br />
<br><br />
<br><br />
Ao criar um novo aplicativo, a URL de Callback (Redirect URL Domain) será essa: <ref>https://google.com</ref>.<br />
<br />
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 />
<br><br />
<br><br />
<br />
[[Arquivo:Credenciais - Shopee Developer.png|Credenciais - Shopee Developer]]<br />
<br />
== 2° Passo - Criar uma loja ==<br />
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 />
<br><br />
<br><br />
<br />
[[Arquivo:Loja - Shopee Developer.png|Loja - Shopee Developer]]<br />
<br />
<br />
== 3° Passo - Configuração no ERP ==<br />
<br />
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.<br />
<br />
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:<br />
[[Arquivo:Credenciais (Code) Part.1 - Shopee Developer.png|Credenciais (Code) Part.1 - Shopee Developer]]<br />
<br />
[[Arquivo:Credenciais (Code) Part.2 - Shopee Developer.png|Credenciais (Code) Part.2 - Shopee Developer]]<br />
<br />
[[Arquivo:Credenciais (Code) Part.3 - Shopee Developer.png|Credenciais (Code) Part.3 - Shopee Developer]]<br />
<br />
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'''<br />
[[Arquivo:Credenciais (Code) Part.4 - Shopee Developer.png|Credenciais (Code) Part.4 - Shopee Developer]]<br />
<br />
Após gerar o token de acesso temporário, basta clicar em '''Gerar Token Acesso''':<br />
[[Arquivo:Credenciais (Code) Part.5 - Shopee Developer.png|Credenciais (Code) Part.5 - Shopee Developer]]<br />
<br />
<br><br />
<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>.<br />
<br />
== Requisitos ==<br />
<br />
'''Produtos:'''<br />
Atributo adicional: J:\Vb.Net\Scripts\Atributos Adicionais\Adiciona campos adicionais no cadastro de Produto - Shopee.sql; <br><br />
Marcar o produto para o aceite de integrações; <br><br />
Informar embalagem com as dimensões; <br><br />
E obrigatóriamente informar imagem(ns) no produto (ao menos uma) marcada como desenho.</div>Viniciushttps://wiki.dataplussistemas.com.br/index.php?title=RN_Integracao_Magis5&diff=16216RN Integracao Magis52026-04-07T11:34:21Z<p>Vinicius: </p>
<hr />
<div>Regra de negócio do tipo habilitadora que pode ser acoplada ao [[DataPlus ERP]] e tem o objetivo configurar e manipular a integração entre API Magis5 e o DataPlusERP, podendo ser acessada pela tela de integração do sistema.<br />
<br />
== Acoplamento ==<br />
Essa regra de negócio só poder acoplada à entidade Comum.IntegracaoDadosExternos ou Infra.ControleAvisos(). Ela está preparada para funcionar com o elemento '''ExecutaOperacao''', sendo seu designador por '''Execução''' e tempo de execução '''Depois'''.<br />
<br />
Essa regra de negócio foi adaptada para também funcionar no dpServer.<br />
Quando executada pelo dpServer, seu comportamento é restrito à consulta e integração de pedidos, não abrangendo outras operações disponíveis.<br />
<br />
Além disso, algumas propriedades são exclusivas do dpServer e devem ser configuradas apenas quando a execução ocorrer nesse ambiente, como PeriodoExecucao, GerarLog e UsuariosParaNotificacao.<br />
Esses parâmetros controlam o agendamento, e notificações das execuções automáticas realizadas.<br />
<br />
== Parâmetros ==<br />
'''UrlEcommerce:''' Url do e-commerce;<br />
<br />
'''StatusPedido:''' Status do pedido (do e-commerce) a ser considerado na busca de dados: '''ready_to_print''' é o status que a Magis garante que está pronto para ser criado o pedido no ERP e faturado<br><br />
<br />
'''Token:''' Token recebido pela Magis após contratar o serviço de API (Sem esse token a integração não funciona).<br />
<br />
'''StatusCliente:''' Código do status de pessoa para clientes trazidos do e-commerce;<br />
<br />
'''RamoAtividadeCodigo:''' Código do ramo de atividade padrão para a gravação dos clientes;<br />
<br />
'''DefinirEnqFiscal:''' Define o enquadramento fiscal do cliente ao integrá-lo;<br />
<br />
'''EnqFiscalPessoaFisica:''' Código do enquadramento fiscal padrão para Pessoa Fisica ao integrar o cliente;<br />
<br />
'''EnqFiscalPessoaJuridica:''' Código do enquadramento fiscal padrão para Pessoa Jurídica ao integrar o cliente;<br />
<br />
'''EmpresaReceptora:''' Empresa em que a regra será executada.;<br />
<br />
'''DiasPrazoEntrega:''' Prazo de entrega padrão, a partir da emissão, para pedidos (quantidade de dias);<br />
<br />
'''SituacaoCodigo:''' Código da situação padrão para a gravação dos pedidos;<br />
<br />
'''PortadorCodigo:''' Código do portador padrão para a gravação dos pedidos;<br />
<br />
'''TransportadoraCodigo:''' Código da transportadora padrão para a gravação dos pedidos;<br />
<br />
'''OpSaidaCodigo:''' Código da operação de saída padrão para a gravação dos pedidos;<br />
<br />
'''RepresentanteCodigo:''' Código do representante padrão para a gravação dos pedidos;<br />
<br />
'''TelevendasCodigo:''' Código do televendas padrão para a gravação dos pedidos;<br />
<br />
'''CaracteristicaCodigo:''' Código da característica de venda padrão para a gravação dos pedidos;<br />
<br />
'''TipoFrete:''' Tipo de frete;<br />
<br />
'''DescontoPessoaFisica:''' Desconto para cliente pessoa física.<br />
<br />
'''CanalConfigurado:''' Informe o nome dos canais separados por vírgula. Exemplo: Shopee, Mercado Livre, Magazine Luiza. Cada nome de canal está associado à configuração de parcela única.<br />
<br />
'''ValorCanalConfigurado:''' Informe U para parcela única ou N para não parcela única, separados por vírgula e mantendo a sequência da propriedade CanalPagaParcelaUnica. Exemplo: U, N, U.<br />
<br />
'''IdsLojas:''' ID das lojas (separadas por ponto e vírgula), que são utilizadas para coleta de pedidos.<br />
<br />
<br />
'''Propriedades exclusivas para o dpServer:'''<br />
<br />
'''PeriodoExecucao:''' Período que a regra será executada. Informar em minutos ex.: 60 (dpServer).<br />
<br />
'''GerarLog:''' Gera uma log dos pedidos retornados com o mesmo nome da regra (dpServer).<br />
<br />
'''UsuariosParaNotificacao:''' Código dos usuários que receberão a notificação (Separar por vírgula Ex: 1,2,3) (dpServer)<br />
<br />
== OBSERVAÇÃO IMPORTANTE== <br />
É necessário cadastrar todas as formas de parcelamento possíveis que podem ser recebidas de cada marketplace. Para que o sistema identifique que essa condição de pagamento está vinculada à integração da Magis, a descrição deve conter o nome "magis", seguido de um traço e a quantidade de parcelas correspondentes. '''Por exemplo: magis-1x, magis-2x, magis-3x. '''Certifique-se de cadastrar todas as opções necessárias para garantir o correto funcionamento da integração.<br />
Caso não for configurado o '''CanalConfigurado''' e '''ValorCanalConfigurado''' ele vai pegar por padrao a configuração '''magis-1x'''.</div>Viniciushttps://wiki.dataplussistemas.com.br/index.php?title=RN_Integracao_Bling_V3&diff=16215RN Integracao Bling V32026-04-07T11:33:21Z<p>Vinicius: </p>
<hr />
<div>Regra de negócio do tipo habilitadora que pode ser acoplada ao [[DataPlus ERP]] e tem o objetivo configurar e manipular a integração entre API Bling na versão 3 e o DataPlusERP, podendo ser acessada pela tela de integração do sistema.<br />
<br />
== Acoplamento ==<br />
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'''.<br />
<br />
== Parâmetros ==<br />
'''UrlEcommerce:''' Url do e-commerce https://api.bling.com.br/Api/v3;<br />
<br />
'''ClientId:''' Credencial ClientId do aplicativo;<br />
<br />
'''ClientSecret:''' Credencial ClientSecret do aplicativo;<br />
<br />
'''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><br />
Códigos verificados e possíveis para utilização: <br><br />
'''6''': em aberto<br><br />
'''9''': atendido<br><br />
'''12''': cancelado<br><br />
'''15''': em andamento<br><br />
'''18''': venda agenciada<br><br />
'''21''': em digitação<br><br />
'''24''': verificado <br />
<br />
<br />
'''SituacaoCodigo:''' Código da situação padrão para a gravação dos pedidos;<br />
<br />
'''PortadorCodigo:''' Código do portador padrão para a gravação dos pedidos;<br />
<br />
'''TransportadoraCodigo:''' Código da transportadora padrão para a gravação dos pedidos;<br />
<br />
'''OpSaidaCodigo:''' Código da operação de saída padrão para a gravação dos pedidos;<br />
<br />
'''RepresentanteCodigo:''' Código do representante padrão para a gravação dos pedidos;<br />
<br />
'''TelevendasCodigo:''' Código do televendas padrão para a gravação dos pedidos;<br />
<br />
'''CaracteristicaCodigo:''' Código da característica de venda padrão para a gravação dos pedidos;<br />
<br />
'''DiasPrazoEntrega:''' Prazo de entrega padrão, a partir da emissão, para pedidos (quantidade de dias);<br />
<br />
'''TipoFrete:''' Tipo de frete;<br />
<br />
'''StatusCliente:''' Código do status de pessoa para clientes trazidos do e-commerce;<br />
<br />
'''RamoAtividadeCodigo:''' Código do ramo de atividade padrão para a gravação dos clientes;<br />
<br />
'''DefinirEnqFiscal:''' Define o enquadramento fiscal do cliente ao integrá-lo;<br />
<br />
'''EnqFiscalPessoaFisica:''' Código do enquadramento fiscal padrão para Pessoa Fisica ao integrar o cliente;<br />
<br />
'''EnqFiscalPessoaJuridica:''' Código do enquadramento fiscal padrão para Pessoa Jurídica ao integrar o cliente;<br />
<br />
'''FamiliasKit:''' Define quais famílias serão consideradas para kits na integração;<br />
<br />
'''NumeroListaPrecoProdutos:''' Lista de Preços para realizar o envio dos produtos para o web service;<br />
<br />
'''IdsLojas:''' ID das lojas (separadas por ;), que são utilizadas em questão de preço de produto;<br />
<br />
'''PercentualLojas:''' Percentuais (separados por ;) a serem aplicados nos preços da lista de preços para cada loja (relacionado com IdsLojas);<br />
<br />
'''QtdeEstoque:''' Quantidade de estoque fixa a ser enviada. Se for zero ou vazio, enviará o estoque atual individual de cada produto.<br />
<br />
'''EmpresaReceptora:''' Empresa em que o pedido será integrado.<br />
<br />
'''DepositoId:''' Id do deposito para lançamento de estoque. Se 0 coleta o deposito padrão.<br />
<br />
<br />
Para a versão 3 da API da Bling, foi incluído um novo processo de autenticação de usuário/aplicativo.<br />
<br />
== 1° Passo - Acessar Aplicativos ==<br />
<br />
Acessar Link:<br />
<ref>https://www.bling.com.br/login</ref><br />
<br />
Após acessar a conta, basta ir no Ícone de configurações -> Todas as configurações:<br />
[[Arquivo:Configurações Bling - Preferências.png|centro]]<br />
<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<br />
[[Arquivo:Configurações Bling - Cadastro de Aplicativos.png|centro]]<br />
<br />
Depois basta selecionar o aplicativo ou criar um novo:<br />
[[Arquivo:Configurações Bling - Aplicativos.png|centro]]<br />
<br />
Para criar um novo basta seguir as seguintes instruções: <ref>https://developer.bling.com.br/homologacao#inscri%C3%A7%C3%A3o</ref><br />
<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.<br />
<br />
Após a criação do aplicativo, você poderá obter as credenciais de acesso a API, como o ClientId e o ClientSecret:<br />
[[Arquivo:Configurações Bling - Credenciais de Acesso.png|centro]]<br />
<br />
== 2° Passo - Configuração no ERP ==<br />
<br />
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:<br />
[[Arquivo:Info configuração e-commerce ERP.png|centro]]<br />
<br />
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:<br />
[[Arquivo:Autorização Aplicativo E-commerce Bling - scopos.png|centro]]<br />
<br />
Basta selecionar autorizar logo abaixo:<br />
[[Arquivo:Autorização Aplicativo E-commerce Bling - Autorizar.png|centro]]<br />
<br />
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:<br />
[[Arquivo:Retorno webservice ecommerce.png|centro]]<br />
<br />
'''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.'''<br />
<br />
Após gerar o token de acesso temporário, basta clicar em '''Gerar Token Acesso''':<br />
[[Arquivo:Mensagem sucesso configuração ecommerce.png|centro]]<br />
<br />
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>.'''</div>Viniciushttps://wiki.dataplussistemas.com.br/index.php?title=RN_Integracao_ReenvioInformacoes&diff=16214RN Integracao ReenvioInformacoes2026-04-07T11:29:45Z<p>Vinicius: </p>
<hr />
<div>Regra de negócio do tipo Habilitadora que pode ser acoplada ao [[DataPlus ERP]] e tem por objetivo habilitar recursos no formulário de [[Nota Fiscal]] e [[Ordem de Carregamento]] para reenvio de informações para integrações externas.<br />
<br />
== Acoplamento ==<br />
Essa regra de negócio por hora só pode ser acoplada ao formulário de [[Nota Fiscal]] (frmMovNotaFiscal) e [[Ordem de Carregamento]] (FrmMovOrdemCarregamento), podendo ser expandida para outros formulários futuramente. Ela esta preparada para funcionar em conjunto com o método '''OnLoad''' e no tempo de execução '''Depois'''.<br />
<br />
No formulário de nota fiscal, o botão criado na toolstrip realizará o envio do XML para o e-commerce. Já no formulário de ordem de carregamento, será feita a coleta das etiquetas dos pedidos; esta coleta ocorrerá apenas para os pedidos que já foram faturados.</div>Viniciushttps://wiki.dataplussistemas.com.br/index.php?title=RN_Integracao_Shopee_v2&diff=16126RN Integracao Shopee v22026-03-20T18:50:42Z<p>Vinicius: </p>
<hr />
<div>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.<br />
<br />
Para a versão 2 da API da Shopee, foi incluído um novo processo de autenticação de usuário/aplicativo.<br />
<br />
== Acoplamento ==<br />
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'''.<br />
<br />
== Parâmetros ==<br />
'''UrlEcommerce:'''<br />
<br><br />
<br />
URL de homologação -> https://openplatform.sandbox.test-stable.shopee.sg<br />
<br><br />
<br />
URL de produção -> https://openplatform.shopee.com.br<br />
<br />
'''UrlAutorizacao:'''<br />
<br><br />
<br />
URL de homologação -> https://partner.test-stable.shopeemobile.com<br />
<br><br />
<br />
URL de produção -> https://openplatform.shopee.com.br<br />
<br />
<br />
'''PartnerId:''' Partner ID (Identificador do aplicativo da Shopee);<br />
<br />
'''PartnerKey:''' Partner Key (Chave Secreta do aplicativo da Shopee);<br />
<br />
'''ShopId:''' ID da Loja Shopee (ShopID);<br />
<br />
'''NumeroListaPrecoProdutos:''' Lista de Preços para realizar o envio dos produtos para o web service;<br />
<br />
'''EmpresaReceptora:''' Empresa em que o pedido será integrado.<br />
<br />
'''QtdeEstoque:''' Quantidade de estoque fixa a ser enviada. Se for zero ou vazio, enviará o estoque atual individual de cada produto.<br />
<br />
'''CodigoStatusPedido:''' Código de status do pedido (do e-commerce) a ser considerado na busca de dados (Ex.: READY_TO_SHIP);<br />
<br />
'''SituacaoCodigo:''' Código da situação padrão para a gravação dos pedidos;<br />
<br />
'''PortadorCodigo:''' Código do portador padrão para a gravação dos pedidos;<br />
<br />
'''CondicaoPagto:''' Código da condicao de pagamento padrão para a gravação dos pedidos;<br />
<br />
'''TransportadoraCodigo:''' Código da transportadora padrão para a gravação dos pedidos;<br />
<br />
'''OpSaidaCodigo:''' Código da operação de saída padrão para a gravação dos pedidos;<br />
<br />
'''RepresentanteCodigo:''' Código do representante padrão para a gravação dos pedidos;<br />
<br />
'''TelevendasCodigo:''' Código do televendas padrão para a gravação dos pedidos;<br />
<br />
'''CaracteristicaCodigo:''' Código da característica de venda padrão para a gravação dos pedidos;<br />
<br />
'''DiasPrazoEntrega:''' Prazo de entrega padrão, a partir da emissão, para pedidos (quantidade de dias);<br />
<br />
'''TipoFrete:''' Tipo de frete;<br />
<br />
'''StatusCliente:''' Código do status de pessoa para clientes trazidos do e-commerce;<br />
<br />
'''RamoAtividadeCodigo:''' Código do ramo de atividade padrão para a gravação dos clientes;<br />
<br />
'''DefinirEnqFiscal:''' Define o enquadramento fiscal do cliente ao integrá-lo;<br />
<br />
'''FamiliasKit:''' Define quais famílias serão consideradas para kits na integração;<br />
<br />
'''CanaisVenda:''' Define quais serão os canais de venda dos produtos. Separar por vírgulas (Ex.: 91008, 91009);<br />
<br />
'''Classificacao:''' Classificação utilizada no adiantamento;<br />
<br />
'''Divisao:''' Divisão utilizada no adiantamento;<br />
<br />
'''CentroCusto:''' Centro de Custo utilizada no adiantamento;<br />
<br />
'''ContaBancaria:''' Conta utilizada no adiantamento;<br />
<br />
== 1° Passo - Criar um Aplicativo ==<br />
<br />
Acessar Link:<br />
[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]<br />
<br />
Após acessar a conta, basta ir até o "Personal Center"<br />
[[Arquivo:Personal Center - Shopee Developer.png|Personal Center - Shopee Developer]]<br />
<br />
<br><br />
<br><br />
<br />
Depois basta ir em Cadastro -> Cadastro de Aplicativos: [https://open.shopee.com/console/app Shopee - Aplicativo]<br />
<br />
<br><br />
<br><br />
<br />
[[Arquivo:App - Shopee Developer.png|App - Shopee Developer]]<br />
<br />
Depois basta selecionar o aplicativo ou criar um novo:<br />
<br />
<br><br />
<br><br />
<br />
[[Arquivo:New App - Shopee Developer.png|New App - Shopee Developer]]<br />
<br />
<br><br />
<br><br />
Ao criar um novo aplicativo, a URL de Callback (Redirect URL Domain) será essa: <ref>https://google.com</ref>.<br />
<br />
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 />
<br><br />
<br><br />
<br />
[[Arquivo:Credenciais - Shopee Developer.png|Credenciais - Shopee Developer]]<br />
<br />
== 2° Passo - Criar uma loja ==<br />
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 />
<br><br />
<br><br />
<br />
[[Arquivo:Loja - Shopee Developer.png|Loja - Shopee Developer]]<br />
<br />
<br />
== 3° Passo - Configuração no ERP ==<br />
<br />
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.<br />
<br />
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:<br />
[[Arquivo:Credenciais (Code) Part.1 - Shopee Developer.png|Credenciais (Code) Part.1 - Shopee Developer]]<br />
<br />
[[Arquivo:Credenciais (Code) Part.2 - Shopee Developer.png|Credenciais (Code) Part.2 - Shopee Developer]]<br />
<br />
[[Arquivo:Credenciais (Code) Part.3 - Shopee Developer.png|Credenciais (Code) Part.3 - Shopee Developer]]<br />
<br />
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'''<br />
[[Arquivo:Credenciais (Code) Part.4 - Shopee Developer.png|Credenciais (Code) Part.4 - Shopee Developer]]<br />
<br />
Após gerar o token de acesso temporário, basta clicar em '''Gerar Token Acesso''':<br />
[[Arquivo:Credenciais (Code) Part.5 - Shopee Developer.png|Credenciais (Code) Part.5 - Shopee Developer]]<br />
<br />
<br><br />
<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>.<br />
<br />
== Requisitos ==<br />
<br />
'''Produtos:'''<br />
Atributo adicional: J:\Vb.Net\Scripts\Atributos Adicionais\Adiciona campos adicionais no cadastro de Produto - Shopee.sql; <br><br />
Marcar o produto para o aceite de integrações; <br><br />
Informar embalagem com as dimensões; <br><br />
E obrigatóriamente informar imagem(ns) no produto (ao menos uma) marcada como desenho.</div>Viniciushttps://wiki.dataplussistemas.com.br/index.php?title=RN_Integracao_Shopee_v2&diff=15829RN Integracao Shopee v22026-03-12T13:32:34Z<p>Vinicius: </p>
<hr />
<div>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.<br />
<br />
Para a versão 2 da API da Shopee, foi incluído um novo processo de autenticação de usuário/aplicativo.<br />
<br />
== Acoplamento ==<br />
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'''.<br />
<br />
== Parâmetros ==<br />
'''UrlEcommerce:'''<br />
<br><br />
<br />
URL de homologação -> https://openplatform.sandbox.test-stable.shopee.sg<br />
<br><br />
<br />
URL de produção -> https://openplatform.shopee.com.br<br />
<br />
'''UrlAutorizacao:'''<br />
<br><br />
<br />
URL de homologação -> https://partner.test-stable.shopeemobile.com<br />
<br><br />
<br />
URL de produção -> https://openplatform.shopee.com.br<br />
<br />
<br />
'''PartnerId:''' Partner ID (Identificador do aplicativo da Shopee);<br />
<br />
'''PartnerKey:''' Partner Key (Chave Secreta do aplicativo da Shopee);<br />
<br />
'''ShopId:''' ID da Loja Shopee (ShopID);<br />
<br />
'''NumeroListaPrecoProdutos:''' Lista de Preços para realizar o envio dos produtos para o web service;<br />
<br />
'''EmpresaReceptora:''' Empresa em que o pedido será integrado.<br />
<br />
'''QtdeEstoque:''' Quantidade de estoque fixa a ser enviada. Se for zero ou vazio, enviará o estoque atual individual de cada produto.<br />
<br />
'''CodigoStatusPedido:''' Código de status do pedido (do e-commerce) a ser considerado na busca de dados (Ex.: READY_TO_SHIP);<br />
<br />
'''SituacaoCodigo:''' Código da situação padrão para a gravação dos pedidos;<br />
<br />
'''PortadorCodigo:''' Código do portador padrão para a gravação dos pedidos;<br />
<br />
'''TransportadoraCodigo:''' Código da transportadora padrão para a gravação dos pedidos;<br />
<br />
'''OpSaidaCodigo:''' Código da operação de saída padrão para a gravação dos pedidos;<br />
<br />
'''RepresentanteCodigo:''' Código do representante padrão para a gravação dos pedidos;<br />
<br />
'''TelevendasCodigo:''' Código do televendas padrão para a gravação dos pedidos;<br />
<br />
'''CaracteristicaCodigo:''' Código da característica de venda padrão para a gravação dos pedidos;<br />
<br />
'''DiasPrazoEntrega:''' Prazo de entrega padrão, a partir da emissão, para pedidos (quantidade de dias);<br />
<br />
'''TipoFrete:''' Tipo de frete;<br />
<br />
'''StatusCliente:''' Código do status de pessoa para clientes trazidos do e-commerce;<br />
<br />
'''RamoAtividadeCodigo:''' Código do ramo de atividade padrão para a gravação dos clientes;<br />
<br />
'''DefinirEnqFiscal:''' Define o enquadramento fiscal do cliente ao integrá-lo;<br />
<br />
'''FamiliasKit:''' Define quais famílias serão consideradas para kits na integração;<br />
<br />
'''CanaisVenda:''' Define quais serão os canais de venda dos produtos. Separar por vírgulas (Ex.: 91008, 91009);<br />
<br />
'''Classificacao:''' Classificação utilizada no adiantamento;<br />
<br />
'''Divisao:''' Divisão utilizada no adiantamento;<br />
<br />
'''CentroCusto:''' Centro de Custo utilizada no adiantamento;<br />
<br />
'''ContaBancaria:''' Conta utilizada no adiantamento;<br />
<br />
== 1° Passo - Criar um Aplicativo ==<br />
<br />
Acessar Link:<br />
[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]<br />
<br />
Após acessar a conta, basta ir até o "Personal Center"<br />
[[Arquivo:Personal Center - Shopee Developer.png|Personal Center - Shopee Developer]]<br />
<br />
<br><br />
<br><br />
<br />
Depois basta ir em Cadastro -> Cadastro de Aplicativos: [https://open.shopee.com/console/app Shopee - Aplicativo]<br />
<br />
<br><br />
<br><br />
<br />
[[Arquivo:App - Shopee Developer.png|App - Shopee Developer]]<br />
<br />
Depois basta selecionar o aplicativo ou criar um novo:<br />
<br />
<br><br />
<br><br />
<br />
[[Arquivo:New App - Shopee Developer.png|New App - Shopee Developer]]<br />
<br />
<br><br />
<br><br />
Ao criar um novo aplicativo, a URL de Callback (Redirect URL Domain) será essa: <ref>https://google.com</ref>.<br />
<br />
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 />
<br><br />
<br><br />
<br />
[[Arquivo:Credenciais - Shopee Developer.png|Credenciais - Shopee Developer]]<br />
<br />
== 2° Passo - Criar uma loja ==<br />
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 />
<br><br />
<br><br />
<br />
[[Arquivo:Loja - Shopee Developer.png|Loja - Shopee Developer]]<br />
<br />
<br />
== 3° Passo - Configuração no ERP ==<br />
<br />
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.<br />
<br />
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:<br />
[[Arquivo:Credenciais (Code) Part.1 - Shopee Developer.png|Credenciais (Code) Part.1 - Shopee Developer]]<br />
<br />
[[Arquivo:Credenciais (Code) Part.2 - Shopee Developer.png|Credenciais (Code) Part.2 - Shopee Developer]]<br />
<br />
[[Arquivo:Credenciais (Code) Part.3 - Shopee Developer.png|Credenciais (Code) Part.3 - Shopee Developer]]<br />
<br />
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'''<br />
[[Arquivo:Credenciais (Code) Part.4 - Shopee Developer.png|Credenciais (Code) Part.4 - Shopee Developer]]<br />
<br />
Após gerar o token de acesso temporário, basta clicar em '''Gerar Token Acesso''':<br />
[[Arquivo:Credenciais (Code) Part.5 - Shopee Developer.png|Credenciais (Code) Part.5 - Shopee Developer]]<br />
<br />
<br><br />
<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>.<br />
<br />
== Requisitos ==<br />
<br />
'''Produtos:'''<br />
Atributo adicional: J:\Vb.Net\Scripts\Atributos Adicionais\Adiciona campos adicionais no cadastro de Produto - Shopee.sql; <br><br />
Marcar o produto para o aceite de integrações; <br><br />
Informar embalagem com as dimensões; <br><br />
E obrigatóriamente informar imagem(ns) no produto (ao menos uma) marcada como desenho.</div>Viniciushttps://wiki.dataplussistemas.com.br/index.php?title=RN_Integracao_Shopee_v2&diff=15765RN Integracao Shopee v22026-03-03T14:47:00Z<p>Vinicius: </p>
<hr />
<div>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.<br />
<br />
Para a versão 2 da API da Shopee, foi incluído um novo processo de autenticação de usuário/aplicativo.<br />
<br />
== Acoplamento ==<br />
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'''.<br />
<br />
== Parâmetros ==<br />
'''UrlEcommerce:'''<br />
<br><br />
<br />
URL de homologação -> https://openplatform.sandbox.test-stable.shopee.sg<br />
<br><br />
<br />
URL de produção -> https://openplatform.shopee.com.br<br />
<br />
'''UrlAutorizacao:'''<br />
<br><br />
<br />
URL de homologação -> https://partner.test-stable.shopeemobile.com<br />
<br><br />
<br />
URL de produção -> https://openplatform.shopee.com.br<br />
<br />
<br />
'''PartnerId:''' Partner ID (Identificador do aplicativo da Shopee);<br />
<br />
'''PartnerKey:''' Partner Key (Chave Secreta do aplicativo da Shopee);<br />
<br />
'''ShopId:''' ID da Loja Shopee (ShopID);<br />
<br />
'''NumeroListaPrecoProdutos:''' Lista de Preços para realizar o envio dos produtos para o web service;<br />
<br />
'''EmpresaReceptora:''' Empresa em que o pedido será integrado.<br />
<br />
'''QtdeEstoque:''' Quantidade de estoque fixa a ser enviada. Se for zero ou vazio, enviará o estoque atual individual de cada produto.<br />
<br />
'''CodigoStatusPedido:''' Código de status do pedido (do e-commerce) a ser considerado na busca de dados (Ex.: READY_TO_SHIP);<br />
<br />
'''SituacaoCodigo:''' Código da situação padrão para a gravação dos pedidos;<br />
<br />
'''PortadorCodigo:''' Código do portador padrão para a gravação dos pedidos;<br />
<br />
'''TransportadoraCodigo:''' Código da transportadora padrão para a gravação dos pedidos;<br />
<br />
'''OpSaidaCodigo:''' Código da operação de saída padrão para a gravação dos pedidos;<br />
<br />
'''RepresentanteCodigo:''' Código do representante padrão para a gravação dos pedidos;<br />
<br />
'''TelevendasCodigo:''' Código do televendas padrão para a gravação dos pedidos;<br />
<br />
'''CaracteristicaCodigo:''' Código da característica de venda padrão para a gravação dos pedidos;<br />
<br />
'''DiasPrazoEntrega:''' Prazo de entrega padrão, a partir da emissão, para pedidos (quantidade de dias);<br />
<br />
'''TipoFrete:''' Tipo de frete;<br />
<br />
'''StatusCliente:''' Código do status de pessoa para clientes trazidos do e-commerce;<br />
<br />
'''RamoAtividadeCodigo:''' Código do ramo de atividade padrão para a gravação dos clientes;<br />
<br />
'''DefinirEnqFiscal:''' Define o enquadramento fiscal do cliente ao integrá-lo;<br />
<br />
'''FamiliasKit:''' Define quais famílias serão consideradas para kits na integração;<br />
<br />
'''CanaisVenda:''' Define quais serão os canais de venda dos produtos. Separar por vírgulas (Ex.: 91008, 91009);<br />
<br />
'''Classificacao:''' Classificação utilizada no adiantamento;<br />
<br />
'''Divisao:''' Divisão utilizada no adiantamento;<br />
<br />
'''CentroCusto:''' Centro de Custo utilizada no adiantamento;<br />
<br />
<br />
== 1° Passo - Criar um Aplicativo ==<br />
<br />
Acessar Link:<br />
[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]<br />
<br />
Após acessar a conta, basta ir até o "Personal Center"<br />
[[Arquivo:Personal Center - Shopee Developer.png|Personal Center - Shopee Developer]]<br />
<br />
<br><br />
<br><br />
<br />
Depois basta ir em Cadastro -> Cadastro de Aplicativos: [https://open.shopee.com/console/app Shopee - Aplicativo]<br />
<br />
<br><br />
<br><br />
<br />
[[Arquivo:App - Shopee Developer.png|App - Shopee Developer]]<br />
<br />
Depois basta selecionar o aplicativo ou criar um novo:<br />
<br />
<br><br />
<br><br />
<br />
[[Arquivo:New App - Shopee Developer.png|New App - Shopee Developer]]<br />
<br />
<br><br />
<br><br />
Ao criar um novo aplicativo, a URL de Callback (Redirect URL Domain) será essa: <ref>https://google.com</ref>.<br />
<br />
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 />
<br><br />
<br><br />
<br />
[[Arquivo:Credenciais - Shopee Developer.png|Credenciais - Shopee Developer]]<br />
<br />
== 2° Passo - Criar uma loja ==<br />
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 />
<br><br />
<br><br />
<br />
[[Arquivo:Loja - Shopee Developer.png|Loja - Shopee Developer]]<br />
<br />
<br />
== 3° Passo - Configuração no ERP ==<br />
<br />
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.<br />
<br />
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:<br />
[[Arquivo:Credenciais (Code) Part.1 - Shopee Developer.png|Credenciais (Code) Part.1 - Shopee Developer]]<br />
<br />
[[Arquivo:Credenciais (Code) Part.2 - Shopee Developer.png|Credenciais (Code) Part.2 - Shopee Developer]]<br />
<br />
[[Arquivo:Credenciais (Code) Part.3 - Shopee Developer.png|Credenciais (Code) Part.3 - Shopee Developer]]<br />
<br />
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'''<br />
[[Arquivo:Credenciais (Code) Part.4 - Shopee Developer.png|Credenciais (Code) Part.4 - Shopee Developer]]<br />
<br />
Após gerar o token de acesso temporário, basta clicar em '''Gerar Token Acesso''':<br />
[[Arquivo:Credenciais (Code) Part.5 - Shopee Developer.png|Credenciais (Code) Part.5 - Shopee Developer]]<br />
<br />
<br><br />
<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>.<br />
<br />
== Requisitos ==<br />
<br />
'''Produtos:'''<br />
Atributo adicional: J:\Vb.Net\Scripts\Atributos Adicionais\Adiciona campos adicionais no cadastro de Produto - Shopee.sql; <br><br />
Marcar o produto para o aceite de integrações; <br><br />
Informar embalagem com as dimensões; <br><br />
E obrigatóriamente informar imagem(ns) no produto (ao menos uma) marcada como desenho.</div>Viniciushttps://wiki.dataplussistemas.com.br/index.php?title=RN_Integracao_ReenvioInformacoes&diff=15513RN Integracao ReenvioInformacoes2026-02-24T18:47:55Z<p>Vinicius: Criou página com 'Regra de negócio do tipo Habilitadora que pode ser acoplada ao DataPlus ERP e tem por objetivo habilitar recursos no formulário de Nota Fiscal para reenvio de informações para integrações externas. == Acoplamento == Essa regra de negócio por hora só pode ser acoplada ao formulário de Nota Fiscal (frmMovNotaFiscal), podendo ser expandida para outros formulários futuramente. Ela esta preparada para funcionar em conjunto com o método '''OnLoad''' e n...'</p>
<hr />
<div>Regra de negócio do tipo Habilitadora que pode ser acoplada ao [[DataPlus ERP]] e tem por objetivo habilitar recursos no formulário de [[Nota Fiscal]] para reenvio de informações para integrações externas.<br />
<br />
== Acoplamento ==<br />
Essa regra de negócio por hora só pode ser acoplada ao formulário de [[Nota Fiscal]] (frmMovNotaFiscal), podendo ser expandida para outros formulários futuramente. Ela esta preparada para funcionar em conjunto com o método '''OnLoad''' e no tempo de execução '''Depois'''.</div>Viniciushttps://wiki.dataplussistemas.com.br/index.php?title=RN_Integracao_Shopee_v2&diff=15456RN Integracao Shopee v22026-02-19T13:02:24Z<p>Vinicius: </p>
<hr />
<div>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.<br />
<br />
Para a versão 2 da API da Shopee, foi incluído um novo processo de autenticação de usuário/aplicativo.<br />
<br />
== Acoplamento ==<br />
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'''.<br />
<br />
== Parâmetros ==<br />
'''UrlEcommerce:'''<br />
<br><br />
<br />
URL de homologação -> https://openplatform.sandbox.test-stable.shopee.sg<br />
<br><br />
<br />
URL de produção -> https://openplatform.shopee.com.br<br />
<br />
'''UrlAutorizacao:'''<br />
<br><br />
<br />
URL de homologação -> https://partner.test-stable.shopeemobile.com<br />
<br><br />
<br />
URL de produção -> https://openplatform.shopee.com.br<br />
<br />
<br />
'''PartnerId:''' Partner ID (Identificador do aplicativo da Shopee);<br />
<br />
'''PartnerKey:''' Partner Key (Chave Secreta do aplicativo da Shopee);<br />
<br />
'''ShopId:''' ID da Loja Shopee (ShopID);<br />
<br />
'''NumeroListaPrecoProdutos:''' Lista de Preços para realizar o envio dos produtos para o web service;<br />
<br />
'''EmpresaReceptora:''' Empresa em que o pedido será integrado.<br />
<br />
'''QtdeEstoque:''' Quantidade de estoque fixa a ser enviada. Se for zero ou vazio, enviará o estoque atual individual de cada produto.<br />
<br />
'''CodigoStatusPedido:''' Código de status do pedido (do e-commerce) a ser considerado na busca de dados (Ex.: READ_TO_SHIP);<br />
<br />
'''SituacaoCodigo:''' Código da situação padrão para a gravação dos pedidos;<br />
<br />
'''PortadorCodigo:''' Código do portador padrão para a gravação dos pedidos;<br />
<br />
'''TransportadoraCodigo:''' Código da transportadora padrão para a gravação dos pedidos;<br />
<br />
'''OpSaidaCodigo:''' Código da operação de saída padrão para a gravação dos pedidos;<br />
<br />
'''RepresentanteCodigo:''' Código do representante padrão para a gravação dos pedidos;<br />
<br />
'''TelevendasCodigo:''' Código do televendas padrão para a gravação dos pedidos;<br />
<br />
'''CaracteristicaCodigo:''' Código da característica de venda padrão para a gravação dos pedidos;<br />
<br />
'''DiasPrazoEntrega:''' Prazo de entrega padrão, a partir da emissão, para pedidos (quantidade de dias);<br />
<br />
'''TipoFrete:''' Tipo de frete;<br />
<br />
'''StatusCliente:''' Código do status de pessoa para clientes trazidos do e-commerce;<br />
<br />
'''RamoAtividadeCodigo:''' Código do ramo de atividade padrão para a gravação dos clientes;<br />
<br />
'''DefinirEnqFiscal:''' Define o enquadramento fiscal do cliente ao integrá-lo;<br />
<br />
'''FamiliasKit:''' Define quais famílias serão consideradas para kits na integração;<br />
<br />
'''CanaisVenda:''' Define quais serão os canais de venda dos produtos. Separar por vírgulas (Ex.: 91008, 91009);<br />
<br />
'''Classificacao:''' Classificação utilizada no adiantamento;<br />
<br />
'''Divisao:''' Divisão utilizada no adiantamento;<br />
<br />
'''CentroCusto:''' Centro de Custo utilizada no adiantamento;<br />
<br />
<br />
== 1° Passo - Criar um Aplicativo ==<br />
<br />
Acessar Link:<br />
[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]<br />
<br />
Após acessar a conta, basta ir até o "Personal Center"<br />
[[Arquivo:Personal Center - Shopee Developer.png|Personal Center - Shopee Developer]]<br />
<br />
<br><br />
<br><br />
<br />
Depois basta ir em Cadastro -> Cadastro de Aplicativos: [https://open.shopee.com/console/app Shopee - Aplicativo]<br />
<br />
<br><br />
<br><br />
<br />
[[Arquivo:App - Shopee Developer.png|App - Shopee Developer]]<br />
<br />
Depois basta selecionar o aplicativo ou criar um novo:<br />
<br />
<br><br />
<br><br />
<br />
[[Arquivo:New App - Shopee Developer.png|New App - Shopee Developer]]<br />
<br />
<br><br />
<br><br />
Ao criar um novo aplicativo, a URL de Callback (Redirect URL Domain) será essa: <ref>https://google.com</ref>.<br />
<br />
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 />
<br><br />
<br><br />
<br />
[[Arquivo:Credenciais - Shopee Developer.png|Credenciais - Shopee Developer]]<br />
<br />
== 2° Passo - Criar uma loja ==<br />
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 />
<br><br />
<br><br />
<br />
[[Arquivo:Loja - Shopee Developer.png|Loja - Shopee Developer]]<br />
<br />
<br />
== 3° Passo - Configuração no ERP ==<br />
<br />
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.<br />
<br />
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:<br />
[[Arquivo:Credenciais (Code) Part.1 - Shopee Developer.png|Credenciais (Code) Part.1 - Shopee Developer]]<br />
<br />
[[Arquivo:Credenciais (Code) Part.2 - Shopee Developer.png|Credenciais (Code) Part.2 - Shopee Developer]]<br />
<br />
[[Arquivo:Credenciais (Code) Part.3 - Shopee Developer.png|Credenciais (Code) Part.3 - Shopee Developer]]<br />
<br />
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'''<br />
[[Arquivo:Credenciais (Code) Part.4 - Shopee Developer.png|Credenciais (Code) Part.4 - Shopee Developer]]<br />
<br />
Após gerar o token de acesso temporário, basta clicar em '''Gerar Token Acesso''':<br />
[[Arquivo:Credenciais (Code) Part.5 - Shopee Developer.png|Credenciais (Code) Part.5 - Shopee Developer]]<br />
<br />
<br><br />
<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>.<br />
<br />
== Requisitos ==<br />
<br />
'''Produtos:'''<br />
Atributo adicional: J:\Vb.Net\Scripts\Atributos Adicionais\Adiciona campos adicionais no cadastro de Produto - Shopee.sql; <br><br />
Marcar o produto para o aceite de integrações; <br><br />
Informar embalagem com as dimensões; <br><br />
E obrigatóriamente informar imagem(ns) no produto (ao menos uma) marcada como desenho.</div>Viniciushttps://wiki.dataplussistemas.com.br/index.php?title=RN_Integracao_Shopee_v2&diff=15455RN Integracao Shopee v22026-02-19T13:01:45Z<p>Vinicius: </p>
<hr />
<div>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.<br />
<br />
Para a versão 2 da API da Shopee, foi incluído um novo processo de autenticação de usuário/aplicativo.<br />
<br />
== Acoplamento ==<br />
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'''.<br />
<br />
== Parâmetros ==<br />
'''UrlEcommerce:'''<br />
<br><br />
<br />
URL de homologação -> https://openplatform.sandbox.test-stable.shopee.sg<br />
<br><br />
<br />
URL de produção -> https://openplatform.shopee.com.br<br />
<br />
'''UrlAutorizacao:'''<br />
<br><br />
<br />
URL de homologação -> https://partner.test-stable.shopeemobile.com<br />
<br><br />
<br />
URL de produção -> https://openplatform.shopee.com.br<br />
<br />
<br />
'''PartnerId:''' Partner ID (Identificador do aplicativo da Shopee);<br />
<br />
'''PartnerKey:''' Partner Key (Chave Secreta do aplicativo da Shopee);<br />
<br />
'''ShopId:''' ID da Loja Shopee (ShopID);<br />
<br />
'''NumeroListaPrecoProdutos:''' Lista de Preços para realizar o envio dos produtos para o web service;<br />
<br />
'''EmpresaReceptora:''' Empresa em que o pedido será integrado.<br />
<br />
'''QtdeEstoque:''' Quantidade de estoque fixa a ser enviada. Se for zero ou vazio, enviará o estoque atual individual de cada produto.<br />
<br />
'''CodigoStatusPedido:''' Código de status do pedido (do e-commerce) a ser considerado na busca de dados (Ex.: READ_TO_SHIP);<br />
<br />
'''SituacaoCodigo:''' Código da situação padrão para a gravação dos pedidos;<br />
<br />
'''PortadorCodigo:''' Código do portador padrão para a gravação dos pedidos;<br />
<br />
'''TransportadoraCodigo:''' Código da transportadora padrão para a gravação dos pedidos;<br />
<br />
'''OpSaidaCodigo:''' Código da operação de saída padrão para a gravação dos pedidos;<br />
<br />
'''RepresentanteCodigo:''' Código do representante padrão para a gravação dos pedidos;<br />
<br />
'''TelevendasCodigo:''' Código do televendas padrão para a gravação dos pedidos;<br />
<br />
'''CaracteristicaCodigo:''' Código da característica de venda padrão para a gravação dos pedidos;<br />
<br />
'''DiasPrazoEntrega:''' Prazo de entrega padrão, a partir da emissão, para pedidos (quantidade de dias);<br />
<br />
'''TipoFrete:''' Tipo de frete;<br />
<br />
'''StatusCliente:''' Código do status de pessoa para clientes trazidos do e-commerce;<br />
<br />
'''RamoAtividadeCodigo:''' Código do ramo de atividade padrão para a gravação dos clientes;<br />
<br />
'''DefinirEnqFiscal:''' Define o enquadramento fiscal do cliente ao integrá-lo;<br />
<br />
'''FamiliasKit:''' Define quais famílias serão consideradas para kits na integração;<br />
<br />
'''CanaisVenda:''' Define quais serão os canais de venda dos produtos. Separar por vírgulas (Ex.: 91008, 91009);<br />
<br />
'''Classificacao:''' Classificação utilizada no adiantamento;<br />
<br />
'''Divisao:''' Divisão utilizada no adiantamento;<br />
<br />
'''CentroCusto:''' Centro de Custo utilizada no adiantamento;<br />
<br />
<br />
== 1° Passo - Criar um Aplicativo ==<br />
<br />
Acessar Link:<br />
[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]<br />
<br />
Após acessar a conta, basta ir até o "Personal Center"<br />
[[Arquivo:Personal Center - Shopee Developer.png|Personal Center - Shopee Developer]]<br />
<br />
<br><br />
<br><br />
<br />
Depois basta ir em Cadastro -> Cadastro de Aplicativos: [https://open.shopee.com/console/app Shopee - Aplicativo]<br />
<br />
<br><br />
<br><br />
<br />
[[Arquivo:App - Shopee Developer.png|App - Shopee Developer]]<br />
<br />
Depois basta selecionar o aplicativo ou criar um novo:<br />
<br />
<br><br />
<br><br />
<br />
[[Arquivo:New App - Shopee Developer.png|New App - Shopee Developer]]<br />
<br />
<br><br />
<br><br />
Ao criar um novo aplicativo, a URL de Callback (Redirect URL Domain) será essa: <ref>https://google.com</ref>.<br />
<br />
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 />
<br><br />
<br><br />
<br />
[[Arquivo:Credenciais - Shopee Developer.png|Credenciais - Shopee Developer]]<br />
<br />
== 2° Passo - Criar uma loja ==<br />
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 />
<br><br />
<br><br />
<br />
[[Arquivo:Loja - Shopee Developer.png|Loja - Shopee Developer]]<br />
<br />
<br />
== 3° Passo - Configuração no ERP ==<br />
<br />
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.<br />
<br />
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:<br />
[[Arquivo:Credenciais (Code) Part.1 - Shopee Developer.png|Credenciais (Code) Part.1 - Shopee Developer]]<br />
<br />
[[Arquivo:Credenciais (Code) Part.2 - Shopee Developer.png|Credenciais (Code) Part.2 - Shopee Developer]]<br />
<br />
[[Arquivo:Credenciais (Code) Part.3 - Shopee Developer.png|Credenciais (Code) Part.3 - Shopee Developer]]<br />
<br />
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'''<br />
[[Arquivo:Credenciais (Code) Part.4 - Shopee Developer.png|Credenciais (Code) Part.4 - Shopee Developer]]<br />
<br />
Após gerar o token de acesso temporário, basta clicar em '''Gerar Token Acesso''':<br />
[[Arquivo:Credenciais (Code) Part.5 - Shopee Developer.png|Credenciais (Code) Part.5 - Shopee Developer]]<br />
<br />
Com a mensagem o ecommerce está configurado corretamente. '''As credenciais de acesso é guardado em um XML na pasta do usuário (C:\Users\USUARIO\AppData\Local) no arquivo ApiConfig no nó <Shopee_Shop_PARTNER_ID>.'''<br />
<br />
== Requisitos ==<br />
<br />
'''Produtos:'''<br />
Atributo adicional: J:\Vb.Net\Scripts\Atributos Adicionais\Adiciona campos adicionais no cadastro de Produto - Shopee.sql; <br><br />
Marcar o produto para o aceite de integrações; <br><br />
Informar embalagem com as dimensões; <br><br />
E obrigatóriamente informar imagem(ns) no produto (ao menos uma) marcada como desenho.</div>Viniciushttps://wiki.dataplussistemas.com.br/index.php?title=RN_Integracao_Shopee_v2&diff=15454RN Integracao Shopee v22026-02-19T13:00:49Z<p>Vinicius: </p>
<hr />
<div>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.<br />
<br />
Para a versão 2 da API da Shopee, foi incluído um novo processo de autenticação de usuário/aplicativo.<br />
<br />
== Acoplamento ==<br />
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'''.<br />
<br />
== Parâmetros ==<br />
'''UrlEcommerce:'''<br />
<br><br />
<br />
URL de homologação -> https://openplatform.sandbox.test-stable.shopee.sg<br />
<br><br />
<br />
URL de produção -> https://openplatform.shopee.com.br<br />
<br />
'''UrlAutorizacao:'''<br />
<br><br />
<br />
URL de homologação -> https://partner.test-stable.shopeemobile.com<br />
<br><br />
<br />
URL de produção -> https://openplatform.shopee.com.br<br />
<br />
<br />
'''PartnerId:''' Partner ID (Identificador do aplicativo da Shopee);<br />
<br />
'''PartnerKey:''' Partner Key (Chave Secreta do aplicativo da Shopee);<br />
<br />
'''ShopId:''' ID da Loja Shopee (ShopID);<br />
<br />
'''NumeroListaPrecoProdutos:''' Lista de Preços para realizar o envio dos produtos para o web service;<br />
<br />
'''EmpresaReceptora:''' Empresa em que o pedido será integrado.<br />
<br />
'''QtdeEstoque:''' Quantidade de estoque fixa a ser enviada. Se for zero ou vazio, enviará o estoque atual individual de cada produto.<br />
<br />
'''CodigoStatusPedido:''' Código de status do pedido (do e-commerce) a ser considerado na busca de dados (Ex.: READ_TO_SHIP);<br />
<br />
'''SituacaoCodigo:''' Código da situação padrão para a gravação dos pedidos;<br />
<br />
'''PortadorCodigo:''' Código do portador padrão para a gravação dos pedidos;<br />
<br />
'''TransportadoraCodigo:''' Código da transportadora padrão para a gravação dos pedidos;<br />
<br />
'''OpSaidaCodigo:''' Código da operação de saída padrão para a gravação dos pedidos;<br />
<br />
'''RepresentanteCodigo:''' Código do representante padrão para a gravação dos pedidos;<br />
<br />
'''TelevendasCodigo:''' Código do televendas padrão para a gravação dos pedidos;<br />
<br />
'''CaracteristicaCodigo:''' Código da característica de venda padrão para a gravação dos pedidos;<br />
<br />
'''DiasPrazoEntrega:''' Prazo de entrega padrão, a partir da emissão, para pedidos (quantidade de dias);<br />
<br />
'''TipoFrete:''' Tipo de frete;<br />
<br />
'''StatusCliente:''' Código do status de pessoa para clientes trazidos do e-commerce;<br />
<br />
'''RamoAtividadeCodigo:''' Código do ramo de atividade padrão para a gravação dos clientes;<br />
<br />
'''DefinirEnqFiscal:''' Define o enquadramento fiscal do cliente ao integrá-lo;<br />
<br />
'''FamiliasKit:''' Define quais famílias serão consideradas para kits na integração;<br />
<br />
'''CanaisVenda:''' Define quais serão os canais de venda dos produtos. Separar por vírgulas (Ex.: 91008, 91009);<br />
<br />
'''Classificacao:''' Classificação utilizada no adiantamento;<br />
<br />
'''Divisao:''' Divisão utilizada no adiantamento;<br />
<br />
'''CentroCusto:''' Centro de Custo utilizada no adiantamento;<br />
<br />
<br />
== 1° Passo - Criar um Aplicativo ==<br />
<br />
Acessar Link:<br />
[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]<br />
<br />
Após acessar a conta, basta ir até o "Personal Center"<br />
[[Arquivo:Personal Center - Shopee Developer.png|Personal Center - Shopee Developer]]<br />
<br />
<br><br />
<br><br />
<br />
Depois basta ir em Cadastro -> Cadastro de Aplicativos: [https://open.shopee.com/console/app Shopee - Aplicativo]<br />
<br />
<br><br />
<br><br />
<br />
[[Arquivo:App - Shopee Developer.png|App - Shopee Developer]]<br />
<br />
Depois basta selecionar o aplicativo ou criar um novo:<br />
<br />
<br><br />
<br><br />
<br />
[[Arquivo:New App - Shopee Developer.png|New App - Shopee Developer]]<br />
<br />
<br><br />
<br><br />
Ao criar um novo aplicativo, a URL de Callback (Redirect URL Domain) será essa: <ref>https://google.com</ref>.<br />
<br />
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 />
<br><br />
<br><br />
<br />
[[Arquivo:Credenciais - Shopee Developer.png|Credenciais - Shopee Developer]]<br />
<br />
== 2° Passo - Criar uma loja ==<br />
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 />
<br><br />
<br><br />
<br />
[[Arquivo:Loja - Shopee Developer.png|Loja - Shopee Developer]]<br />
<br />
<br />
== 3° Passo - Configuração no ERP ==<br />
<br />
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.<br />
<br />
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:<br />
[[Arquivo:Credenciais (Code) Part.1 - Shopee Developer.png|Credenciais (Code) Part.1 - Shopee Developer]]<br />
<br />
[[Arquivo:Credenciais (Code) Part.2 - Shopee Developer.png|Credenciais (Code) Part.2 - Shopee Developer]]<br />
<br />
[[Arquivo:Credenciais (Code) Part.3 - Shopee Developer.png|Credenciais (Code) Part.3 - Shopee Developer]]<br />
<br />
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'''<br />
[[Arquivo:Credenciais (Code) Part.4 - Shopee Developer.png|Credenciais (Code) Part.4 - Shopee Developer]]<br />
<br />
Após gerar o token de acesso temporário, basta clicar em '''Gerar Token Acesso''':<br />
[[Arquivo:Credenciais (Code) Part.5 - Shopee Developer.png|Credenciais (Code) Part.5 - Shopee Developer]]<br />
<br />
Com a mensagem o ecommerce está configurado corretamente. '''As credenciais de acesso é guardado em um XML na pasta do usuário (C:\Users\USUARIO\AppData\Local) no arquivo ApiConfig no nó <Shopee_Shop_PARTNER_ID>.'''<br />
<br />
== Requisitos ==<br />
<br />
'''Produtos:'''<br />
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.</div>Viniciushttps://wiki.dataplussistemas.com.br/index.php?title=RN_Integracao_Shopee_v2&diff=15453RN Integracao Shopee v22026-02-19T12:58:42Z<p>Vinicius: </p>
<hr />
<div>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.<br />
<br />
Para a versão 2 da API da Shopee, foi incluído um novo processo de autenticação de usuário/aplicativo.<br />
<br />
== Acoplamento ==<br />
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'''.<br />
<br />
== Parâmetros ==<br />
'''UrlEcommerce:'''<br />
<br><br />
<br />
URL de homologação -> https://openplatform.sandbox.test-stable.shopee.sg<br />
<br><br />
<br />
URL de produção -> https://openplatform.shopee.com.br<br />
<br />
'''UrlAutorizacao:'''<br />
<br><br />
<br />
URL de homologação -> https://partner.test-stable.shopeemobile.com<br />
<br><br />
<br />
URL de produção -> https://openplatform.shopee.com.br<br />
<br />
<br />
'''PartnerId:''' Partner ID (Identificador do aplicativo da Shopee);<br />
<br />
'''PartnerKey:''' Partner Key (Chave Secreta do aplicativo da Shopee);<br />
<br />
'''ShopId:''' ID da Loja Shopee (ShopID);<br />
<br />
'''NumeroListaPrecoProdutos:''' Lista de Preços para realizar o envio dos produtos para o web service;<br />
<br />
'''EmpresaReceptora:''' Empresa em que o pedido será integrado.<br />
<br />
'''QtdeEstoque:''' Quantidade de estoque fixa a ser enviada. Se for zero ou vazio, enviará o estoque atual individual de cada produto.<br />
<br />
'''CodigoStatusPedido:''' Código de status do pedido (do e-commerce) a ser considerado na busca de dados (Ex.: READ_TO_SHIP);<br />
<br />
'''SituacaoCodigo:''' Código da situação padrão para a gravação dos pedidos;<br />
<br />
'''PortadorCodigo:''' Código do portador padrão para a gravação dos pedidos;<br />
<br />
'''TransportadoraCodigo:''' Código da transportadora padrão para a gravação dos pedidos;<br />
<br />
'''OpSaidaCodigo:''' Código da operação de saída padrão para a gravação dos pedidos;<br />
<br />
'''RepresentanteCodigo:''' Código do representante padrão para a gravação dos pedidos;<br />
<br />
'''TelevendasCodigo:''' Código do televendas padrão para a gravação dos pedidos;<br />
<br />
'''CaracteristicaCodigo:''' Código da característica de venda padrão para a gravação dos pedidos;<br />
<br />
'''DiasPrazoEntrega:''' Prazo de entrega padrão, a partir da emissão, para pedidos (quantidade de dias);<br />
<br />
'''TipoFrete:''' Tipo de frete;<br />
<br />
'''StatusCliente:''' Código do status de pessoa para clientes trazidos do e-commerce;<br />
<br />
'''RamoAtividadeCodigo:''' Código do ramo de atividade padrão para a gravação dos clientes;<br />
<br />
'''DefinirEnqFiscal:''' Define o enquadramento fiscal do cliente ao integrá-lo;<br />
<br />
'''FamiliasKit:''' Define quais famílias serão consideradas para kits na integração;<br />
<br />
'''CanaisVenda:''' Define quais serão os canais de venda dos produtos. Separar por vírgulas (Ex.: 91008, 91009);<br />
<br />
'''Classificacao:''' Classificação utilizada no adiantamento;<br />
<br />
'''Divisao:''' Divisão utilizada no adiantamento;<br />
<br />
'''CentroCusto:''' Centro de Custo utilizada no adiantamento;<br />
<br />
<br />
== 1° Passo - Criar um Aplicativo ==<br />
<br />
Acessar Link:<br />
[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]<br />
<br />
Após acessar a conta, basta ir até o "Personal Center"<br />
[[Arquivo:Personal Center - Shopee Developer.png|Personal Center - Shopee Developer]]<br />
<br />
<br><br />
<br><br />
<br />
Depois basta ir em Cadastro -> Cadastro de Aplicativos: [https://open.shopee.com/console/app Shopee - Aplicativo]<br />
<br />
<br><br />
<br><br />
<br />
[[Arquivo:App - Shopee Developer.png|App - Shopee Developer]]<br />
<br />
Depois basta selecionar o aplicativo ou criar um novo:<br />
<br />
<br><br />
<br><br />
<br />
[[Arquivo:New App - Shopee Developer.png|New App - Shopee Developer]]<br />
<br />
<br><br />
<br><br />
Ao criar um novo aplicativo, a URL de Callback (Redirect URL Domain) será essa: <ref>https://google.com</ref>.<br />
<br />
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 />
<br><br />
<br><br />
<br />
[[Arquivo:Credenciais - Shopee Developer.png|Credenciais - Shopee Developer]]<br />
<br />
== 2° Passo - Criar uma loja ==<br />
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 />
<br><br />
<br><br />
<br />
[[Arquivo:Loja - Shopee Developer.png|Loja - Shopee Developer]]<br />
<br />
<br />
== 3° Passo - Configuração no ERP ==<br />
<br />
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.<br />
<br />
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:<br />
[[Arquivo:Credenciais (Code) Part.1 - Shopee Developer.png|Credenciais (Code) Part.1 - Shopee Developer]]<br />
<br />
[[Arquivo:Credenciais (Code) Part.2 - Shopee Developer.png|Credenciais (Code) Part.2 - Shopee Developer]]<br />
<br />
[[Arquivo:Credenciais (Code) Part.3 - Shopee Developer.png|Credenciais (Code) Part.3 - Shopee Developer]]<br />
<br />
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'''<br />
[[Arquivo:Credenciais (Code) Part.4 - Shopee Developer.png|Credenciais (Code) Part.4 - Shopee Developer]]<br />
<br />
Após gerar o token de acesso temporário, basta clicar em '''Gerar Token Acesso''':<br />
[[Arquivo:Credenciais (Code) Part.5 - Shopee Developer.png|Credenciais (Code) Part.5 - Shopee Developer]]<br />
<br />
Com a mensagem o ecommerce está configurado corretamente. '''As credenciais de acesso é guardado em um XML na pasta do usuário (C:\Users\USUARIO\AppData\Local) no arquivo ApiConfig no nó <Shopee_Shop_PARTNER_ID>.'''<br />
<br />
== Requisitos ==<br />
'''Atributo adicional para o produto:'''<br />
J:\Vb.Net\Scripts\Atributos Adicionais\Adiciona campos adicionais no cadastro de Produto - Shopee.sql</div>Viniciushttps://wiki.dataplussistemas.com.br/index.php?title=RN_Integracao_Shopee_v2&diff=15451RN Integracao Shopee v22026-02-18T19:27:32Z<p>Vinicius: </p>
<hr />
<div>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.<br />
<br />
Para a versão 2 da API da Shopee, foi incluído um novo processo de autenticação de usuário/aplicativo.<br />
<br />
== 1° Passo - Criar um Aplicativo ==<br />
<br />
Acessar Link:<br />
[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]<br />
<br />
Após acessar a conta, basta ir até o "Personal Center"<br />
[[Arquivo:Personal Center - Shopee Developer.png|Personal Center - Shopee Developer]]<br />
<br />
<br><br />
<br><br />
<br />
Depois basta ir em Cadastro -> Cadastro de Aplicativos: [https://open.shopee.com/console/app Shopee - Aplicativo]<br />
<br />
<br><br />
<br><br />
<br />
[[Arquivo:App - Shopee Developer.png|App - Shopee Developer]]<br />
<br />
Depois basta selecionar o aplicativo ou criar um novo:<br />
<br />
<br><br />
<br><br />
<br />
[[Arquivo:New App - Shopee Developer.png|New App - Shopee Developer]]<br />
<br />
<br><br />
<br><br />
Ao criar um novo aplicativo, a URL de Callback (Redirect URL Domain) será essa: <ref>https://google.com</ref>.<br />
<br />
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 />
<br><br />
<br><br />
<br />
[[Arquivo:Credenciais - Shopee Developer.png|Credenciais - Shopee Developer]]<br />
<br />
== 2° Passo - Criar uma loja ==<br />
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 />
<br><br />
<br><br />
<br />
[[Arquivo:Loja - Shopee Developer.png|Loja - Shopee Developer]]<br />
<br />
<br />
== 3° Passo - Configuração no ERP ==<br />
<br />
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.<br />
<br />
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:<br />
[[Arquivo:Credenciais (Code) Part.1 - Shopee Developer.png|Credenciais (Code) Part.1 - Shopee Developer]]<br />
<br />
[[Arquivo:Credenciais (Code) Part.2 - Shopee Developer.png|Credenciais (Code) Part.2 - Shopee Developer]]<br />
<br />
[[Arquivo:Credenciais (Code) Part.3 - Shopee Developer.png|Credenciais (Code) Part.3 - Shopee Developer]]<br />
<br />
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'''<br />
[[Arquivo:Credenciais (Code) Part.4 - Shopee Developer.png|Credenciais (Code) Part.4 - Shopee Developer]]<br />
<br />
Após gerar o token de acesso temporário, basta clicar em '''Gerar Token Acesso''':<br />
[[Arquivo:Credenciais (Code) Part.5 - Shopee Developer.png|Credenciais (Code) Part.5 - Shopee Developer]]<br />
<br />
Com a mensagem o ecommerce está configurado corretamente. '''As credenciais de acesso é guardado em um XML na pasta do usuário (C:\Users\USUARIO\AppData\Local) no arquivo ApiConfig no nó <Shopee_Shop_PARTNER_ID>.'''<br />
<br />
== Acoplamento ==<br />
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'''.<br />
<br />
== Parâmetros ==<br />
'''UrlEcommerce:'''<br />
<br><br />
<br />
URL de homologação -> https://openplatform.sandbox.test-stable.shopee.sg<br />
<br><br />
<br />
URL de produção -> https://openplatform.shopee.com.br<br />
<br />
'''UrlAutorizacao:'''<br />
<br><br />
<br />
URL de homologação -> https://partner.test-stable.shopeemobile.com<br />
<br><br />
<br />
URL de produção -> https://openplatform.shopee.com.br<br />
<br />
<br />
'''PartnerId:''' Partner ID (Identificador do aplicativo da Shopee);<br />
<br />
'''PartnerKey:''' Partner Key (Chave Secreta do aplicativo da Shopee);<br />
<br />
'''ShopId:''' ID da Loja Shopee (ShopID);<br />
<br />
'''NumeroListaPrecoProdutos:''' Lista de Preços para realizar o envio dos produtos para o web service;<br />
<br />
'''EmpresaReceptora:''' Empresa em que o pedido será integrado.<br />
<br />
'''QtdeEstoque:''' Quantidade de estoque fixa a ser enviada. Se for zero ou vazio, enviará o estoque atual individual de cada produto.<br />
<br />
'''CodigoStatusPedido:''' Código de status do pedido (do e-commerce) a ser considerado na busca de dados (Ex.: READ_TO_SHIP);<br />
<br />
'''SituacaoCodigo:''' Código da situação padrão para a gravação dos pedidos;<br />
<br />
'''PortadorCodigo:''' Código do portador padrão para a gravação dos pedidos;<br />
<br />
'''TransportadoraCodigo:''' Código da transportadora padrão para a gravação dos pedidos;<br />
<br />
'''OpSaidaCodigo:''' Código da operação de saída padrão para a gravação dos pedidos;<br />
<br />
'''RepresentanteCodigo:''' Código do representante padrão para a gravação dos pedidos;<br />
<br />
'''TelevendasCodigo:''' Código do televendas padrão para a gravação dos pedidos;<br />
<br />
'''CaracteristicaCodigo:''' Código da característica de venda padrão para a gravação dos pedidos;<br />
<br />
'''DiasPrazoEntrega:''' Prazo de entrega padrão, a partir da emissão, para pedidos (quantidade de dias);<br />
<br />
'''TipoFrete:''' Tipo de frete;<br />
<br />
'''StatusCliente:''' Código do status de pessoa para clientes trazidos do e-commerce;<br />
<br />
'''RamoAtividadeCodigo:''' Código do ramo de atividade padrão para a gravação dos clientes;<br />
<br />
'''DefinirEnqFiscal:''' Define o enquadramento fiscal do cliente ao integrá-lo;<br />
<br />
'''FamiliasKit:''' Define quais famílias serão consideradas para kits na integração;<br />
<br />
'''CanaisVenda:''' Define quais serão os canais de venda dos produtos. Separar por vírgulas (Ex.: 91008, 91009);<br />
<br />
'''Classificacao:''' Classificação utilizada no adiantamento;<br />
<br />
'''Divisao:''' Divisão utilizada no adiantamento;<br />
<br />
'''CentroCusto:''' Centro de Custo utilizada no adiantamento;<br />
<br />
== Requisitos ==<br />
'''Atributo adicional para o produto:'''<br />
J:\Vb.Net\Scripts\Atributos Adicionais\Adiciona campos adicionais no cadastro de Produto - Shopee.sql</div>Viniciushttps://wiki.dataplussistemas.com.br/index.php?title=RN_Integracao_Shopee_v2&diff=15450RN Integracao Shopee v22026-02-18T19:26:58Z<p>Vinicius: </p>
<hr />
<div>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.<br />
<br />
Para a versão 2 da API da Shopee, foi incluído um novo processo de autenticação de usuário/aplicativo.<br />
<br />
== 1° Passo - Criar um Aplicativo ==<br />
<br />
Acessar Link:<br />
[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]<br />
<br />
Após acessar a conta, basta ir até o "Personal Center"<br />
[[Arquivo:Personal Center - Shopee Developer.png|Personal Center - Shopee Developer]]<br />
<br />
<br><br />
<br><br />
<br />
Depois basta ir em Cadastro -> Cadastro de Aplicativos: [https://open.shopee.com/console/app Shopee - Aplicativo]<br />
<br />
<br><br />
<br><br />
<br />
[[Arquivo:App - Shopee Developer.png|App - Shopee Developer]]<br />
<br />
Depois basta selecionar o aplicativo ou criar um novo:<br />
<br />
<br><br />
<br><br />
<br />
[[Arquivo:New App - Shopee Developer.png|New App - Shopee Developer]]<br />
<br />
<br><br />
<br><br />
Ao criar um novo aplicativo, a URL de Callback (Redirect URL Domain) será essa: <ref>https://google.com</ref>.<br />
<br />
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 />
<br><br />
<br><br />
<br />
[[Arquivo:Credenciais - Shopee Developer.png|Credenciais - Shopee Developer]]<br />
<br />
== 2° Passo - Criar uma loja ==<br />
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 />
<br><br />
<br><br />
<br />
[[Arquivo:Loja - Shopee Developer.png|Loja - Shopee Developer]]<br />
<br />
<br />
== 3° Passo - Configuração no ERP ==<br />
<br />
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.<br />
<br />
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:<br />
[[Arquivo:Credenciais (Code) Part.1 - Shopee Developer.png|Credenciais (Code) Part.1 - Shopee Developer]]<br />
<br />
[[Arquivo:Credenciais (Code) Part.2 - Shopee Developer.png|Credenciais (Code) Part.2 - Shopee Developer]]<br />
<br />
[[Arquivo:Credenciais (Code) Part.3 - Shopee Developer.png|Credenciais (Code) Part.3 - Shopee Developer]]<br />
<br />
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'''<br />
[[Arquivo:Credenciais (Code) Part.4 - Shopee Developer.png|Credenciais (Code) Part.4 - Shopee Developer]]<br />
<br />
Após gerar o token de acesso temporário, basta clicar em '''Gerar Token Acesso''':<br />
[[Arquivo:Credenciais (Code) Part.5 - Shopee Developer.png|Credenciais (Code) Part.5 - Shopee Developer]]<br />
<br />
Com a mensagem o ecommerce está configurado corretamente. '''As credenciais de acesso é guardado em um XML na pasta do usuário (C:\Users\USUARIO\AppData\Local) no arquivo ApiConfig no nó <Shopee_Shop_PARTNER_ID>.'''<br />
<br />
== Acoplamento ==<br />
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'''.<br />
<br />
== Parâmetros ==<br />
'''UrlEcommerce:'''<br />
<br><br />
<br />
URL de homologação -> https://openplatform.sandbox.test-stable.shopee.sg<br />
<br><br />
<br />
URL de produção -> https://openplatform.shopee.com.br<br />
<br />
'''UrlAutorizacao:'''<br />
<br><br />
<br />
URL de homologação -> https://partner.test-stable.shopeemobile.com<br />
<br><br />
<br />
URL de produção -> https://openplatform.shopee.com.br<br />
<br />
<br />
'''PartnerId:''' Partner ID (Identificador do aplicativo da Shopee);<br />
<br />
'''PartnerKey:''' Partner Key (Chave Secreta do aplicativo da Shopee);<br />
<br />
'''ShopId:''' ID da Loja Shopee (ShopID);<br />
<br />
'''NumeroListaPrecoProdutos:''' Lista de Preços para realizar o envio dos produtos para o web service;<br />
<br />
'''EmpresaReceptora:''' Empresa em que o pedido será integrado.<br />
<br />
'''QtdeEstoque:''' Quantidade de estoque fixa a ser enviada. Se for zero ou vazio, enviará o estoque atual individual de cada produto.<br />
<br />
'''CodigoStatusPedido:''' Código de status do pedido (do e-commerce) a ser considerado na busca de dados (Ex.: READ_TO_SHIP);<br />
<br />
'''SituacaoCodigo:''' Código da situação padrão para a gravação dos pedidos;<br />
<br />
'''PortadorCodigo:''' Código do portador padrão para a gravação dos pedidos;<br />
<br />
'''TransportadoraCodigo:''' Código da transportadora padrão para a gravação dos pedidos;<br />
<br />
'''OpSaidaCodigo:''' Código da operação de saída padrão para a gravação dos pedidos;<br />
<br />
'''RepresentanteCodigo:''' Código do representante padrão para a gravação dos pedidos;<br />
<br />
'''TelevendasCodigo:''' Código do televendas padrão para a gravação dos pedidos;<br />
<br />
'''CaracteristicaCodigo:''' Código da característica de venda padrão para a gravação dos pedidos;<br />
<br />
'''DiasPrazoEntrega:''' Prazo de entrega padrão, a partir da emissão, para pedidos (quantidade de dias);<br />
<br />
'''TipoFrete:''' Tipo de frete;<br />
<br />
'''StatusCliente:''' Código do status de pessoa para clientes trazidos do e-commerce;<br />
<br />
'''RamoAtividadeCodigo:''' Código do ramo de atividade padrão para a gravação dos clientes;<br />
<br />
'''DefinirEnqFiscal:''' Define o enquadramento fiscal do cliente ao integrá-lo;<br />
<br />
'''FamiliasKit:''' Define quais famílias serão consideradas para kits na integração;<br />
<br />
'''CanaisVenda:''' Define quais serão os canais de venda dos produtos. Separar por vírgulas (Ex.: 91008, 91009);<br />
<br />
'''Classificacao:''' Classificação utilizada no adiantamento;<br />
<br />
'''Divisao:''' Divisão utilizada no adiantamento;<br />
<br />
'''CentroCusto:''' Centro de Custo utilizada no adiantamento;<br />
<br />
== Requisitos ==<br />
Atributo adicional para o produto:<br />
J:\Vb.Net\Scripts\Atributos Adicionais\Adiciona campos adicionais no cadastro de Produto - Shopee.sql</div>Viniciushttps://wiki.dataplussistemas.com.br/index.php?title=RN_Integracao_Shopee_v2&diff=15449RN Integracao Shopee v22026-02-18T19:26:11Z<p>Vinicius: </p>
<hr />
<div>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.<br />
<br />
Para a versão 2 da API da Shopee, foi incluído um novo processo de autenticação de usuário/aplicativo.<br />
<br />
== 1° Passo - Criar um Aplicativo ==<br />
<br />
Acessar Link:<br />
[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]<br />
<br />
Após acessar a conta, basta ir até o "Personal Center"<br />
[[Arquivo:Personal Center - Shopee Developer.png|Personal Center - Shopee Developer]]<br />
<br />
<br><br />
<br><br />
<br />
Depois basta ir em Cadastro -> Cadastro de Aplicativos: [https://open.shopee.com/console/app Shopee - Aplicativo]<br />
<br />
<br><br />
<br><br />
<br />
[[Arquivo:App - Shopee Developer.png|App - Shopee Developer]]<br />
<br />
Depois basta selecionar o aplicativo ou criar um novo:<br />
<br />
<br><br />
<br><br />
<br />
[[Arquivo:New App - Shopee Developer.png|New App - Shopee Developer]]<br />
<br />
<br><br />
<br><br />
Ao criar um novo aplicativo, a URL de Callback (Redirect URL Domain) será essa: <ref>https://google.com</ref>.<br />
<br />
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 />
<br><br />
<br><br />
<br />
[[Arquivo:Credenciais - Shopee Developer.png|Credenciais - Shopee Developer]]<br />
<br />
== 2° Passo - Criar uma loja ==<br />
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 />
<br><br />
<br><br />
<br />
[[Arquivo:Loja - Shopee Developer.png|Loja - Shopee Developer]]<br />
<br />
<br />
== 3° Passo - Configuração no ERP ==<br />
<br />
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.<br />
<br />
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:<br />
[[Arquivo:Credenciais (Code) Part.1 - Shopee Developer.png|Credenciais (Code) Part.1 - Shopee Developer]]<br />
<br />
[[Arquivo:Credenciais (Code) Part.2 - Shopee Developer.png|Credenciais (Code) Part.2 - Shopee Developer]]<br />
<br />
[[Arquivo:Credenciais (Code) Part.3 - Shopee Developer.png|Credenciais (Code) Part.3 - Shopee Developer]]<br />
<br />
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'''<br />
[[Arquivo:Credenciais (Code) Part.4 - Shopee Developer.png|Credenciais (Code) Part.4 - Shopee Developer]]<br />
<br />
Após gerar o token de acesso temporário, basta clicar em '''Gerar Token Acesso''':<br />
[[Arquivo:Credenciais (Code) Part.5 - Shopee Developer.png|Credenciais (Code) Part.5 - Shopee Developer]]<br />
<br />
Com a mensagem o ecommerce está configurado corretamente. '''As credenciais de acesso é guardado em um XML na pasta do usuário (C:\Users\USUARIO\AppData\Local) no arquivo ApiConfig no nó <Shopee_Shop_PARTNER_ID>.'''<br />
<br />
== Acoplamento ==<br />
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'''.<br />
<br />
== Parâmetros ==<br />
'''UrlEcommerce:'''<br />
<br><br />
<br />
URL de homologação -> https://openplatform.sandbox.test-stable.shopee.sg<br />
<br><br />
<br />
URL de produção -> https://openplatform.shopee.com.br<br />
<br />
'''UrlAutorizacao:'''<br />
<br><br />
<br />
URL de homologação -> https://partner.test-stable.shopeemobile.com<br />
<br><br />
<br />
URL de produção -> https://openplatform.shopee.com.br<br />
<br />
<br />
'''PartnerId:''' Partner ID (Identificador do aplicativo da Shopee);<br />
<br />
'''PartnerKey:''' Partner Key (Chave Secreta do aplicativo da Shopee);<br />
<br />
'''ShopId:''' ID da Loja Shopee (ShopID);<br />
<br />
'''NumeroListaPrecoProdutos:''' Lista de Preços para realizar o envio dos produtos para o web service;<br />
<br />
'''EmpresaReceptora:''' Empresa em que o pedido será integrado.<br />
<br />
'''QtdeEstoque:''' Quantidade de estoque fixa a ser enviada. Se for zero ou vazio, enviará o estoque atual individual de cada produto.<br />
<br />
'''CodigoStatusPedido:''' Código de status do pedido (do e-commerce) a ser considerado na busca de dados (Ex.: READ_TO_SHIP);<br />
<br />
'''SituacaoCodigo:''' Código da situação padrão para a gravação dos pedidos;<br />
<br />
'''PortadorCodigo:''' Código do portador padrão para a gravação dos pedidos;<br />
<br />
'''TransportadoraCodigo:''' Código da transportadora padrão para a gravação dos pedidos;<br />
<br />
'''OpSaidaCodigo:''' Código da operação de saída padrão para a gravação dos pedidos;<br />
<br />
'''RepresentanteCodigo:''' Código do representante padrão para a gravação dos pedidos;<br />
<br />
'''TelevendasCodigo:''' Código do televendas padrão para a gravação dos pedidos;<br />
<br />
'''CaracteristicaCodigo:''' Código da característica de venda padrão para a gravação dos pedidos;<br />
<br />
'''DiasPrazoEntrega:''' Prazo de entrega padrão, a partir da emissão, para pedidos (quantidade de dias);<br />
<br />
'''TipoFrete:''' Tipo de frete;<br />
<br />
'''StatusCliente:''' Código do status de pessoa para clientes trazidos do e-commerce;<br />
<br />
'''RamoAtividadeCodigo:''' Código do ramo de atividade padrão para a gravação dos clientes;<br />
<br />
'''DefinirEnqFiscal:''' Define o enquadramento fiscal do cliente ao integrá-lo;<br />
<br />
'''FamiliasKit:''' Define quais famílias serão consideradas para kits na integração;<br />
<br />
'''CanaisVenda:''' Define quais serão os canais de venda dos produtos. Separar por vírgulas (Ex.: 91008, 91009);<br />
<br />
'''Classificacao:''' Classificação utilizada no adiantamento;<br />
<br />
'''Divisao:''' Divisão utilizada no adiantamento;<br />
<br />
'''CentroCusto:''' Centro de Custo utilizada no adiantamento;<br />
<br />
Atributo adicional para o produto:<br />
J:\Vb.Net\Scripts\Atributos Adicionais\Adiciona campos adicionais no cadastro de Produto - Shopee.sql</div>Viniciushttps://wiki.dataplussistemas.com.br/index.php?title=RN_Integracao_Shopee_v2&diff=15448RN Integracao Shopee v22026-02-18T19:23:00Z<p>Vinicius: </p>
<hr />
<div>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.<br />
<br />
Para a versão 2 da API da Shopee, foi incluído um novo processo de autenticação de usuário/aplicativo.<br />
<br />
== 1° Passo - Criar um Aplicativo ==<br />
<br />
Acessar Link:<br />
[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]<br />
<br />
Após acessar a conta, basta ir até o "Personal Center"<br />
[[Arquivo:Personal Center - Shopee Developer.png|Personal Center - Shopee Developer]]<br />
<br />
<br><br />
<br><br />
<br />
Depois basta ir em Cadastro -> Cadastro de Aplicativos: [https://open.shopee.com/console/app Shopee - Aplicativo]<br />
<br />
<br><br />
<br><br />
<br />
[[Arquivo:App - Shopee Developer.png|App - Shopee Developer]]<br />
<br />
Depois basta selecionar o aplicativo ou criar um novo:<br />
<br />
<br><br />
<br><br />
<br />
[[Arquivo:New App - Shopee Developer.png|New App - Shopee Developer]]<br />
<br />
<br><br />
<br><br />
Ao criar um novo aplicativo, a URL de Callback (Redirect URL Domain) será essa: <ref>https://google.com</ref>.<br />
<br />
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 />
<br><br />
<br><br />
<br />
[[Arquivo:Credenciais - Shopee Developer.png|Credenciais - Shopee Developer]]<br />
<br />
== 2° Passo - Criar uma loja ==<br />
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 />
<br><br />
<br><br />
<br />
[[Arquivo:Loja - Shopee Developer.png|Loja - Shopee Developer]]<br />
<br />
<br />
== 3° Passo - Configuração no ERP ==<br />
<br />
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.<br />
<br />
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:<br />
[[Arquivo:Credenciais (Code) Part.1 - Shopee Developer.png|Credenciais (Code) Part.1 - Shopee Developer]]<br />
<br />
[[Arquivo:Credenciais (Code) Part.2 - Shopee Developer.png|Credenciais (Code) Part.2 - Shopee Developer]]<br />
<br />
[[Arquivo:Credenciais (Code) Part.3 - Shopee Developer.png|Credenciais (Code) Part.3 - Shopee Developer]]<br />
<br />
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'''<br />
[[Arquivo:Credenciais (Code) Part.4 - Shopee Developer.png|Credenciais (Code) Part.4 - Shopee Developer]]<br />
<br />
Após gerar o token de acesso temporário, basta clicar em '''Gerar Token Acesso''':<br />
[[Arquivo:Credenciais (Code) Part.5 - Shopee Developer.png|Credenciais (Code) Part.5 - Shopee Developer]]<br />
<br />
Com a mensagem o ecommerce está configurado corretamente. '''As credenciais de acesso é guardado em um XML na pasta do usuário (C:\Users\USUARIO\AppData\Local) no arquivo ApiConfig no nó <Shopee_Shop_PARTNER_ID>.'''<br />
<br />
== Acoplamento ==<br />
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'''.<br />
<br />
== Parâmetros ==<br />
'''UrlEcommerce:'''<br />
<br><br />
<br />
URL de homologação -> https://openplatform.sandbox.test-stable.shopee.sg<br />
<br><br />
<br />
URL de produção -> https://openplatform.shopee.com.br<br />
<br />
'''UrlAutorizacao:'''<br />
<br><br />
<br />
URL de homologação -> https://partner.test-stable.shopeemobile.com<br />
<br><br />
<br />
URL de produção -> https://openplatform.shopee.com.br<br />
<br />
<br />
'''PartnerId:''' Partner ID (Identificador do aplicativo da Shopee);<br />
<br />
'''PartnerKey:''' Partner Key (Chave Secreta do aplicativo da Shopee);<br />
<br />
'''ShopId:''' ID da Loja Shopee (ShopID);<br />
<br />
'''NumeroListaPrecoProdutos:''' Lista de Preços para realizar o envio dos produtos para o web service;<br />
<br />
'''EmpresaReceptora:''' Empresa em que o pedido será integrado.<br />
<br />
'''QtdeEstoque:''' Quantidade de estoque fixa a ser enviada. Se for zero ou vazio, enviará o estoque atual individual de cada produto.<br />
<br />
'''CodigoStatusPedido:''' Código de status do pedido (do e-commerce) a ser considerado na busca de dados (Ex.: READ_TO_SHIP);<br />
<br />
'''SituacaoCodigo:''' Código da situação padrão para a gravação dos pedidos;<br />
<br />
'''PortadorCodigo:''' Código do portador padrão para a gravação dos pedidos;<br />
<br />
'''TransportadoraCodigo:''' Código da transportadora padrão para a gravação dos pedidos;<br />
<br />
'''OpSaidaCodigo:''' Código da operação de saída padrão para a gravação dos pedidos;<br />
<br />
'''RepresentanteCodigo:''' Código do representante padrão para a gravação dos pedidos;<br />
<br />
'''TelevendasCodigo:''' Código do televendas padrão para a gravação dos pedidos;<br />
<br />
'''CaracteristicaCodigo:''' Código da característica de venda padrão para a gravação dos pedidos;<br />
<br />
'''DiasPrazoEntrega:''' Prazo de entrega padrão, a partir da emissão, para pedidos (quantidade de dias);<br />
<br />
'''TipoFrete:''' Tipo de frete;<br />
<br />
'''StatusCliente:''' Código do status de pessoa para clientes trazidos do e-commerce;<br />
<br />
'''RamoAtividadeCodigo:''' Código do ramo de atividade padrão para a gravação dos clientes;<br />
<br />
'''DefinirEnqFiscal:''' Define o enquadramento fiscal do cliente ao integrá-lo;<br />
<br />
'''FamiliasKit:''' Define quais famílias serão consideradas para kits na integração;<br />
<br />
'''CanaisVenda:''' Define quais serão os canais de venda dos produtos. Separar por vírgulas (Ex.: 91008, 91009);<br />
<br />
'''Classificacao:''' Classificação utilizada no adiantamento;<br />
<br />
'''Divisao:''' Divisão utilizada no adiantamento;<br />
<br />
'''CentroCusto:''' Centro de Custo utilizada no adiantamento;</div>Viniciushttps://wiki.dataplussistemas.com.br/index.php?title=Arquivo:Credenciais_(Code)_Part.5_-_Shopee_Developer.png&diff=15446Arquivo:Credenciais (Code) Part.5 - Shopee Developer.png2026-02-18T19:13:22Z<p>Vinicius: </p>
<hr />
<div>Credenciais (Code) Part.5 - Shopee Developer</div>Viniciushttps://wiki.dataplussistemas.com.br/index.php?title=Arquivo:Credenciais_(Code)_Part.4_-_Shopee_Developer.png&diff=15445Arquivo:Credenciais (Code) Part.4 - Shopee Developer.png2026-02-18T19:12:46Z<p>Vinicius: </p>
<hr />
<div>Credenciais (Code) Part.4 - Shopee Developer</div>Viniciushttps://wiki.dataplussistemas.com.br/index.php?title=Arquivo:Credenciais_(Code)_Part.3_-_Shopee_Developer.png&diff=15444Arquivo:Credenciais (Code) Part.3 - Shopee Developer.png2026-02-18T19:08:35Z<p>Vinicius: </p>
<hr />
<div>Credenciais (Code) Part.3 - Shopee Developer</div>Viniciushttps://wiki.dataplussistemas.com.br/index.php?title=Arquivo:Credenciais_(Code)_Part.2_-_Shopee_Developer.png&diff=15443Arquivo:Credenciais (Code) Part.2 - Shopee Developer.png2026-02-18T19:08:15Z<p>Vinicius: </p>
<hr />
<div>Credenciais (Code) Part.2 - Shopee Developer</div>Viniciushttps://wiki.dataplussistemas.com.br/index.php?title=Arquivo:Credenciais_(Code)_Part.1_-_Shopee_Developer.png&diff=15442Arquivo:Credenciais (Code) Part.1 - Shopee Developer.png2026-02-18T19:06:44Z<p>Vinicius: </p>
<hr />
<div>Credenciais (Code) Part.1 - Shopee Developer</div>Viniciushttps://wiki.dataplussistemas.com.br/index.php?title=Arquivo:Loja_-_Shopee_Developer.png&diff=15441Arquivo:Loja - Shopee Developer.png2026-02-18T18:55:44Z<p>Vinicius: </p>
<hr />
<div>Loja - Shopee Developer</div>Viniciushttps://wiki.dataplussistemas.com.br/index.php?title=Arquivo:Credenciais_-_Shopee_Developer.png&diff=15440Arquivo:Credenciais - Shopee Developer.png2026-02-18T18:51:55Z<p>Vinicius: </p>
<hr />
<div>Credenciais - Shopee Developer</div>Viniciushttps://wiki.dataplussistemas.com.br/index.php?title=Arquivo:New_App_-_Shopee_Developer.png&diff=15439Arquivo:New App - Shopee Developer.png2026-02-18T18:43:41Z<p>Vinicius: </p>
<hr />
<div>New App - Shopee Developer</div>Viniciushttps://wiki.dataplussistemas.com.br/index.php?title=Arquivo:App_-_Shopee_Developer.png&diff=15438Arquivo:App - Shopee Developer.png2026-02-18T18:42:36Z<p>Vinicius: </p>
<hr />
<div>App - Shopee Developer</div>Viniciushttps://wiki.dataplussistemas.com.br/index.php?title=Arquivo:Personal_Center_-_Shopee_Developer.png&diff=15437Arquivo:Personal Center - Shopee Developer.png2026-02-18T18:32:47Z<p>Vinicius: </p>
<hr />
<div>Personal Center - Shopee Developer</div>Viniciushttps://wiki.dataplussistemas.com.br/index.php?title=RN_Integracao_Shopee_v2&diff=15436RN Integracao Shopee v22026-02-18T18:30:07Z<p>Vinicius: </p>
<hr />
<div>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.<br />
<br />
Para a versão 2 da API da Shopee, foi incluído um novo processo de autenticação de usuário/aplicativo.<br />
<br />
== 1° Passo - Acessar Aplicativos ==<br />
<br />
Acessar Link:<br />
[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]<br />
<br />
Após acessar a conta, basta ir no Ícone de configurações -> Todas as configurações:<br />
[[Arquivo:Configurações Bling - Preferências.png|centro]]<br />
<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<br />
[[Arquivo:Configurações Bling - Cadastro de Aplicativos.png|centro]]<br />
<br />
Depois basta selecionar o aplicativo ou criar um novo:<br />
[[Arquivo:Configurações Bling - Aplicativos.png|centro]]<br />
<br />
Para criar um novo basta seguir as seguintes instruções: <ref>https://developer.bling.com.br/homologacao#inscri%C3%A7%C3%A3o</ref><br />
<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.<br />
<br />
Após a criação do aplicativo, você poderá obter as credenciais de acesso a API, como o ClientId e o ClientSecret:<br />
[[Arquivo:Configurações Bling - Credenciais de Acesso.png|centro]]<br />
<br />
== 2° Passo - Configuração no ERP ==<br />
<br />
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:<br />
[[Arquivo:Info configuração e-commerce ERP.png|centro]]<br />
<br />
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:<br />
[[Arquivo:Autorização Aplicativo E-commerce Bling - scopos.png|centro]]<br />
<br />
Basta selecionar autorizar logo abaixo:<br />
[[Arquivo:Autorização Aplicativo E-commerce Bling - Autorizar.png|centro]]<br />
<br />
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:<br />
[[Arquivo:Retorno webservice ecommerce.png|centro]]<br />
<br />
'''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.'''<br />
<br />
Após gerar o token de acesso temporário, basta clicar em '''Gerar Token Acesso''':<br />
[[Arquivo:Mensagem sucesso configuração ecommerce.png|centro]]<br />
<br />
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>.'''<br />
<br />
== Acoplamento ==<br />
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'''.<br />
<br />
== Parâmetros ==<br />
'''UrlEcommerce:''' Url do e-commerce https://api.bling.com.br/Api/v3;<br />
<br />
'''ClientId:''' Credencial ClientId do aplicativo;<br />
<br />
'''ClientSecret:''' Credencial ClientSecret do aplicativo;<br />
<br />
'''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><br />
Códigos verificados e possíveis para utilização: <br><br />
'''6''': em aberto<br><br />
'''9''': atendido<br><br />
'''12''': cancelado<br><br />
'''15''': em andamento<br><br />
'''18''': venda agenciada<br><br />
'''21''': em digitação<br><br />
'''24''': verificado <br />
<br />
<br />
'''SituacaoCodigo:''' Código da situação padrão para a gravação dos pedidos;<br />
<br />
'''PortadorCodigo:''' Código do portador padrão para a gravação dos pedidos;<br />
<br />
'''TransportadoraCodigo:''' Código da transportadora padrão para a gravação dos pedidos;<br />
<br />
'''OpSaidaCodigo:''' Código da operação de saída padrão para a gravação dos pedidos;<br />
<br />
'''RepresentanteCodigo:''' Código do representante padrão para a gravação dos pedidos;<br />
<br />
'''TelevendasCodigo:''' Código do televendas padrão para a gravação dos pedidos;<br />
<br />
'''CaracteristicaCodigo:''' Código da característica de venda padrão para a gravação dos pedidos;<br />
<br />
'''DiasPrazoEntrega:''' Prazo de entrega padrão, a partir da emissão, para pedidos (quantidade de dias);<br />
<br />
'''TipoFrete:''' Tipo de frete;<br />
<br />
'''StatusCliente:''' Código do status de pessoa para clientes trazidos do e-commerce;<br />
<br />
'''RamoAtividadeCodigo:''' Código do ramo de atividade padrão para a gravação dos clientes;<br />
<br />
'''DefinirEnqFiscal:''' Define o enquadramento fiscal do cliente ao integrá-lo;<br />
<br />
'''FamiliasKit:''' Define quais famílias serão consideradas para kits na integração;<br />
<br />
'''NumeroListaPrecoProdutos:''' Lista de Preços para realizar o envio dos produtos para o web service;<br />
<br />
'''IdsLojas:''' ID das lojas (separadas por ;), que são utilizadas em questão de preço de produto;<br />
<br />
'''PercentualLojas:''' Percentuais (separados por ;) a serem aplicados nos preços da lista de preços para cada loja (relacionado com IdsLojas);<br />
<br />
'''QtdeEstoque:''' Quantidade de estoque fixa a ser enviada. Se for zero ou vazio, enviará o estoque atual individual de cada produto.<br />
<br />
'''EmpresaReceptora:''' Empresa em que o pedido será integrado.<br />
<br />
'''DepositoId:''' Id do deposito para lançamento de estoque. Se 0 coleta o deposito padrão.</div>Viniciushttps://wiki.dataplussistemas.com.br/index.php?title=RN_Integracao_Shopee_v2&diff=15429RN Integracao Shopee v22026-02-18T12:50:59Z<p>Vinicius: Criou página com 'Regra de negócio do tipo habilitadora que pode ser acoplada ao DataPlus ERP e tem o objetivo configurar e manipular a integração entre API Bling na versão 3 e o DataPlusERP, podendo ser acessada pela tela de integração do sistema. Para a versão 3 da API da Bling, foi incluído um novo processo de autenticação de usuário/aplicativo. == 1° Passo - Acessar Aplicativos == Acessar Link: <ref>https://www.bling.com.br/login</ref> Após acessar a conta, basta...'</p>
<hr />
<div>Regra de negócio do tipo habilitadora que pode ser acoplada ao [[DataPlus ERP]] e tem o objetivo configurar e manipular a integração entre API Bling na versão 3 e o DataPlusERP, podendo ser acessada pela tela de integração do sistema.<br />
<br />
Para a versão 3 da API da Bling, foi incluído um novo processo de autenticação de usuário/aplicativo.<br />
<br />
== 1° Passo - Acessar Aplicativos ==<br />
<br />
Acessar Link:<br />
<ref>https://www.bling.com.br/login</ref><br />
<br />
Após acessar a conta, basta ir no Ícone de configurações -> Todas as configurações:<br />
[[Arquivo:Configurações Bling - Preferências.png|centro]]<br />
<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<br />
[[Arquivo:Configurações Bling - Cadastro de Aplicativos.png|centro]]<br />
<br />
Depois basta selecionar o aplicativo ou criar um novo:<br />
[[Arquivo:Configurações Bling - Aplicativos.png|centro]]<br />
<br />
Para criar um novo basta seguir as seguintes instruções: <ref>https://developer.bling.com.br/homologacao#inscri%C3%A7%C3%A3o</ref><br />
<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.<br />
<br />
Após a criação do aplicativo, você poderá obter as credenciais de acesso a API, como o ClientId e o ClientSecret:<br />
[[Arquivo:Configurações Bling - Credenciais de Acesso.png|centro]]<br />
<br />
== 2° Passo - Configuração no ERP ==<br />
<br />
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:<br />
[[Arquivo:Info configuração e-commerce ERP.png|centro]]<br />
<br />
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:<br />
[[Arquivo:Autorização Aplicativo E-commerce Bling - scopos.png|centro]]<br />
<br />
Basta selecionar autorizar logo abaixo:<br />
[[Arquivo:Autorização Aplicativo E-commerce Bling - Autorizar.png|centro]]<br />
<br />
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:<br />
[[Arquivo:Retorno webservice ecommerce.png|centro]]<br />
<br />
'''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.'''<br />
<br />
Após gerar o token de acesso temporário, basta clicar em '''Gerar Token Acesso''':<br />
[[Arquivo:Mensagem sucesso configuração ecommerce.png|centro]]<br />
<br />
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>.'''<br />
<br />
== Acoplamento ==<br />
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'''.<br />
<br />
== Parâmetros ==<br />
'''UrlEcommerce:''' Url do e-commerce https://api.bling.com.br/Api/v3;<br />
<br />
'''ClientId:''' Credencial ClientId do aplicativo;<br />
<br />
'''ClientSecret:''' Credencial ClientSecret do aplicativo;<br />
<br />
'''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><br />
Códigos verificados e possíveis para utilização: <br><br />
'''6''': em aberto<br><br />
'''9''': atendido<br><br />
'''12''': cancelado<br><br />
'''15''': em andamento<br><br />
'''18''': venda agenciada<br><br />
'''21''': em digitação<br><br />
'''24''': verificado <br />
<br />
<br />
'''SituacaoCodigo:''' Código da situação padrão para a gravação dos pedidos;<br />
<br />
'''PortadorCodigo:''' Código do portador padrão para a gravação dos pedidos;<br />
<br />
'''TransportadoraCodigo:''' Código da transportadora padrão para a gravação dos pedidos;<br />
<br />
'''OpSaidaCodigo:''' Código da operação de saída padrão para a gravação dos pedidos;<br />
<br />
'''RepresentanteCodigo:''' Código do representante padrão para a gravação dos pedidos;<br />
<br />
'''TelevendasCodigo:''' Código do televendas padrão para a gravação dos pedidos;<br />
<br />
'''CaracteristicaCodigo:''' Código da característica de venda padrão para a gravação dos pedidos;<br />
<br />
'''DiasPrazoEntrega:''' Prazo de entrega padrão, a partir da emissão, para pedidos (quantidade de dias);<br />
<br />
'''TipoFrete:''' Tipo de frete;<br />
<br />
'''StatusCliente:''' Código do status de pessoa para clientes trazidos do e-commerce;<br />
<br />
'''RamoAtividadeCodigo:''' Código do ramo de atividade padrão para a gravação dos clientes;<br />
<br />
'''DefinirEnqFiscal:''' Define o enquadramento fiscal do cliente ao integrá-lo;<br />
<br />
'''FamiliasKit:''' Define quais famílias serão consideradas para kits na integração;<br />
<br />
'''NumeroListaPrecoProdutos:''' Lista de Preços para realizar o envio dos produtos para o web service;<br />
<br />
'''IdsLojas:''' ID das lojas (separadas por ;), que são utilizadas em questão de preço de produto;<br />
<br />
'''PercentualLojas:''' Percentuais (separados por ;) a serem aplicados nos preços da lista de preços para cada loja (relacionado com IdsLojas);<br />
<br />
'''QtdeEstoque:''' Quantidade de estoque fixa a ser enviada. Se for zero ou vazio, enviará o estoque atual individual de cada produto.<br />
<br />
'''EmpresaReceptora:''' Empresa em que o pedido será integrado.<br />
<br />
'''DepositoId:''' Id do deposito para lançamento de estoque. Se 0 coleta o deposito padrão.</div>Viniciushttps://wiki.dataplussistemas.com.br/index.php?title=Layout_Requisi%C3%A7%C3%A3o_API&diff=15177Layout Requisição API2026-01-27T18:15:52Z<p>Vinicius: </p>
<hr />
<div>Página criada com o objetivo de auxiliar a criação dos layouts de requisições para as APIs.<br />
<br />
== O que é uma API? ==<br />
Por exemplo, imagine que você está usando um aplicativo de previsão do tempo em seu celular. Esse aplicativo precisa obter informações atualizadas sobre o clima de uma fonte confiável, como um serviço meteorológico. Em vez de criar seu próprio sistema para coletar esses dados, o aplicativo utiliza uma API fornecida pelo serviço meteorológico. A API fornece métodos (ou opções) para solicitar informações específicas sobre o clima, como a temperatura atual, a previsão para os próximos dias, etc. O aplicativo utiliza esses métodos para obter os dados de que precisa, como se estivesse fazendo um pedido no cardápio, e depois exibe essas informações para você.<br />
<br />
Em resumo, uma API é como um intermediário que permite que diferentes programas se comuniquem e compartilhem informações de maneira padronizada, tornando a integração entre sistemas mais fácil e eficiente. É como o cardápio que simplifica o processo de fazer pedidos em um restaurante.<br />
<br />
== Tipos de métodos das requisições ==<br />
GET: Solicita a recuperação de um recurso específico no servidor. É usado principalmente para recuperar informações, como visualizar uma página da web ou buscar dados.<br />
<br />
POST: Envia dados para o servidor para que ele processe ou armazene. Geralmente usado para enviar informações do usuário, como preenchimento de formulários online.<br />
<br />
PUT: Atualiza um recurso existente no servidor ou cria um novo se ele não existir. O conteúdo enviado no corpo da solicitação substitui completamente o recurso existente.<br />
<br />
PATCH: Similar ao PUT, mas usado para aplicar modificações parciais a um recurso. A solicitação contém apenas as alterações que devem ser aplicadas ao recurso existente.<br />
<br />
DELETE: Solicita a remoção de um recurso no servidor. Usado para excluir informações ou recursos específicos.<br />
<br />
Dentre esses métodos para as requisições, os mais utilizados no ERP são o '''GET''', '''POST''', '''PATCH''' e '''DELETE'''.<br />
<br />
== Seções ==<br />
O layouts das requisições contém 3 seções, sendo elas:<br />
<br />
'''''Cabeçalho:''''' identifica a seção onde serão coletados os dados necessários para que a requisição seja feita (nomenclatura utilizada pelo layout dos bancos para definir a seção);<br />
<br />
'''''Cabeçalho Grupo:''''' identifica a seção onde serão coletados os parâmetros necessários para que a requisição seja feita (nomenclatura utilizada pelo layout dos bancos para definir a seção);<br />
<br />
'''''Dados:''''' identifica a seção onde serão coletados os dados necessários para o corpo da requisição (nomenclatura utilizada pelo layout dos bancos para definir a seção);<br />
<br />
== Entendendo a estrutura de envio da requisição ==<br />
A estrutura de envio de requisições de uma API é chamada de '''CURL''', sendo uma das mais utilizadas, sua estrutura é a seguinte:<br />
[[Arquivo:Estrutura curl.png|centro]]<br />
<br />
A primeira linha indica o método utilizado na requisição, que neste caso é POST. Esse método é usado quando se deseja registrar ou inserir informações no servidor, ou seja, enviar novos dados.<br />
<br />
A segunda linha mostra o endereço (URL) da requisição. Esse link é dividido da seguinte forma:<br />
<br />
https://api.sandbox.bb.com.br/cobrancas/v2<br />
<br />
/boletos → representa o serviço que está sendo utilizado. Cada API possui suas próprias rotas (ou serviços). Por exemplo, uma instituição de ensino, ao clicar em “fazer login”, utilizaria a rota /login. Uma mesma API pode conter várias rotas, cada uma com uma finalidade diferente.<br />
<br />
?gw-dev-app-key=e85f6f4c238ad52eaeb9cf39dd4777e → é a chave da aplicação, usada para autenticar a requisição e identificar o sistema que está acessando a API.<br />
<br />
Nas requisições do tipo POST, normalmente o conteúdo principal é enviado no corpo da requisição, e a URL costuma ser mais simples. Já em requisições do tipo GET, as informações são enviadas diretamente na URL.<br />
<br />
Por exemplo:<br />
https://api.sandbox.bb.com.br/cobrancas/v2/boletos?gw-dev-app-key=e85f6f4c238ad52eaeb9cf39dd4777e&indicadorSituacao=A&agenciaBeneficiario=452&contaBeneficiario=123873<br />
<br />
Após a chave do aplicativo (?gw-dev-app-key=...), os demais valores são separados pelo &. Esses valores funcionam como parâmetros ou filtros da requisição. No exemplo acima, estamos solicitando as cobranças com indicador de situação igual a A, pertencentes à agência 452 e conta 123873.<br />
<br />
A terceira linha da requisição indica o tipo de retorno aceito pela aplicação, definido por meio do cabeçalho:<br />
-H 'accept: application/json'<br />
Isso informa à API que o sistema (ERP) espera receber os dados de resposta em formato JSON, para que possa tratá-los corretamente.<br />
<br />
A quarta linha mostra o campo Authorization, que é responsável por autenticar o acesso ao servidor:<br />
-H 'Authorization: Bearer [token]'<br />
Esse token tem um tempo de validade limitado (no caso do Banco do Brasil, cerca de 10 minutos). Após esse tempo, é necessário gerar um novo token, mas o próprio ERP faz esse processo automaticamente.<br />
<br />
A quinta linha define o tipo de conteúdo que está sendo enviado à API:<br />
-H 'Content-Type: application/json'<br />
Isso indica que os dados estão sendo enviados em formato JSON, o padrão mais utilizado para comunicação entre sistemas.<br />
<br />
As demais linhas representam o corpo da requisição, que contém todas as informações a serem enviadas ao servidor. No caso da API de boletos, o corpo inclui dados como o número do convênio, número da carteira, data de emissão, data de vencimento, valores, descontos, entre outros campos obrigatórios exigidos pela API.<br />
<br />
O corpo é utilizado principalmente em requisições do tipo POST, PATCH e DELETE. Já no método GET, as informações são enviadas apenas na URL, e não existe corpo na requisição.<br />
<br />
== Layouts ==<br />
Para a criação dos layouts de envio de requisição, você pode encontrar no ERP nas seguintes abas: '''Finanças->Layouts de Envio Online'''<br />
<br />
Os primeiros passos é criar a seção cabecalho. Ao adicionar a seção cabeçalho será adicionado os valores necessários para a requisição, basta preencher:<br />
[[Arquivo:Secao cabecalho registro v2.png|centro]]<br />
<br />
Os valores são preenchidos da seguinte maneira (Esses valores são essenciais para todos os layouts de envio):<br />
<br />
'''End-Point''' - é o link em que a requisição será feita;<br />
<br />
'''Requisição''' - é o serviço a ser utilizado;<br />
<br />
'''Authorization''' – é o meio de autenticação exigido pela API para a realização das requisições.<br />
No caso do Banco do Brasil, é necessário enviar o client-id e o client-secret codificados em Base64.<br />
<br />
O valor desse campo é composto por três partes, separadas por ponto e vírgula (;):<br />
<br />
Primeiro valor: indica se as credenciais devem ser convertidas em Base64 (True ou False).<br />
<br />
Segundo valor: representa a chave do cabeçalho (Header) utilizada na requisição, geralmente Authorization.<br />
<br />
Terceiro valor: define o tipo do token (token type), normalmente Bearer.<br />
<br />
Exemplos:<br />
<br />
Banco do Brasil e Bradesco: True;Authorization;Bearer<br />
<br />
Itaú: False;Authorization;Bearer<br />
<br />
<br />
'''Url-OAuth''' - é o link em que a requisição será autenticada, ou seja, é o link em que será coletado um novo token (Authorization);<br />
<br />
'''Client-Id e Client-Secret''' - São as chaves que são utilizadas para obter o token (Authorization) quando a API não fornece o token;<br />
<br />
'''Scopos''' - É a identificação de quais serviços serão utilizados, esses valores são de uso interno da API;<br />
<br />
'''Chave-Aplicativo''' - é a chave que será utilizada indicando qual o aplicativo que está fazendo a requisição;<br />
<br />
'''Ident-Banco-Conta''' - é a identificação do código do banco do ERP + o número da conta, esse campo se faz necessário para a guarda das credenciais no XML de configuração.<br />
<br />
É possível definir no layout qual será o método de envio utilizado na requisição.<br />
Esse método indica de que forma os dados serão transmitidos para a API — por exemplo, GET, POST, PUT, PATCH ou DELETE.<br />
Cada método possui uma finalidade específica, como consulta, inserção, atualização ou exclusão de informações.<br />
<br />
[[Arquivo:Método de envio layout API.png|centro]]<br />
<br />
Também é possível definir se o JSON será montado com valores vazios.<br />
Quando essa opção estiver marcada, os campos vazios serão incluídos normalmente na estrutura do JSON.<br />
Caso esteja desmarcada, o campo correspondente será desconsiderado durante a montagem da requisição.<br />
<br />
[[Arquivo:Permitir valores vazios layout API.png|centro]]<br />
<br />
== Layout de Registro de Cobrança ==<br />
Ao criar o layout de registro de cobranças, você vai precisar da seção Dados, que será utilizada para montar o corpo da requisição, ela é criada da seguinte maneira:<br />
[[Arquivo:Estrutura Layout.png|centro]]<br />
<br />
Para criar os elementos, você pode utilizar Textos, Formulas e Campos. Como comentando anteriormente a estrutura do envio da requisição da API é formada da seguinte maneira:<br />
[[Arquivo:Estrutura curl exemplo.png|centro]]<br />
<br />
Ou seja, ao inserir os valores na seção dados, na coluna '''Descrição''', vai ser informado, por exemplo, '''numeroTituloCliente''' e na coluna '''Valor''' vai ser informado o valor que vier depois dos dois pontos, no caso '''00031285570000030000''', o mesmo para mensagem de bloqueto, na coluna '''Descrição''', vai ser informado '''mensagemBloquetoOcorrencia''' e na coluna '''Valor''' vai ser informado '''Outro Texto'''.<br />
<br />
Já no caso do Desconto, pode-se perceber que ele possui valores filhos (tipo, dataExpiracao, porcentagem e valor). Eles são um caso especial, para ser criado o corpo do desconto, se utiliza a mesma maneira do exemplo anterior, porém, será necessário selecionar o '''Tipo dos Dados''' como '''Array''' ou '''Objeto'''.<br />
<br />
'''Tipo Objeto:'''<br />
desconto {<br />
tipo: 1,<br />
dataExpiracao: "30.01.2024",<br />
porcentagem: 0,<br />
valor: 12.34<br />
}<br />
<br />
'''Tipo Array'''<br />
desconto [<br />
{<br />
tipo: 1,<br />
dataExpiracao: "30.01.2024",<br />
porcentagem: 0,<br />
valor: 12.34<br />
},<br />
{<br />
tipo: 1,<br />
dataExpiracao: "30.01.2024",<br />
porcentagem: 0,<br />
valor: 12.34<br />
}<br />
]<br />
<br />
O tipo '''Array''' é um coleção, podendo ter muitos '''objetos''' dentro dele<br />
<br />
Exemplo utilização campo pai:<br />
<br />
desconto {<br />
'valor':1.00, (Campo pai = desconto)<br />
'vencimento':01.01.0001 (Campo <br />
pai = desconto)<br />
}<br />
<br />
Para as formatações de datas ou valores, basta utilizar as colunas '''Decimais''' e '''Mascara'''. Algo que vale ressaltar é que os campos e valores não precisam ser montados na sequência (exceto os campos que são aninhados, Ex: desconto), porém, o ideal é que seja em sequência, para evitar quaisquer transtornos.<br />
<br />
== Layout de Consulta de Cobranças ==<br />
Como citado anteriormente, as consultas com o método '''GET''', não possuem corpo, mas possuem parâmetros, e esses parâmetros são informados na seção '''cabecalhoGrupo''':<br />
[[Arquivo:Secao cabecalho grupo consulta.png|centro]]<br />
<br />
A criação segue o mesmo padrão do corpo do layout de registro de cobrança.<br />
Na coluna “Descrição” deve ser informado o nome do campo, e na coluna “Valor” o valor que será atribuído ao filtro (parâmetro).<br />
<br />
É importante observar que alguns parâmetros são obrigatórios, mas isso varia conforme a API utilizada — portanto, é necessário consultar a documentação oficial de cada API para verificar quais campos são exigidos.<br />
<br />
As linhas 11 e 12 representam filtros opcionais, geralmente utilizados em formulários com filtros por período.<br />
Para utilizá-los, basta informar:<br />
<br />
dataini- + nome do campo → indica a data inicial que será filtrada;<br />
<br />
datafim- + nome do campo → indica a data final que será filtrada.<br />
<br />
Na coluna “Valor”, deve ser informada a máscara de data aceita pela API.<br />
<br />
Filtros como dataini- e datafim- são automaticamente substituídos pelas datas informadas no formulário durante a montagem da requisição.<br />
Esses indicadores também podem ser incluídos no JSON que fica na seção “Dados”.<br />
<br />
== Layouts de Retorno ==<br />
Para qualquer tipo de API, toda requisição feita é obtido um retorno, seja com uma mensagem de sucesso, ou com uma estrutura parecida com a do CURL, cada API tem sua particularidade.<br />
<br />
E para isso é preciso criar os layouts que receberão esse retorno. Esses layouts as vezes trabalharão em conjunto com os layouts de envio ou individualmente. Ao criar um layout do tipo retorno, será adicionado duas classes relacionadas, RetornoReqAPI e RetornoReqAPIItens. A montagem é semelhante a do arquivo, com a diferença de que no arquivo é preciso informar a posição do campo.<br />
<br />
Para criar um layout de retorno você deve ir em '''Finanças->Layouts de Retorno Online'''.<br />
<br />
== Layout de Retorno de Consulta de Cobranças ==<br />
Como citado alguns layouts trabalham em conjunto com os layouts de envio, no caso desse exemplo, irei utilizar um layout que trabalha em conjunto com o layout de consulta de diversas cobranças.<br />
<br />
A estrutura desse tipo de layout é mais flexível, ou seja, ela não fica presa igual ao corpo que é preciso ser montado no registro da cobrança. Porém é preciso algumas configurações essências para o fluxo:<br />
[[Arquivo:Secao cabecalho1 retorno consulta atualizado.png|centro]]<br />
<br />
Para que o fluxo funcione corretamente em alguns casos, como nesse layout exemplo ele trabalha em conjunto com a consulta de diversas cobranças, é preciso informar o '''proximoIndice''' da pesquisa, no caso do banco do brasil para cada consulta é coletado 300 cobranças, então é preciso guardar o esse valor para que a próxima consulta seja a partir do index 300. Então na coluna '''Valor''' você deverá informar o nome do campo que guarda esse valor no retorno.<br />
<br />
[[Arquivo:Secao cabecalho2 retorno consulta atualizado.png|centro]]<br />
Na segunda seção vai o nó (campo) que contém as cobranças, você não precisa criar uma nova seção, poderia ser no mesmo lugar, mas eu criei por questões de organização. Então, nessa segunda seção vai o nó (campo) que contém as cobranças, Ex:<br />
[[Arquivo:Retorno requisição cobranças diversas.png|centro]]<br />
Na coluna '''Valor''' você deve informar o nome do campo.<br />
<br />
[[Arquivo:Secao Dados retorno consulta atualizado.png|centro]]<br />
<br />
Na seção “Dados”, devem ser informados os valores de retorno que serão coletados para uso dentro do ERP.<br />
Na coluna “Descrição”, deve ser indicado o campo da classe que receberá o valor, e na coluna “Valor”, o nome do campo retornado pela API que contém esse dado.<br />
<br />
Para permitir o reaproveitamento do layout de retorno, há situações em que o mesmo layout é utilizado em diferentes cenários.<br />
Nesses casos, alguns campos podem se repetir, conforme o exemplo abaixo:<br />
<br />
O campo RetornoReqAPIItens->CodEstadoTituloCobranca pode, em uma requisição, receber o valor retornado pela API como '''codigoEstadoTituloCobranca''', enquanto em outro recurso a API pode retornar '''codEstadoCobranca'''.<br />
<br />
Quando isso ocorre, o layout mantém o primeiro valor encontrado.<br />
Ou seja, se o campo '''codigoEstadoTituloCobranca''' for retornado e preencher o campo correspondente no ERP, e em seguida a API também retornar '''codEstadoCobranca''', o layout não substituirá o valor já atribuído.<br />
<br />
== Layout de Retorno para Tratamento de Erros ==<br />
O layout de tratamento de erro é essencial quando o assunto é retorno da requisição, pois como citado anteriormente eles podem trabalhar em conjunto com os layouts de envio, como também individual, e muita das vezes esses retorno são de erros, e erros de API's são muitos genéricos, Exemplo:<br />
<br />
Requisições HTTPs, sejam elas de envio ou os próprios retorno, retornam um código:<br />
<br />
Códigos com o valor >= 200 dizem que a requisição foi um sucesso<br />
<br />
Códigos com o valor >= 300 dizem que a requisição foi redirecionada para outro lugar, ou seja, suponhamos que eu faça a requisição no end-point '''https:/api.sandbox.bb.com.br/cobrancas/v2''', e esse end-point não existe mais, a aplicação automaticamente me encaminhara para outro end-point configurado no servidor da API<br />
<br />
Códigos com o valor >= 400 dizem que a requisição obteve um erro, porém esse erro foi do lado de quem solicitou, seja por um campo informado incorretamente.<br />
<br />
Códigos com o valor >= 500 dizem que houve um erro na requisição, mas do lado do servidor, seja por estar fora do ar, ou algum evento não tratado pela própria API.<br />
<br />
E então esse layout de tratamento de erro, ficará encarregado de tratar esse retorno, no caso do registro da cobrança o ERP primeiro faz uma consulta na API com o nosso número do boleto, e como a cobrança ainda não existe no servidor do banco do brasil, é retornado um erro, dizendo que o nosso número da cobrança foi informado incorretamente, e de fato esse erro faz sentido, pois como eu estou tentando registrar uma cobrança ela ainda não existe, mas essa consulta também é essencial pois ela busca primeiro se a cobrança existe para não ocorrer o caso de duplicidade. E esse erro retornado é o código 400, pode ser que o usuário deixou de informar também o valor da cobrança, isso resultaria em um erro de código 400, então pra isso foi preciso criar os layouts de tratamento de erro.<br />
<br />
[[Arquivo:Secao cabecalho tratamento erro.png|centro]]<br />
<br />
Na primeira seção (cabecalho) vai ser informado o nó (campo) pai do retorno, Ex:<br />
<br />
[[Arquivo:Corpo erro.png|centro]]<br />
Porém, esses nós (campos) pai retornado nem sempre tem o mesmo nome, no caso é '''erros''', mas alguns erros também retornam '''errors''', '''erro''' no singular, então é preciso que no cabeçalho seja colocado todas as variações separadas por virgula, exemplo: '''erros,errors,erro'''<br />
<br />
[[Arquivo:Secao cabecalho grupo tratamento erro.png|centro]]<br />
No cabecalhoGrupo é preciso informar o código do erro, como citado anteriormente os erros são muitos genéricos, mas para que os erros sejam identificados, cada um tem um código, no caso da consulta da cobrança antes de registrar ela, é consulta e o erro retornado é o código '''4678420.1''', nota-se que esse código está sendo informado no cabecalhoGrupo, ou seja, quando o retorno da requisição conter esse código no erro, a aplicação não será parada, por que esse retorno era o esperado, para encontrar esses código de erros na documentação do banco do brasil:<br />
<br />
[[Arquivo:Documentação erros.png|centro]]<br />
[[Arquivo:Documentação codigo erros.png|centro]]<br />
Na imagem acima é possível visualizar todos os códigos de erros que podem acontecer, então todos os código que serão previstos, devem ser adicionados no cabecalhoGrupo.<br />
<br />
[[Arquivo:Secao dados tratamento erro.png|centro]]<br />
Na seção Dados, é preciso informar os nome dos campos que contém o código do erro e a mensagem, isso é essencial para erros que não são previstos, e segue a mesma lógica do cabecalho, como o retorno é genérico, pode ser retornado o nó (campo) pai com os nomes '''erros,errors,erro''' e a mensagem como '''mensagem,message'''.<br />
<br />
== Informar Layouts na Conta ==<br />
[[Arquivo:Conta cadastro dos layouts.png|centro]]<br />
Para informar os layouts criados, é preciso entrar no cadastro das contas na aba Cobrança API, ali você pode informar todos os layouts.<br />
<br />
== Valores de Acoplamento ==<br />
Para poder informar os valores de acoplamentos corretamente, aqui está alguns exemplos:<br />
[[Arquivo:Valores acoplados.png|centro]]<br />
<br />
Como citado anteriormente, caso a API forneça uma Authorization deve ser informada, já para as linha '''Client-Id''' e '''Client-Secret''' você deve informar os valores que a API fornece, para a chave do aplicativo já é um pouco diferente, pois para o banco do brasil em especifico, eles pedem que seja informado o valor '''gw-dev-app-key=sua_chave''', e como cada API tem seu estilo de nomeclatura, é necessário informar antes do '''gw-dev-app-key=''' o sinal de "?", mas isso pode ser preciso somente para a API do banco do brasil, talvez outras API's tratam isso de uma forma diferente.<br />
<br />
== Parametrização das Ocorrência Bancária ==<br />
Para parametrizar as ocorrências bancárias referentes as requisições por meio da API, segue a imagem abaixo:<br />
[[Arquivo:Parametrizacao Banco API atualizado.png|centro]]<br />
<br />
A nova coluna Cod.Api indica uma relação do código de retorno por arquivo com o retorno da API<br />
<br />
O tipo de ação de envio de cobrança por API permanece sendo o '''Envio_Cobranca_Api''', aonde por sua vez pode ser parametrizado com qualquer código, o motivo de ter essa ação é pelo fato de que no modo convencional de gerar as cobranças pela remessa de arquivo não criava o '''Nosso Número''', e sim somente na impressão do boleto. Como para registro de cobranças por meio da API é obrigatório o envio do '''Nosso Número''' ele é gerado assim que é gravada a remessa online, como o tipo de ação '''Envio_Cobranca_Api'''.<br />
<br />
== Formulas ==<br />
No caso do Banco do Brasil é preciso que o nosso número contenha 20 caracteres no total, sendo 7 deles o número do convênio e 10 de controle (que seria o nosso número da cobrança no ERP) e zeros a esquerda para preencher os 20 caracteres, ficando assim: 00031285570001798547, aqui está uma formula que monta esse valor.<br />
<br />
'''Nosso Número Banco do Brasil:''' NrParaTexto([[ConcatenarValores([numeroConvenio], , [[NrParaTexto({Cobranca.NossoNumero}, 10, False, 0, False)]], , , , )]], 20, False, 0, False)<br />
<br />
== Filtros Adicionais ==<br />
Cabeçalhos adicionais podem ser incluídos adicionando novos elementos na seção<br />
de cabeçalho. Devem ser adicionais de acordo com as exigências da API.<br />
<br />
'''Nome Tag''' deve ser usada quando houver tags com o mesmo nome sendo do tipo <br />
VrAcopl, por exemplo desconto e juros que possuem uma tag filha chamada 'tipo'.<br />
Se não preenchida, será usada a coluna de identificação/descrição.<br />
<br />
Filtro de Datas<br />
dataini-nome_do_campo<br />
datafim-nome_do_campo<br />
periodo-nome_do_campo<br />
Filtro de consulta<br />
pagina-nome_do_campo<br />
situacao-nome_do_campo<br />
<br />
Ultima atualização em 12/11/2025</div>Viniciushttps://wiki.dataplussistemas.com.br/index.php?title=RN_NotaFiscal_NFe_Confirmacao&diff=14922RN NotaFiscal NFe Confirmacao2025-12-12T12:35:21Z<p>Vinicius: </p>
<hr />
<div>Regra de Negócio do tipo Restrição que pode ser acoplada ao [[DataPlus ERP]] e tem por objetivo solicitar confirmação de envio da NFe.<br />
<br />
== Acoplamento==<br />
Essa regra de negócio deve ser acoplada à classe '''FrmMovNotaFiscal''' e '''frmMovVendaRapida'''. Ela está preparada para funcionar em conjunto com o elemento '''Gravar''', designador '''Execução''', tempo de execução '''Antes'''.</div>Viniciushttps://wiki.dataplussistemas.com.br/index.php?title=Layout_Requisi%C3%A7%C3%A3o_API&diff=14663Layout Requisição API2025-11-12T13:16:39Z<p>Vinicius: </p>
<hr />
<div>Página criada com o objetivo de auxiliar a criação dos layouts de requisições para as APIs.<br />
<br />
== O que é uma API? ==<br />
Por exemplo, imagine que você está usando um aplicativo de previsão do tempo em seu celular. Esse aplicativo precisa obter informações atualizadas sobre o clima de uma fonte confiável, como um serviço meteorológico. Em vez de criar seu próprio sistema para coletar esses dados, o aplicativo utiliza uma API fornecida pelo serviço meteorológico. A API fornece métodos (ou opções) para solicitar informações específicas sobre o clima, como a temperatura atual, a previsão para os próximos dias, etc. O aplicativo utiliza esses métodos para obter os dados de que precisa, como se estivesse fazendo um pedido no cardápio, e depois exibe essas informações para você.<br />
<br />
Em resumo, uma API é como um intermediário que permite que diferentes programas se comuniquem e compartilhem informações de maneira padronizada, tornando a integração entre sistemas mais fácil e eficiente. É como o cardápio que simplifica o processo de fazer pedidos em um restaurante.<br />
<br />
== Tipos de métodos das requisições ==<br />
GET: Solicita a recuperação de um recurso específico no servidor. É usado principalmente para recuperar informações, como visualizar uma página da web ou buscar dados.<br />
<br />
POST: Envia dados para o servidor para que ele processe ou armazene. Geralmente usado para enviar informações do usuário, como preenchimento de formulários online.<br />
<br />
PUT: Atualiza um recurso existente no servidor ou cria um novo se ele não existir. O conteúdo enviado no corpo da solicitação substitui completamente o recurso existente.<br />
<br />
PATCH: Similar ao PUT, mas usado para aplicar modificações parciais a um recurso. A solicitação contém apenas as alterações que devem ser aplicadas ao recurso existente.<br />
<br />
DELETE: Solicita a remoção de um recurso no servidor. Usado para excluir informações ou recursos específicos.<br />
<br />
Dentre esses métodos para as requisições, os mais utilizados no ERP são o '''GET''', '''POST''', '''PATCH''' e '''DELETE'''.<br />
<br />
== Seções ==<br />
O layouts das requisições contém 3 seções, sendo elas:<br />
<br />
'''''Cabeçalho:''''' identifica a seção onde serão coletados os dados necessários para que a requisição seja feita (nomenclatura utilizada pelo layout dos bancos para definir a seção);<br />
<br />
'''''Cabeçalho Grupo:''''' identifica a seção onde serão coletados os parâmetros necessários para que a requisição seja feita (nomenclatura utilizada pelo layout dos bancos para definir a seção);<br />
<br />
'''''Dados:''''' identifica a seção onde serão coletados os dados necessários para o corpo da requisição (nomenclatura utilizada pelo layout dos bancos para definir a seção);<br />
<br />
== Entendendo a estrutura de envio da requisição ==<br />
A estrutura de envio de requisições de uma API é chamada de '''CURL''', sendo uma das mais utilizadas, sua estrutura é a seguinte:<br />
[[Arquivo:Estrutura curl.png|centro]]<br />
<br />
A primeira linha indica o método utilizado na requisição, que neste caso é POST. Esse método é usado quando se deseja registrar ou inserir informações no servidor, ou seja, enviar novos dados.<br />
<br />
A segunda linha mostra o endereço (URL) da requisição. Esse link é dividido da seguinte forma:<br />
<br />
https://api.sandbox.bb.com.br/cobrancas/v2<br />
<br />
/boletos → representa o serviço que está sendo utilizado. Cada API possui suas próprias rotas (ou serviços). Por exemplo, uma instituição de ensino, ao clicar em “fazer login”, utilizaria a rota /login. Uma mesma API pode conter várias rotas, cada uma com uma finalidade diferente.<br />
<br />
?gw-dev-app-key=e85f6f4c238ad52eaeb9cf39dd4777e → é a chave da aplicação, usada para autenticar a requisição e identificar o sistema que está acessando a API.<br />
<br />
Nas requisições do tipo POST, normalmente o conteúdo principal é enviado no corpo da requisição, e a URL costuma ser mais simples. Já em requisições do tipo GET, as informações são enviadas diretamente na URL.<br />
<br />
Por exemplo:<br />
https://api.sandbox.bb.com.br/cobrancas/v2/boletos?gw-dev-app-key=e85f6f4c238ad52eaeb9cf39dd4777e&indicadorSituacao=A&agenciaBeneficiario=452&contaBeneficiario=123873<br />
<br />
Após a chave do aplicativo (?gw-dev-app-key=...), os demais valores são separados pelo &. Esses valores funcionam como parâmetros ou filtros da requisição. No exemplo acima, estamos solicitando as cobranças com indicador de situação igual a A, pertencentes à agência 452 e conta 123873.<br />
<br />
A terceira linha da requisição indica o tipo de retorno aceito pela aplicação, definido por meio do cabeçalho:<br />
-H 'accept: application/json'<br />
Isso informa à API que o sistema (ERP) espera receber os dados de resposta em formato JSON, para que possa tratá-los corretamente.<br />
<br />
A quarta linha mostra o campo Authorization, que é responsável por autenticar o acesso ao servidor:<br />
-H 'Authorization: Bearer [token]'<br />
Esse token tem um tempo de validade limitado (no caso do Banco do Brasil, cerca de 10 minutos). Após esse tempo, é necessário gerar um novo token, mas o próprio ERP faz esse processo automaticamente.<br />
<br />
A quinta linha define o tipo de conteúdo que está sendo enviado à API:<br />
-H 'Content-Type: application/json'<br />
Isso indica que os dados estão sendo enviados em formato JSON, o padrão mais utilizado para comunicação entre sistemas.<br />
<br />
As demais linhas representam o corpo da requisição, que contém todas as informações a serem enviadas ao servidor. No caso da API de boletos, o corpo inclui dados como o número do convênio, número da carteira, data de emissão, data de vencimento, valores, descontos, entre outros campos obrigatórios exigidos pela API.<br />
<br />
O corpo é utilizado principalmente em requisições do tipo POST, PATCH e DELETE. Já no método GET, as informações são enviadas apenas na URL, e não existe corpo na requisição.<br />
<br />
== Layouts ==<br />
Para a criação dos layouts de envio de requisição, você pode encontrar no ERP nas seguintes abas: '''Finanças->Layouts de Envio Online'''<br />
<br />
Os primeiros passos é criar a seção cabecalho. Ao adicionar a seção cabeçalho será adicionado os valores necessários para a requisição, basta preencher:<br />
[[Arquivo:Secao cabecalho registro v2.png|centro]]<br />
<br />
Os valores são preenchidos da seguinte maneira (Esses valores são essenciais para todos os layouts de envio):<br />
<br />
'''End-Point''' - é o link em que a requisição será feita;<br />
<br />
'''Requisição''' - é o serviço a ser utilizado;<br />
<br />
'''Authorization''' – é o meio de autenticação exigido pela API para a realização das requisições.<br />
No caso do Banco do Brasil, é necessário enviar o client-id e o client-secret codificados em Base64.<br />
<br />
O valor desse campo é composto por três partes, separadas por ponto e vírgula (;):<br />
<br />
Primeiro valor: indica se as credenciais devem ser convertidas em Base64 (True ou False).<br />
<br />
Segundo valor: representa a chave do cabeçalho (Header) utilizada na requisição, geralmente Authorization.<br />
<br />
Terceiro valor: define o tipo do token (token type), normalmente Bearer.<br />
<br />
Exemplos:<br />
<br />
Banco do Brasil: True;Authorization;Bearer<br />
<br />
Itaú: False;Authorization;Bearer<br />
<br />
<br />
'''Url-OAuth''' - é o link em que a requisição será autenticada, ou seja, é o link em que será coletado um novo token (Authorization);<br />
<br />
'''Client-Id e Client-Secret''' - São as chaves que são utilizadas para obter o token (Authorization) quando a API não fornece o token;<br />
<br />
'''Scopos''' - É a identificação de quais serviços serão utilizados, esses valores são de uso interno da API;<br />
<br />
'''Chave-Aplicativo''' - é a chave que será utilizada indicando qual o aplicativo que está fazendo a requisição;<br />
<br />
'''Ident-Banco-Conta''' - é a identificação do código do banco do ERP + o número da conta, esse campo se faz necessário para a guarda das credenciais no XML de configuração.<br />
<br />
É possível definir no layout qual será o método de envio utilizado na requisição.<br />
Esse método indica de que forma os dados serão transmitidos para a API — por exemplo, GET, POST, PUT, PATCH ou DELETE.<br />
Cada método possui uma finalidade específica, como consulta, inserção, atualização ou exclusão de informações.<br />
<br />
[[Arquivo:Método de envio layout API.png|centro]]<br />
<br />
Também é possível definir se o JSON será montado com valores vazios.<br />
Quando essa opção estiver marcada, os campos vazios serão incluídos normalmente na estrutura do JSON.<br />
Caso esteja desmarcada, o campo correspondente será desconsiderado durante a montagem da requisição.<br />
<br />
[[Arquivo:Permitir valores vazios layout API.png|centro]]<br />
<br />
== Layout de Registro de Cobrança ==<br />
Ao criar o layout de registro de cobranças, você vai precisar da seção Dados, que será utilizada para montar o corpo da requisição, ela é criada da seguinte maneira:<br />
[[Arquivo:Estrutura Layout.png|centro]]<br />
<br />
Para criar os elementos, você pode utilizar Textos, Formulas e Campos. Como comentando anteriormente a estrutura do envio da requisição da API é formada da seguinte maneira:<br />
[[Arquivo:Estrutura curl exemplo.png|centro]]<br />
<br />
Ou seja, ao inserir os valores na seção dados, na coluna '''Descrição''', vai ser informado, por exemplo, '''numeroTituloCliente''' e na coluna '''Valor''' vai ser informado o valor que vier depois dos dois pontos, no caso '''00031285570000030000''', o mesmo para mensagem de bloqueto, na coluna '''Descrição''', vai ser informado '''mensagemBloquetoOcorrencia''' e na coluna '''Valor''' vai ser informado '''Outro Texto'''.<br />
<br />
Já no caso do Desconto, pode-se perceber que ele possui valores filhos (tipo, dataExpiracao, porcentagem e valor). Eles são um caso especial, para ser criado o corpo do desconto, se utiliza a mesma maneira do exemplo anterior, porém, será necessário selecionar o '''Tipo dos Dados''' como '''Array''' ou '''Objeto'''.<br />
<br />
'''Tipo Objeto:'''<br />
desconto {<br />
tipo: 1,<br />
dataExpiracao: "30.01.2024",<br />
porcentagem: 0,<br />
valor: 12.34<br />
}<br />
<br />
'''Tipo Array'''<br />
desconto [<br />
{<br />
tipo: 1,<br />
dataExpiracao: "30.01.2024",<br />
porcentagem: 0,<br />
valor: 12.34<br />
},<br />
{<br />
tipo: 1,<br />
dataExpiracao: "30.01.2024",<br />
porcentagem: 0,<br />
valor: 12.34<br />
}<br />
]<br />
<br />
O tipo '''Array''' é um coleção, podendo ter muitos '''objetos''' dentro dele<br />
<br />
Exemplo utilização campo pai:<br />
<br />
desconto {<br />
'valor':1.00, (Campo pai = desconto)<br />
'vencimento':01.01.0001 (Campo <br />
pai = desconto)<br />
}<br />
<br />
Para as formatações de datas ou valores, basta utilizar as colunas '''Decimais''' e '''Mascara'''. Algo que vale ressaltar é que os campos e valores não precisam ser montados na sequência (exceto os campos que são aninhados, Ex: desconto), porém, o ideal é que seja em sequência, para evitar quaisquer transtornos.<br />
<br />
== Layout de Consulta de Cobranças ==<br />
Como citado anteriormente, as consultas com o método '''GET''', não possuem corpo, mas possuem parâmetros, e esses parâmetros são informados na seção '''cabecalhoGrupo''':<br />
[[Arquivo:Secao cabecalho grupo consulta.png|centro]]<br />
<br />
A criação segue o mesmo padrão do corpo do layout de registro de cobrança.<br />
Na coluna “Descrição” deve ser informado o nome do campo, e na coluna “Valor” o valor que será atribuído ao filtro (parâmetro).<br />
<br />
É importante observar que alguns parâmetros são obrigatórios, mas isso varia conforme a API utilizada — portanto, é necessário consultar a documentação oficial de cada API para verificar quais campos são exigidos.<br />
<br />
As linhas 11 e 12 representam filtros opcionais, geralmente utilizados em formulários com filtros por período.<br />
Para utilizá-los, basta informar:<br />
<br />
dataini- + nome do campo → indica a data inicial que será filtrada;<br />
<br />
datafim- + nome do campo → indica a data final que será filtrada.<br />
<br />
Na coluna “Valor”, deve ser informada a máscara de data aceita pela API.<br />
<br />
Filtros como dataini- e datafim- são automaticamente substituídos pelas datas informadas no formulário durante a montagem da requisição.<br />
Esses indicadores também podem ser incluídos no JSON que fica na seção “Dados”.<br />
<br />
== Layouts de Retorno ==<br />
Para qualquer tipo de API, toda requisição feita é obtido um retorno, seja com uma mensagem de sucesso, ou com uma estrutura parecida com a do CURL, cada API tem sua particularidade.<br />
<br />
E para isso é preciso criar os layouts que receberão esse retorno. Esses layouts as vezes trabalharão em conjunto com os layouts de envio ou individualmente. Ao criar um layout do tipo retorno, será adicionado duas classes relacionadas, RetornoReqAPI e RetornoReqAPIItens. A montagem é semelhante a do arquivo, com a diferença de que no arquivo é preciso informar a posição do campo.<br />
<br />
Para criar um layout de retorno você deve ir em '''Finanças->Layouts de Retorno Online'''.<br />
<br />
== Layout de Retorno de Consulta de Cobranças ==<br />
Como citado alguns layouts trabalham em conjunto com os layouts de envio, no caso desse exemplo, irei utilizar um layout que trabalha em conjunto com o layout de consulta de diversas cobranças.<br />
<br />
A estrutura desse tipo de layout é mais flexível, ou seja, ela não fica presa igual ao corpo que é preciso ser montado no registro da cobrança. Porém é preciso algumas configurações essências para o fluxo:<br />
[[Arquivo:Secao cabecalho1 retorno consulta atualizado.png|centro]]<br />
<br />
Para que o fluxo funcione corretamente em alguns casos, como nesse layout exemplo ele trabalha em conjunto com a consulta de diversas cobranças, é preciso informar o '''proximoIndice''' da pesquisa, no caso do banco do brasil para cada consulta é coletado 300 cobranças, então é preciso guardar o esse valor para que a próxima consulta seja a partir do index 300. Então na coluna '''Valor''' você deverá informar o nome do campo que guarda esse valor no retorno.<br />
<br />
[[Arquivo:Secao cabecalho2 retorno consulta atualizado.png|centro]]<br />
Na segunda seção vai o nó (campo) que contém as cobranças, você não precisa criar uma nova seção, poderia ser no mesmo lugar, mas eu criei por questões de organização. Então, nessa segunda seção vai o nó (campo) que contém as cobranças, Ex:<br />
[[Arquivo:Retorno requisição cobranças diversas.png|centro]]<br />
Na coluna '''Valor''' você deve informar o nome do campo.<br />
<br />
[[Arquivo:Secao Dados retorno consulta atualizado.png|centro]]<br />
<br />
Na seção “Dados”, devem ser informados os valores de retorno que serão coletados para uso dentro do ERP.<br />
Na coluna “Descrição”, deve ser indicado o campo da classe que receberá o valor, e na coluna “Valor”, o nome do campo retornado pela API que contém esse dado.<br />
<br />
Para permitir o reaproveitamento do layout de retorno, há situações em que o mesmo layout é utilizado em diferentes cenários.<br />
Nesses casos, alguns campos podem se repetir, conforme o exemplo abaixo:<br />
<br />
O campo RetornoReqAPIItens->CodEstadoTituloCobranca pode, em uma requisição, receber o valor retornado pela API como '''codigoEstadoTituloCobranca''', enquanto em outro recurso a API pode retornar '''codEstadoCobranca'''.<br />
<br />
Quando isso ocorre, o layout mantém o primeiro valor encontrado.<br />
Ou seja, se o campo '''codigoEstadoTituloCobranca''' for retornado e preencher o campo correspondente no ERP, e em seguida a API também retornar '''codEstadoCobranca''', o layout não substituirá o valor já atribuído.<br />
<br />
== Layout de Retorno para Tratamento de Erros ==<br />
O layout de tratamento de erro é essencial quando o assunto é retorno da requisição, pois como citado anteriormente eles podem trabalhar em conjunto com os layouts de envio, como também individual, e muita das vezes esses retorno são de erros, e erros de API's são muitos genéricos, Exemplo:<br />
<br />
Requisições HTTPs, sejam elas de envio ou os próprios retorno, retornam um código:<br />
<br />
Códigos com o valor >= 200 dizem que a requisição foi um sucesso<br />
<br />
Códigos com o valor >= 300 dizem que a requisição foi redirecionada para outro lugar, ou seja, suponhamos que eu faça a requisição no end-point '''https:/api.sandbox.bb.com.br/cobrancas/v2''', e esse end-point não existe mais, a aplicação automaticamente me encaminhara para outro end-point configurado no servidor da API<br />
<br />
Códigos com o valor >= 400 dizem que a requisição obteve um erro, porém esse erro foi do lado de quem solicitou, seja por um campo informado incorretamente.<br />
<br />
Códigos com o valor >= 500 dizem que houve um erro na requisição, mas do lado do servidor, seja por estar fora do ar, ou algum evento não tratado pela própria API.<br />
<br />
E então esse layout de tratamento de erro, ficará encarregado de tratar esse retorno, no caso do registro da cobrança o ERP primeiro faz uma consulta na API com o nosso número do boleto, e como a cobrança ainda não existe no servidor do banco do brasil, é retornado um erro, dizendo que o nosso número da cobrança foi informado incorretamente, e de fato esse erro faz sentido, pois como eu estou tentando registrar uma cobrança ela ainda não existe, mas essa consulta também é essencial pois ela busca primeiro se a cobrança existe para não ocorrer o caso de duplicidade. E esse erro retornado é o código 400, pode ser que o usuário deixou de informar também o valor da cobrança, isso resultaria em um erro de código 400, então pra isso foi preciso criar os layouts de tratamento de erro.<br />
<br />
[[Arquivo:Secao cabecalho tratamento erro.png|centro]]<br />
<br />
Na primeira seção (cabecalho) vai ser informado o nó (campo) pai do retorno, Ex:<br />
<br />
[[Arquivo:Corpo erro.png|centro]]<br />
Porém, esses nós (campos) pai retornado nem sempre tem o mesmo nome, no caso é '''erros''', mas alguns erros também retornam '''errors''', '''erro''' no singular, então é preciso que no cabeçalho seja colocado todas as variações separadas por virgula, exemplo: '''erros,errors,erro'''<br />
<br />
[[Arquivo:Secao cabecalho grupo tratamento erro.png|centro]]<br />
No cabecalhoGrupo é preciso informar o código do erro, como citado anteriormente os erros são muitos genéricos, mas para que os erros sejam identificados, cada um tem um código, no caso da consulta da cobrança antes de registrar ela, é consulta e o erro retornado é o código '''4678420.1''', nota-se que esse código está sendo informado no cabecalhoGrupo, ou seja, quando o retorno da requisição conter esse código no erro, a aplicação não será parada, por que esse retorno era o esperado, para encontrar esses código de erros na documentação do banco do brasil:<br />
<br />
[[Arquivo:Documentação erros.png|centro]]<br />
[[Arquivo:Documentação codigo erros.png|centro]]<br />
Na imagem acima é possível visualizar todos os códigos de erros que podem acontecer, então todos os código que serão previstos, devem ser adicionados no cabecalhoGrupo.<br />
<br />
[[Arquivo:Secao dados tratamento erro.png|centro]]<br />
Na seção Dados, é preciso informar os nome dos campos que contém o código do erro e a mensagem, isso é essencial para erros que não são previstos, e segue a mesma lógica do cabecalho, como o retorno é genérico, pode ser retornado o nó (campo) pai com os nomes '''erros,errors,erro''' e a mensagem como '''mensagem,message'''.<br />
<br />
== Informar Layouts na Conta ==<br />
[[Arquivo:Conta cadastro dos layouts.png|centro]]<br />
Para informar os layouts criados, é preciso entrar no cadastro das contas na aba Cobrança API, ali você pode informar todos os layouts.<br />
<br />
== Valores de Acoplamento ==<br />
Para poder informar os valores de acoplamentos corretamente, aqui está alguns exemplos:<br />
[[Arquivo:Valores acoplados.png|centro]]<br />
<br />
Como citado anteriormente, caso a API forneça uma Authorization deve ser informada, já para as linha '''Client-Id''' e '''Client-Secret''' você deve informar os valores que a API fornece, para a chave do aplicativo já é um pouco diferente, pois para o banco do brasil em especifico, eles pedem que seja informado o valor '''gw-dev-app-key=sua_chave''', e como cada API tem seu estilo de nomeclatura, é necessário informar antes do '''gw-dev-app-key=''' o sinal de "?", mas isso pode ser preciso somente para a API do banco do brasil, talvez outras API's tratam isso de uma forma diferente.<br />
<br />
== Parametrização das Ocorrência Bancária ==<br />
Para parametrizar as ocorrências bancárias referentes as requisições por meio da API, segue a imagem abaixo:<br />
[[Arquivo:Parametrizacao Banco API atualizado.png|centro]]<br />
<br />
A nova coluna Cod.Api indica uma relação do código de retorno por arquivo com o retorno da API<br />
<br />
O tipo de ação de envio de cobrança por API permanece sendo o '''Envio_Cobranca_Api''', aonde por sua vez pode ser parametrizado com qualquer código, o motivo de ter essa ação é pelo fato de que no modo convencional de gerar as cobranças pela remessa de arquivo não criava o '''Nosso Número''', e sim somente na impressão do boleto. Como para registro de cobranças por meio da API é obrigatório o envio do '''Nosso Número''' ele é gerado assim que é gravada a remessa online, como o tipo de ação '''Envio_Cobranca_Api'''.<br />
<br />
== Formulas ==<br />
No caso do Banco do Brasil é preciso que o nosso número contenha 20 caracteres no total, sendo 7 deles o número do convênio e 10 de controle (que seria o nosso número da cobrança no ERP) e zeros a esquerda para preencher os 20 caracteres, ficando assim: 00031285570001798547, aqui está uma formula que monta esse valor.<br />
<br />
'''Nosso Número Banco do Brasil:''' NrParaTexto([[ConcatenarValores([numeroConvenio], , [[NrParaTexto({Cobranca.NossoNumero}, 10, False, 0, False)]], , , , )]], 20, False, 0, False)<br />
<br />
== Filtros Adicionais ==<br />
Cabeçalhos adicionais podem ser incluídos adicionando novos elementos na seção<br />
de cabeçalho. Devem ser adicionais de acordo com as exigências da API.<br />
<br />
'''Nome Tag''' deve ser usada quando houver tags com o mesmo nome sendo do tipo <br />
VrAcopl, por exemplo desconto e juros que possuem uma tag filha chamada 'tipo'.<br />
Se não preenchida, será usada a coluna de identificação/descrição.<br />
<br />
Filtro de Datas<br />
dataini-nome_do_campo<br />
datafim-nome_do_campo<br />
periodo-nome_do_campo<br />
Filtro de consulta<br />
pagina-nome_do_campo<br />
situacao-nome_do_campo<br />
<br />
Ultima atualização em 12/11/2025</div>Viniciushttps://wiki.dataplussistemas.com.br/index.php?title=Arquivo:Permitir_valores_vazios_layout_API.png&diff=14662Arquivo:Permitir valores vazios layout API.png2025-11-12T13:13:21Z<p>Vinicius: </p>
<hr />
<div>Permitir valores vazios layout API</div>Viniciushttps://wiki.dataplussistemas.com.br/index.php?title=Arquivo:M%C3%A9todo_de_envio_layout_API.png&diff=14661Arquivo:Método de envio layout API.png2025-11-12T13:12:44Z<p>Vinicius: </p>
<hr />
<div>Método de envio layout API</div>Viniciushttps://wiki.dataplussistemas.com.br/index.php?title=Layout_Requisi%C3%A7%C3%A3o_API&diff=14660Layout Requisição API2025-11-12T13:10:34Z<p>Vinicius: </p>
<hr />
<div>Página criada com o objetivo de auxiliar a criação dos layouts de requisições para as APIs.<br />
<br />
== O que é uma API? ==<br />
Por exemplo, imagine que você está usando um aplicativo de previsão do tempo em seu celular. Esse aplicativo precisa obter informações atualizadas sobre o clima de uma fonte confiável, como um serviço meteorológico. Em vez de criar seu próprio sistema para coletar esses dados, o aplicativo utiliza uma API fornecida pelo serviço meteorológico. A API fornece métodos (ou opções) para solicitar informações específicas sobre o clima, como a temperatura atual, a previsão para os próximos dias, etc. O aplicativo utiliza esses métodos para obter os dados de que precisa, como se estivesse fazendo um pedido no cardápio, e depois exibe essas informações para você.<br />
<br />
Em resumo, uma API é como um intermediário que permite que diferentes programas se comuniquem e compartilhem informações de maneira padronizada, tornando a integração entre sistemas mais fácil e eficiente. É como o cardápio que simplifica o processo de fazer pedidos em um restaurante.<br />
<br />
== Tipos de métodos das requisições ==<br />
GET: Solicita a recuperação de um recurso específico no servidor. É usado principalmente para recuperar informações, como visualizar uma página da web ou buscar dados.<br />
<br />
POST: Envia dados para o servidor para que ele processe ou armazene. Geralmente usado para enviar informações do usuário, como preenchimento de formulários online.<br />
<br />
PUT: Atualiza um recurso existente no servidor ou cria um novo se ele não existir. O conteúdo enviado no corpo da solicitação substitui completamente o recurso existente.<br />
<br />
PATCH: Similar ao PUT, mas usado para aplicar modificações parciais a um recurso. A solicitação contém apenas as alterações que devem ser aplicadas ao recurso existente.<br />
<br />
DELETE: Solicita a remoção de um recurso no servidor. Usado para excluir informações ou recursos específicos.<br />
<br />
Dentre esses métodos para as requisições, os mais utilizados no ERP são o '''GET''', '''POST''', '''PATCH''' e '''DELETE'''.<br />
<br />
== Seções ==<br />
O layouts das requisições contém 3 seções, sendo elas:<br />
<br />
'''''Cabeçalho:''''' identifica a seção onde serão coletados os dados necessários para que a requisição seja feita (nomenclatura utilizada pelo layout dos bancos para definir a seção);<br />
<br />
'''''Cabeçalho Grupo:''''' identifica a seção onde serão coletados os parâmetros necessários para que a requisição seja feita (nomenclatura utilizada pelo layout dos bancos para definir a seção);<br />
<br />
'''''Dados:''''' identifica a seção onde serão coletados os dados necessários para o corpo da requisição (nomenclatura utilizada pelo layout dos bancos para definir a seção);<br />
<br />
== Entendendo a estrutura de envio da requisição ==<br />
A estrutura de envio de requisições de uma API é chamada de '''CURL''', sendo uma das mais utilizadas, sua estrutura é a seguinte:<br />
[[Arquivo:Estrutura curl.png|centro]]<br />
<br />
A primeira linha indica o método utilizado na requisição, que neste caso é POST. Esse método é usado quando se deseja registrar ou inserir informações no servidor, ou seja, enviar novos dados.<br />
<br />
A segunda linha mostra o endereço (URL) da requisição. Esse link é dividido da seguinte forma:<br />
<br />
https://api.sandbox.bb.com.br/cobrancas/v2<br />
<br />
/boletos → representa o serviço que está sendo utilizado. Cada API possui suas próprias rotas (ou serviços). Por exemplo, uma instituição de ensino, ao clicar em “fazer login”, utilizaria a rota /login. Uma mesma API pode conter várias rotas, cada uma com uma finalidade diferente.<br />
<br />
?gw-dev-app-key=e85f6f4c238ad52eaeb9cf39dd4777e → é a chave da aplicação, usada para autenticar a requisição e identificar o sistema que está acessando a API.<br />
<br />
Nas requisições do tipo POST, normalmente o conteúdo principal é enviado no corpo da requisição, e a URL costuma ser mais simples. Já em requisições do tipo GET, as informações são enviadas diretamente na URL.<br />
<br />
Por exemplo:<br />
https://api.sandbox.bb.com.br/cobrancas/v2/boletos?gw-dev-app-key=e85f6f4c238ad52eaeb9cf39dd4777e&indicadorSituacao=A&agenciaBeneficiario=452&contaBeneficiario=123873<br />
<br />
Após a chave do aplicativo (?gw-dev-app-key=...), os demais valores são separados pelo &. Esses valores funcionam como parâmetros ou filtros da requisição. No exemplo acima, estamos solicitando as cobranças com indicador de situação igual a A, pertencentes à agência 452 e conta 123873.<br />
<br />
A terceira linha da requisição indica o tipo de retorno aceito pela aplicação, definido por meio do cabeçalho:<br />
-H 'accept: application/json'<br />
Isso informa à API que o sistema (ERP) espera receber os dados de resposta em formato JSON, para que possa tratá-los corretamente.<br />
<br />
A quarta linha mostra o campo Authorization, que é responsável por autenticar o acesso ao servidor:<br />
-H 'Authorization: Bearer [token]'<br />
Esse token tem um tempo de validade limitado (no caso do Banco do Brasil, cerca de 10 minutos). Após esse tempo, é necessário gerar um novo token, mas o próprio ERP faz esse processo automaticamente.<br />
<br />
A quinta linha define o tipo de conteúdo que está sendo enviado à API:<br />
-H 'Content-Type: application/json'<br />
Isso indica que os dados estão sendo enviados em formato JSON, o padrão mais utilizado para comunicação entre sistemas.<br />
<br />
As demais linhas representam o corpo da requisição, que contém todas as informações a serem enviadas ao servidor. No caso da API de boletos, o corpo inclui dados como o número do convênio, número da carteira, data de emissão, data de vencimento, valores, descontos, entre outros campos obrigatórios exigidos pela API.<br />
<br />
O corpo é utilizado principalmente em requisições do tipo POST, PATCH e DELETE. Já no método GET, as informações são enviadas apenas na URL, e não existe corpo na requisição.<br />
<br />
== Layouts ==<br />
Para a criação dos layouts de envio de requisição, você pode encontrar no ERP nas seguintes abas: '''Finanças->Layouts de Envio Online'''<br />
<br />
Os primeiros passos é criar a seção cabecalho. Ao adicionar a seção cabeçalho será adicionado os valores necessários para a requisição, basta preencher:<br />
[[Arquivo:Secao cabecalho registro v2.png|centro]]<br />
<br />
Os valores são preenchidos da seguinte maneira (Esses valores são essenciais para todos os layouts de envio):<br />
<br />
'''End-Point''' - é o link em que a requisição será feita;<br />
<br />
'''Requisição''' - é o serviço a ser utilizado;<br />
<br />
'''Authorization''' – é o meio de autenticação exigido pela API para a realização das requisições.<br />
No caso do Banco do Brasil, é necessário enviar o client-id e o client-secret codificados em Base64.<br />
<br />
O valor desse campo é composto por três partes, separadas por ponto e vírgula (;):<br />
<br />
Primeiro valor: indica se as credenciais devem ser convertidas em Base64 (True ou False).<br />
<br />
Segundo valor: representa a chave do cabeçalho (Header) utilizada na requisição, geralmente Authorization.<br />
<br />
Terceiro valor: define o tipo do token (token type), normalmente Bearer.<br />
<br />
Exemplos:<br />
<br />
Banco do Brasil: True;Authorization;Bearer<br />
<br />
Itaú: False;Authorization;Bearer<br />
<br />
<br />
'''Url-OAuth''' - é o link em que a requisição será autenticada, ou seja, é o link em que será coletado um novo token (Authorization);<br />
<br />
'''Client-Id e Client-Secret''' - São as chaves que são utilizadas para obter o token (Authorization) quando a API não fornece o token;<br />
<br />
'''Scopos''' - É a identificação de quais serviços serão utilizados, esses valores são de uso interno da API;<br />
<br />
'''Chave-Aplicativo''' - é a chave que será utilizada indicando qual o aplicativo que está fazendo a requisição;<br />
<br />
'''Ident-Banco-Conta''' - é a identificação do código do banco do ERP + o número da conta, esse campo se faz necessário para a guarda das credenciais no XML de configuração.<br />
<br />
== Layout de Registro de Cobrança ==<br />
Ao criar o layout de registro de cobranças, você vai precisar da seção Dados, que será utilizada para montar o corpo da requisição, ela é criada da seguinte maneira:<br />
[[Arquivo:Estrutura Layout.png|centro]]<br />
<br />
Para criar os elementos, você pode utilizar Textos, Formulas e Campos. Como comentando anteriormente a estrutura do envio da requisição da API é formada da seguinte maneira:<br />
[[Arquivo:Estrutura curl exemplo.png|centro]]<br />
<br />
Ou seja, ao inserir os valores na seção dados, na coluna '''Descrição''', vai ser informado, por exemplo, '''numeroTituloCliente''' e na coluna '''Valor''' vai ser informado o valor que vier depois dos dois pontos, no caso '''00031285570000030000''', o mesmo para mensagem de bloqueto, na coluna '''Descrição''', vai ser informado '''mensagemBloquetoOcorrencia''' e na coluna '''Valor''' vai ser informado '''Outro Texto'''.<br />
<br />
Já no caso do Desconto, pode-se perceber que ele possui valores filhos (tipo, dataExpiracao, porcentagem e valor). Eles são um caso especial, para ser criado o corpo do desconto, se utiliza a mesma maneira do exemplo anterior, porém, será necessário selecionar o '''Tipo dos Dados''' como '''Array''' ou '''Objeto'''.<br />
<br />
'''Tipo Objeto:'''<br />
desconto {<br />
tipo: 1,<br />
dataExpiracao: "30.01.2024",<br />
porcentagem: 0,<br />
valor: 12.34<br />
}<br />
<br />
'''Tipo Array'''<br />
desconto [<br />
{<br />
tipo: 1,<br />
dataExpiracao: "30.01.2024",<br />
porcentagem: 0,<br />
valor: 12.34<br />
},<br />
{<br />
tipo: 1,<br />
dataExpiracao: "30.01.2024",<br />
porcentagem: 0,<br />
valor: 12.34<br />
}<br />
]<br />
<br />
O tipo '''Array''' é um coleção, podendo ter muitos '''objetos''' dentro dele<br />
<br />
Exemplo utilização campo pai:<br />
<br />
desconto {<br />
'valor':1.00, (Campo pai = desconto)<br />
'vencimento':01.01.0001 (Campo <br />
pai = desconto)<br />
}<br />
<br />
Para as formatações de datas ou valores, basta utilizar as colunas '''Decimais''' e '''Mascara'''. Algo que vale ressaltar é que os campos e valores não precisam ser montados na sequência (exceto os campos que são aninhados, Ex: desconto), porém, o ideal é que seja em sequência, para evitar quaisquer transtornos.<br />
<br />
== Layout de Consulta de Cobranças ==<br />
Como citado anteriormente, as consultas com o método '''GET''', não possuem corpo, mas possuem parâmetros, e esses parâmetros são informados na seção '''cabecalhoGrupo''':<br />
[[Arquivo:Secao cabecalho grupo consulta.png|centro]]<br />
<br />
A criação segue o mesmo padrão do corpo do layout de registro de cobrança.<br />
Na coluna “Descrição” deve ser informado o nome do campo, e na coluna “Valor” o valor que será atribuído ao filtro (parâmetro).<br />
<br />
É importante observar que alguns parâmetros são obrigatórios, mas isso varia conforme a API utilizada — portanto, é necessário consultar a documentação oficial de cada API para verificar quais campos são exigidos.<br />
<br />
As linhas 11 e 12 representam filtros opcionais, geralmente utilizados em formulários com filtros por período.<br />
Para utilizá-los, basta informar:<br />
<br />
dataini- + nome do campo → indica a data inicial que será filtrada;<br />
<br />
datafim- + nome do campo → indica a data final que será filtrada.<br />
<br />
Na coluna “Valor”, deve ser informada a máscara de data aceita pela API.<br />
<br />
Filtros como dataini- e datafim- são automaticamente substituídos pelas datas informadas no formulário durante a montagem da requisição.<br />
Esses indicadores também podem ser incluídos no JSON que fica na seção “Dados”.<br />
<br />
== Layouts de Retorno ==<br />
Para qualquer tipo de API, toda requisição feita é obtido um retorno, seja com uma mensagem de sucesso, ou com uma estrutura parecida com a do CURL, cada API tem sua particularidade.<br />
<br />
E para isso é preciso criar os layouts que receberão esse retorno. Esses layouts as vezes trabalharão em conjunto com os layouts de envio ou individualmente. Ao criar um layout do tipo retorno, será adicionado duas classes relacionadas, RetornoReqAPI e RetornoReqAPIItens. A montagem é semelhante a do arquivo, com a diferença de que no arquivo é preciso informar a posição do campo.<br />
<br />
Para criar um layout de retorno você deve ir em '''Finanças->Layouts de Retorno Online'''.<br />
<br />
== Layout de Retorno de Consulta de Cobranças ==<br />
Como citado alguns layouts trabalham em conjunto com os layouts de envio, no caso desse exemplo, irei utilizar um layout que trabalha em conjunto com o layout de consulta de diversas cobranças.<br />
<br />
A estrutura desse tipo de layout é mais flexível, ou seja, ela não fica presa igual ao corpo que é preciso ser montado no registro da cobrança. Porém é preciso algumas configurações essências para o fluxo:<br />
[[Arquivo:Secao cabecalho1 retorno consulta atualizado.png|centro]]<br />
<br />
Para que o fluxo funcione corretamente em alguns casos, como nesse layout exemplo ele trabalha em conjunto com a consulta de diversas cobranças, é preciso informar o '''proximoIndice''' da pesquisa, no caso do banco do brasil para cada consulta é coletado 300 cobranças, então é preciso guardar o esse valor para que a próxima consulta seja a partir do index 300. Então na coluna '''Valor''' você deverá informar o nome do campo que guarda esse valor no retorno.<br />
<br />
[[Arquivo:Secao cabecalho2 retorno consulta atualizado.png|centro]]<br />
Na segunda seção vai o nó (campo) que contém as cobranças, você não precisa criar uma nova seção, poderia ser no mesmo lugar, mas eu criei por questões de organização. Então, nessa segunda seção vai o nó (campo) que contém as cobranças, Ex:<br />
[[Arquivo:Retorno requisição cobranças diversas.png|centro]]<br />
Na coluna '''Valor''' você deve informar o nome do campo.<br />
<br />
[[Arquivo:Secao Dados retorno consulta atualizado.png|centro]]<br />
<br />
Na seção “Dados”, devem ser informados os valores de retorno que serão coletados para uso dentro do ERP.<br />
Na coluna “Descrição”, deve ser indicado o campo da classe que receberá o valor, e na coluna “Valor”, o nome do campo retornado pela API que contém esse dado.<br />
<br />
Para permitir o reaproveitamento do layout de retorno, há situações em que o mesmo layout é utilizado em diferentes cenários.<br />
Nesses casos, alguns campos podem se repetir, conforme o exemplo abaixo:<br />
<br />
O campo RetornoReqAPIItens->CodEstadoTituloCobranca pode, em uma requisição, receber o valor retornado pela API como '''codigoEstadoTituloCobranca''', enquanto em outro recurso a API pode retornar '''codEstadoCobranca'''.<br />
<br />
Quando isso ocorre, o layout mantém o primeiro valor encontrado.<br />
Ou seja, se o campo '''codigoEstadoTituloCobranca''' for retornado e preencher o campo correspondente no ERP, e em seguida a API também retornar '''codEstadoCobranca''', o layout não substituirá o valor já atribuído.<br />
<br />
== Layout de Retorno para Tratamento de Erros ==<br />
O layout de tratamento de erro é essencial quando o assunto é retorno da requisição, pois como citado anteriormente eles podem trabalhar em conjunto com os layouts de envio, como também individual, e muita das vezes esses retorno são de erros, e erros de API's são muitos genéricos, Exemplo:<br />
<br />
Requisições HTTPs, sejam elas de envio ou os próprios retorno, retornam um código:<br />
<br />
Códigos com o valor >= 200 dizem que a requisição foi um sucesso<br />
<br />
Códigos com o valor >= 300 dizem que a requisição foi redirecionada para outro lugar, ou seja, suponhamos que eu faça a requisição no end-point '''https:/api.sandbox.bb.com.br/cobrancas/v2''', e esse end-point não existe mais, a aplicação automaticamente me encaminhara para outro end-point configurado no servidor da API<br />
<br />
Códigos com o valor >= 400 dizem que a requisição obteve um erro, porém esse erro foi do lado de quem solicitou, seja por um campo informado incorretamente.<br />
<br />
Códigos com o valor >= 500 dizem que houve um erro na requisição, mas do lado do servidor, seja por estar fora do ar, ou algum evento não tratado pela própria API.<br />
<br />
E então esse layout de tratamento de erro, ficará encarregado de tratar esse retorno, no caso do registro da cobrança o ERP primeiro faz uma consulta na API com o nosso número do boleto, e como a cobrança ainda não existe no servidor do banco do brasil, é retornado um erro, dizendo que o nosso número da cobrança foi informado incorretamente, e de fato esse erro faz sentido, pois como eu estou tentando registrar uma cobrança ela ainda não existe, mas essa consulta também é essencial pois ela busca primeiro se a cobrança existe para não ocorrer o caso de duplicidade. E esse erro retornado é o código 400, pode ser que o usuário deixou de informar também o valor da cobrança, isso resultaria em um erro de código 400, então pra isso foi preciso criar os layouts de tratamento de erro.<br />
<br />
[[Arquivo:Secao cabecalho tratamento erro.png|centro]]<br />
<br />
Na primeira seção (cabecalho) vai ser informado o nó (campo) pai do retorno, Ex:<br />
<br />
[[Arquivo:Corpo erro.png|centro]]<br />
Porém, esses nós (campos) pai retornado nem sempre tem o mesmo nome, no caso é '''erros''', mas alguns erros também retornam '''errors''', '''erro''' no singular, então é preciso que no cabeçalho seja colocado todas as variações separadas por virgula, exemplo: '''erros,errors,erro'''<br />
<br />
[[Arquivo:Secao cabecalho grupo tratamento erro.png|centro]]<br />
No cabecalhoGrupo é preciso informar o código do erro, como citado anteriormente os erros são muitos genéricos, mas para que os erros sejam identificados, cada um tem um código, no caso da consulta da cobrança antes de registrar ela, é consulta e o erro retornado é o código '''4678420.1''', nota-se que esse código está sendo informado no cabecalhoGrupo, ou seja, quando o retorno da requisição conter esse código no erro, a aplicação não será parada, por que esse retorno era o esperado, para encontrar esses código de erros na documentação do banco do brasil:<br />
<br />
[[Arquivo:Documentação erros.png|centro]]<br />
[[Arquivo:Documentação codigo erros.png|centro]]<br />
Na imagem acima é possível visualizar todos os códigos de erros que podem acontecer, então todos os código que serão previstos, devem ser adicionados no cabecalhoGrupo.<br />
<br />
[[Arquivo:Secao dados tratamento erro.png|centro]]<br />
Na seção Dados, é preciso informar os nome dos campos que contém o código do erro e a mensagem, isso é essencial para erros que não são previstos, e segue a mesma lógica do cabecalho, como o retorno é genérico, pode ser retornado o nó (campo) pai com os nomes '''erros,errors,erro''' e a mensagem como '''mensagem,message'''.<br />
<br />
== Informar Layouts na Conta ==<br />
[[Arquivo:Conta cadastro dos layouts.png|centro]]<br />
Para informar os layouts criados, é preciso entrar no cadastro das contas na aba Cobrança API, ali você pode informar todos os layouts.<br />
<br />
== Valores de Acoplamento ==<br />
Para poder informar os valores de acoplamentos corretamente, aqui está alguns exemplos:<br />
[[Arquivo:Valores acoplados.png|centro]]<br />
<br />
Como citado anteriormente, caso a API forneça uma Authorization deve ser informada, já para as linha '''Client-Id''' e '''Client-Secret''' você deve informar os valores que a API fornece, para a chave do aplicativo já é um pouco diferente, pois para o banco do brasil em especifico, eles pedem que seja informado o valor '''gw-dev-app-key=sua_chave''', e como cada API tem seu estilo de nomeclatura, é necessário informar antes do '''gw-dev-app-key=''' o sinal de "?", mas isso pode ser preciso somente para a API do banco do brasil, talvez outras API's tratam isso de uma forma diferente.<br />
<br />
== Parametrização das Ocorrência Bancária ==<br />
Para parametrizar as ocorrências bancárias referentes as requisições por meio da API, segue a imagem abaixo:<br />
[[Arquivo:Parametrizacao Banco API atualizado.png|centro]]<br />
<br />
A nova coluna Cod.Api indica uma relação do código de retorno por arquivo com o retorno da API<br />
<br />
O tipo de ação de envio de cobrança por API permanece sendo o '''Envio_Cobranca_Api''', aonde por sua vez pode ser parametrizado com qualquer código, o motivo de ter essa ação é pelo fato de que no modo convencional de gerar as cobranças pela remessa de arquivo não criava o '''Nosso Número''', e sim somente na impressão do boleto. Como para registro de cobranças por meio da API é obrigatório o envio do '''Nosso Número''' ele é gerado assim que é gravada a remessa online, como o tipo de ação '''Envio_Cobranca_Api'''.<br />
<br />
== Formulas ==<br />
No caso do Banco do Brasil é preciso que o nosso número contenha 20 caracteres no total, sendo 7 deles o número do convênio e 10 de controle (que seria o nosso número da cobrança no ERP) e zeros a esquerda para preencher os 20 caracteres, ficando assim: 00031285570001798547, aqui está uma formula que monta esse valor.<br />
<br />
'''Nosso Número Banco do Brasil:''' NrParaTexto([[ConcatenarValores([numeroConvenio], , [[NrParaTexto({Cobranca.NossoNumero}, 10, False, 0, False)]], , , , )]], 20, False, 0, False)<br />
<br />
== Filtros Adicionais ==<br />
Cabeçalhos adicionais podem ser incluídos adicionando novos elementos na seção<br />
de cabeçalho. Devem ser adicionais de acordo com as exigências da API.<br />
<br />
'''Nome Tag''' deve ser usada quando houver tags com o mesmo nome sendo do tipo <br />
VrAcopl, por exemplo desconto e juros que possuem uma tag filha chamada 'tipo'.<br />
Se não preenchida, será usada a coluna de identificação/descrição.<br />
<br />
Filtro de Datas<br />
dataini-nome_do_campo<br />
datafim-nome_do_campo<br />
periodo-nome_do_campo<br />
Filtro de consulta<br />
pagina-nome_do_campo<br />
situacao-nome_do_campo<br />
<br />
Ultima atualização em 10/11/2025</div>Viniciushttps://wiki.dataplussistemas.com.br/index.php?title=Arquivo:Parametrizacao_Banco_API_atualizado.png&diff=14659Arquivo:Parametrizacao Banco API atualizado.png2025-11-12T13:08:41Z<p>Vinicius: </p>
<hr />
<div>Parametrizacao Banco API atualizado</div>Viniciushttps://wiki.dataplussistemas.com.br/index.php?title=Arquivo:Secao_Dados_retorno_consulta_atualizado.png&diff=14658Arquivo:Secao Dados retorno consulta atualizado.png2025-11-12T12:56:52Z<p>Vinicius: </p>
<hr />
<div>Secao Dados retorno consulta atualizado</div>Viniciushttps://wiki.dataplussistemas.com.br/index.php?title=Arquivo:Secao_cabecalho2_retorno_consulta_atualizado.png&diff=14657Arquivo:Secao cabecalho2 retorno consulta atualizado.png2025-11-12T12:56:01Z<p>Vinicius: </p>
<hr />
<div>Secao cabecalho2 retorno consulta atualizado</div>Viniciushttps://wiki.dataplussistemas.com.br/index.php?title=Arquivo:Secao_cabecalho1_retorno_consulta_atualizado.png&diff=14656Arquivo:Secao cabecalho1 retorno consulta atualizado.png2025-11-12T12:55:32Z<p>Vinicius: </p>
<hr />
<div>Secao cabecalho1 retorno consulta atualizado</div>Viniciushttps://wiki.dataplussistemas.com.br/index.php?title=Arquivo:Estrutura_Layout.png&diff=14655Arquivo:Estrutura Layout.png2025-11-12T12:41:24Z<p>Vinicius: </p>
<hr />
<div>Estrutura Layout</div>Viniciushttps://wiki.dataplussistemas.com.br/index.php?title=Layout_Requisi%C3%A7%C3%A3o_API&diff=14653Layout Requisição API2025-11-10T19:08:50Z<p>Vinicius: </p>
<hr />
<div>Página criada com o objetivo de auxiliar a criação dos layouts de requisições para as APIs.<br />
<br />
== O que é uma API? ==<br />
Por exemplo, imagine que você está usando um aplicativo de previsão do tempo em seu celular. Esse aplicativo precisa obter informações atualizadas sobre o clima de uma fonte confiável, como um serviço meteorológico. Em vez de criar seu próprio sistema para coletar esses dados, o aplicativo utiliza uma API fornecida pelo serviço meteorológico. A API fornece métodos (ou opções) para solicitar informações específicas sobre o clima, como a temperatura atual, a previsão para os próximos dias, etc. O aplicativo utiliza esses métodos para obter os dados de que precisa, como se estivesse fazendo um pedido no cardápio, e depois exibe essas informações para você.<br />
<br />
Em resumo, uma API é como um intermediário que permite que diferentes programas se comuniquem e compartilhem informações de maneira padronizada, tornando a integração entre sistemas mais fácil e eficiente. É como o cardápio que simplifica o processo de fazer pedidos em um restaurante.<br />
<br />
== Tipos de métodos das requisições ==<br />
GET: Solicita a recuperação de um recurso específico no servidor. É usado principalmente para recuperar informações, como visualizar uma página da web ou buscar dados.<br />
<br />
POST: Envia dados para o servidor para que ele processe ou armazene. Geralmente usado para enviar informações do usuário, como preenchimento de formulários online.<br />
<br />
PUT: Atualiza um recurso existente no servidor ou cria um novo se ele não existir. O conteúdo enviado no corpo da solicitação substitui completamente o recurso existente.<br />
<br />
PATCH: Similar ao PUT, mas usado para aplicar modificações parciais a um recurso. A solicitação contém apenas as alterações que devem ser aplicadas ao recurso existente.<br />
<br />
DELETE: Solicita a remoção de um recurso no servidor. Usado para excluir informações ou recursos específicos.<br />
<br />
HEAD: Semelhante ao GET, mas solicita apenas os cabeçalhos da resposta, não o corpo. Isso é útil para verificar informações, como verificar se um recurso foi modificado recentemente.<br />
<br />
OPTIONS: Solicita informações sobre as opções de comunicação disponíveis para um recurso, como quais métodos e cabeçalhos são suportados.<br />
<br />
CONNECT: Usado para estabelecer uma conexão de rede com um recurso, geralmente para configurar túneis SSL/TLS (usados para segurança).<br />
<br />
TRACE: Usado para depuração e diagnóstico, solicita que o servidor retorne uma mensagem de depuração que pode ser útil para rastrear problemas de comunicação.<br />
<br />
CONNECT: Esse método foi originalmente definido para ser usado com um proxy que pode dinamicamente se tornar um túnel. No entanto, ele não é amplamente utilizado na prática.<br />
<br />
Dentre esses métodos para as requisições, os mais utilizados no ERP são o '''GET''', '''POST''', '''PATCH''' e '''DELETE'''.<br />
<br />
== Seções ==<br />
O layouts das requisições contém 3 seções, sendo elas:<br />
<br />
'''''Cabeçalho:''''' identifica a seção onde serão coletados os dados necessários para que a requisição seja feita (nomenclatura utilizada pelo layout dos bancos para definir a seção);<br />
<br />
'''''Cabeçalho Grupo:''''' identifica a seção onde serão coletados os parâmetros necessários para que a requisição seja feita (nomenclatura utilizada pelo layout dos bancos para definir a seção);<br />
<br />
'''''Dados:''''' identifica a seção onde serão coletados os dados necessários para o corpo da requisição (nomenclatura utilizada pelo layout dos bancos para definir a seção);<br />
<br />
== Criação dos Layouts ==<br />
Logo abaixo você tem o passo a passo de como criar os layouts para que seja possível fazer as requisições, lembrando que os exemplos utilizados serão com o ambiente de homologação do Banco do Brasil, mas poderia ser com qualquer outro, a criação dos layouts se tornou algo genérico:<br />
<br />
'''1° passo:''' Você deve entrar no portal do [https://www.bb.com.br/site/developers/ Banco do Brasil] e fazer o login<br />
<br />
'''2° passo:''' Com o login realizado, você deve ir até o ambiente de testes, basta clicar em '''SandBox'''<br />
[[Arquivo:aplicação bb.png|centro|Ambiente de testes Banco do Brasil - Aplicação]]<br />
<br />
'''3° passo:''' No ambiente de teste do Banco do Brasil, vá até '''API's -> Cobrança'''<br />
[[Arquivo:Api cobranca.png|centro]]<br />
<br />
'''4° passo:''' Com a API de cobrança selecionada, basta clicar no menu '''boletos'''<br />
[[Arquivo:Api cobranca ambiente boletos.png|centro]]<br />
<br />
Pronto, dessa forma já estamos preparados para começar a criação dos Layouts, mas antes é necessário que entenda como funciona o link que é enviado para a requisição.<br />
<br />
== Entendendo a estrutura de envio da requisição ==<br />
A estrutura de envio de requisições de uma API é chamada de '''CURL''', sendo uma das mais utilizadas, sua estrutura é a seguinte:<br />
[[Arquivo:Estrutura curl.png|centro]]<br />
<br />
A primeira linha mostra o método que está sendo enviado na requisição, '''POST''', ou seja, essa é uma requisição de registro/inserção;<br />
A segunda linha mostra o link da requisição, esse link é divido da seguinte maneira:<br />
<br />
'''https:/api.sandbox.bb.com.br/cobrancas/v2''' - É o End-Point da requisição, esse link é padrão para todos os clientes<br />
<br />
'''/boletos''' - É o serviço a ser utilizado, cada API possui o seu, por exemplo, uma instituição de ensino, ao clicar em fazer login para entrar na sua conta, o serviço a ser utilizado é '''/login'''. Uma API pode ter várias '''rotas''' (serviços).<br />
<br />
'''?gw-dev-app-key=e85f6f4c289d565aeb9cewq9dd4777e''' - É a chave da aplicação, cada API tem uma chave que é necessária para poder ser autenticada no servidor<br />
<br />
Para requisições com o método '''POST''', as requisições geralmente possuem pouco conteúdo, os valores são concentrados no corpo, para requisições '''GET''', o conteúdo geralmente são concentrados no próprio link, um exemplo:<br />
'''https:/api.sandbox.bb.com.br/cobrancas/v2/boletos?gw-dev-app-key=e85f6f4c238ad5255sdfdb9321213f39dd4777e &indicadorSituacao=A&agenciaBeneficiario=452&contaBeneficiario=123873'''<br />
<br />
Após a chave do aplicativo (?gw-dev-app-key=e85f6f4c238ad5255sdfdb9321213f39dd4777e), você pode perceber que os outros valores são concatenados com o E comercial (&), esses valores são como filtros para a requisição, ou seja, eu vou querer buscar cobranças que possui o indicador de situação = A, as cobranças que estão na agencia = 452 e a cobranças que estejam na conta = 123873, esses valores são chamados de parâmetros;<br />
<br />
A terceira linha mostra o tipo que a aplicação aceita de retorno, por exemplo, é o tipo de retorno que o ERP aceita para fazer suas tratativas;<br />
<br />
A quarta linha mostra a '''Authorization''', ela é necessária para fazer a autenticação sua no servidor, para que seja possível fazer as requisições, esse valor possui um tempo de expiração definido por cada API, no caso do banco do brasil a autorização dura em cerca de 10 minutos (mas não se preocupe, o ERP cuida dessa parte);<br />
<br />
A quinta linha mostra o tipo de envio que a API vai receber, nesse caso você está dizendo para API que ela vai receber um arquivo do tipo JSON;<br />
<br />
Para o restante das linhas você tem o corpo da requisição, ali é concentrado todo os dados que serão enviados para a requisição, o corpo é mais utilizado em requisições com o método '''POST''', '''PATCH''', '''DELETE''', o '''GET''' não utiliza. O corpo contém os valores como o nosso número do boleto, data de vencimento, valor, valor do desconto e etc.<br />
<br />
== Layouts ==<br />
Para a criação dos layouts de envio de requisição, você pode encontrar no ERP nas seguintes abas: '''Finanças->Contas a Receber->Cobrança Bancária->Layouts de Envio Online'''<br />
<br />
Os primeiros passos é criar a seção cabecalho. Ao adicionar a seção cabeçalho será adicionado os valores necessários para a requisição, basta preencher:<br />
[[Arquivo:Secao cabecalho registro v2.png|centro]]<br />
<br />
Os valores são preenchidos da seguinte maneira (Esses valores são essenciais para todos os layouts de envio):<br />
<br />
'''End-Point''' - é o link em que a requisição será feita;<br />
<br />
'''Requisição''' - é o serviço a ser utilizado;<br />
<br />
'''Authorization''' - é o meio de autorização que a API exige para realizar as requisições, ou seja, no caso do Banco do Brasil é preciso enviar o client-id e o client-secret em base64, então o primeiro valor se refere ao fazer o hash em base64 das credenciais ou não, devendo ser informado '''(True ou False)''', seguido de um ponto e vírgula, e o próximo valor é a chave do Header da requisição para a autorização '''(Authorization)''', seguido de um ponto e vírgula, e o próximo valor é o tipo do token (token type) '''Bearer'''.<br><br />
<br />
Valor do campo Banco do Brasil: True;Authorization;Bearer<br><br />
Valor do campo Itáu: False;Authorization;Bearer<br><br />
<br />
Lembrando que esse é para a API do Banco do Brasil, podendo variar para os outros bancos;<br><br />
<br />
'''Url-OAuth''' - é o link em que a requisição será autenticada, ou seja, é o link em que será coletado um novo token (Authorization);<br />
<br />
'''Client-Id e Client-Secret''' - São as chaves que são utilizadas para obter o token (Authorization) quando a API não fornece o token;<br />
<br />
'''Scopos''' - É a identificação de quais serviços serão utilizados, esses valores são de uso interno da API;<br />
<br />
'''Chave-Aplicativo''' - é a chave que será utilizada indicando qual o aplicativo que está fazendo a requisição;<br />
<br />
'''Ident-Banco-Conta''' - é a identificação do código do banco do ERP + o número da conta, esse campo se faz necessário para a guarda das credenciais no XML de configuração.<br />
<br />
== Layout de Registro de Cobrança ==<br />
Ao criar o layout de registro de cobranças, você vai precisar da seção Dados, que será utilizada para montar o corpo da requisição, ela é criada da seguinte maneira:<br />
[[Arquivo:Seção dados layout requisição API v2.png|centro]]<br />
<br />
Para criar os elementos, você pode utilizar Textos, Formulas e Campos. Como comentando anteriormente a estrutura do envio da requisição da API é formada da seguinte maneira:<br />
[[Arquivo:Estrutura curl exemplo.png|centro]]<br />
<br />
Ou seja, ao inserir os valores na seção dados, na coluna '''Descrição''', vai ser informado, por exemplo, '''numeroTituloCliente''' e na coluna '''Valor''' vai ser informado o valor que vier depois dos dois pontos, no caso '''00031285570000030000''', o mesmo para mensagem de bloqueto, na coluna '''Descrição''', vai ser informado '''mensagemBloquetoOcorrencia''' e na coluna '''Valor''' vai ser informado '''Outro Texto'''.<br />
<br />
Já no caso do Desconto, pode-se perceber que ele possui valores filhos (tipo, dataExpiracao, porcentagem e valor). Eles são um caso especial, para ser criado o corpo do desconto, se utiliza a mesma maneira do exemplo anterior, porém, será necessário marcar a coluna '''Campo Aninhado'''. Então, todos os valores que vierem dentro de desconto, como também o próprio campo desconto, deverá ser marcado como campo aninhado.<br />
<br />
Para as formatações de datas ou valores, basta utilizar as colunas '''Decimais''' e '''Mascara'''. Algo que vale ressaltar é que os campos e valores não precisam ser montados na sequência (exceto os campos que são aninhados, Ex: desconto), porém, o ideal é que seja em sequência, para evitar quaisquer transtornos.<br />
<br />
== Layout de Consulta de Cobranças ==<br />
Como citado anteriormente, as consultas com o método '''GET''', não possuem corpo, mas possuem parâmetros, e esses parâmetros são informados na seção '''cabecalhoGrupo''':<br />
[[Arquivo:Secao cabecalho grupo consulta.png|centro]]<br />
<br />
A criação é semelhante a do corpo do layout de registro de cobrança, na coluna '''Descrição''' vai o nome do campo e na coluna '''Valor''' vai o valor que será atribuído no filtro (parâmetro), lembrando que alguns parâmetros são obrigatórios, porém é preciso ler a documentação para ver quais, pois cada API tem o seu. As linhas 11 e 12 são filtros opcionais, que serão utilizados em formulários que terá filtros de períodos, para utiliza-los basta colocar o valor dataini- (Para a data inicial que será filtrada) ou datafim- (Para a data final que será filtrada) + o valor do campo e na coluna '''Valor''' a máscara de data que a API aceita.<br />
<br />
== Layouts de Retorno ==<br />
Para qualquer tipo de API, toda requisição feita é obtido um retorno, seja com uma mensagem de sucesso, ou com uma estrutura parecida com a do CURL, cada API tem sua particularidade.<br />
<br />
E para isso é preciso criar os layouts que receberão esse retorno. Esses layouts as vezes trabalharão em conjunto com os layouts de envio ou individualmente. Ao criar um layout do tipo retorno, será adicionado duas classes relacionadas, RetornoReqAPI e RetornoReqAPIItens. A montagem é semelhante a do arquivo, com a diferença de que no arquivo é preciso informar a posição do campo.<br />
<br />
Para criar um layout de retorno você deve ir em '''Finanças->Contas a Receber->Cobrança Bancária->Layouts de Retorno Online'''.<br />
<br />
== Layout de Retorno de Consulta de Cobranças ==<br />
Com citado alguns layouts trabalham em conjunto com os layouts de envio, no caso desse exemplo, irei utilizar um layout que trabalha em conjunto com o layout de consulta de diversas cobranças.<br />
<br />
A estrutura desse tipo de layout é mais flexível, ou seja, ela não fica presa igual ao corpo que é preciso ser montado no registro da cobrança. Porém é preciso algumas configurações essências para o fluxo:<br />
[[Arquivo:Secao cabecalho1 retorno consulta.png|centro]]<br />
<br />
Para que o fluxo funcione corretamente em alguns casos, como nesse layout exemplo ele trabalha em conjunto com a consulta de diversas cobranças, é preciso informar o '''proximoIndice''' da pesquisa, no caso do banco do brasil para cada consulta é coletado 300 cobranças, então é preciso guardar o esse valor para que a próxima consulta seja a partir do index 300. Então na coluna '''Valor''' você deverá informar o nome do campo que guarda esse valor no retorno.<br />
<br />
[[Arquivo:Secao cabecalho2 retorno consulta.png|centro]]<br />
Na segunda seção vai o nó (campo) que contém as cobranças, você não precisa criar uma nova seção, poderia ser no mesmo lugar, mas eu criei por questões de organização. Então, nessa segunda seção vai o nó (campo) que contém as cobranças, Ex:<br />
[[Arquivo:Retorno requisição cobranças diversas.png|centro]]<br />
Na coluna '''Valor''' você deve informar o nome do campo.<br />
<br />
[[Arquivo:Secao Dados retorno consulta.png|centro]]<br />
Na seção dados, você deve informar os valores do retorno que serão coletados para uso no ERP. Então na coluna '''Descrição''' vai ser informado o campo da classe que recebera o valor e na coluna '''Valor''' o nome do campo que guarda esse valor.<br />
<br />
== Layout de Retorno para Tratamento de Erros ==<br />
O layout de tratamento de erro é essencial quando o assunto é retorno da requisição, pois como citado anteriormente eles podem trabalhar em conjunto com os layouts de envio, como também individual, e muita das vezes esses retorno são de erros, e erros de API's são muitos genéricos, Exemplo:<br />
<br />
Requisições HTTPs, sejam elas de envio ou os próprios retorno, retornam um código:<br />
<br />
Códigos com o valor >= 200 dizem que a requisição foi um sucesso<br />
<br />
Códigos com o valor >= 300 dizem que a requisição foi redirecionada para outro lugar, ou seja, suponhamos que eu faça a requisição no end-point '''https:/api.sandbox.bb.com.br/cobrancas/v2''', e esse end-point não existe mais, a aplicação automaticamente me encaminhara para outro end-point configurado no servidor da API<br />
<br />
Códigos com o valor >= 400 dizem que a requisição obteve um erro, porém esse erro foi do lado de quem solicitou, seja por um campo informado incorretamente.<br />
<br />
Códigos com o valor >= 500 dizem que houve um erro na requisição, mas do lado do servidor, seja por estar fora do ar, ou algum evento não tratado pela própria API.<br />
<br />
E então esse layout de tratamento de erro, ficará encarregado de tratar esse retorno, no caso do registro da cobrança o ERP primeiro faz uma consulta na API com o nosso número do boleto, e como a cobrança ainda não existe no servidor do banco do brasil, é retornado um erro, dizendo que o nosso número da cobrança foi informado incorretamente, e de fato esse erro faz sentido, pois como eu estou tentando registrar uma cobrança ela ainda não existe, mas essa consulta também é essencial pois ela busca primeiro se a cobrança existe para não ocorrer o caso de duplicidade. E esse erro retornado é o código 400, pode ser que o usuário deixou de informar também o valor da cobrança, isso resultaria em um erro de código 400, então pra isso foi preciso criar os layouts de tratamento de erro.<br />
<br />
[[Arquivo:Secao cabecalho tratamento erro.png|centro]]<br />
<br />
Na primeira seção (cabecalho) vai ser informado o nó (campo) pai do retorno, Ex:<br />
<br />
[[Arquivo:Corpo erro.png|centro]]<br />
Porém, esses nós (campos) pai retornado nem sempre tem o mesmo nome, no caso é '''erros''', mas alguns erros também retornam '''errors''', '''erro''' no singular, então é preciso que no cabeçalho seja colocado todas as variações separadas por virgula, exemplo: '''erros,errors,erro'''<br />
<br />
[[Arquivo:Secao cabecalho grupo tratamento erro.png|centro]]<br />
No cabecalhoGrupo é preciso informar o código do erro, como citado anteriormente os erros são muitos genéricos, mas para que os erros sejam identificados, cada um tem um código, no caso da consulta da cobrança antes de registrar ela, é consulta e o erro retornado é o código '''4678420.1''', nota-se que esse código está sendo informado no cabecalhoGrupo, ou seja, quando o retorno da requisição conter esse código no erro, a aplicação não será parada, por que esse retorno era o esperado, para encontrar esses código de erros na documentação do banco do brasil:<br />
<br />
[[Arquivo:Documentação erros.png|centro]]<br />
[[Arquivo:Documentação codigo erros.png|centro]]<br />
Na imagem acima é possível visualizar todos os códigos de erros que podem acontecer, então todos os código que serão previstos, devem ser adicionados no cabecalhoGrupo.<br />
<br />
[[Arquivo:Secao dados tratamento erro.png|centro]]<br />
Na seção Dados, é preciso informar os nome dos campos que contém o código do erro e a mensagem, isso é essencial para erros que não são previstos, e segue a mesma lógica do cabecalho, como o retorno é genérico, pode ser retornado o nó (campo) pai com os nomes '''erros,errors,erro''' e a mensagem como '''mensagem,message'''.<br />
<br />
== Informar Layouts na Conta ==<br />
[[Arquivo:Conta cadastro dos layouts.png|centro]]<br />
Para informar os layouts criados, é preciso entrar no cadastro das contas na aba Cobrança API, ali você pode informar todos os layouts.<br />
<br />
== Valores de Acoplamento ==<br />
Para poder informar os valores de acoplamentos corretamente, aqui está alguns exemplos:<br />
[[Arquivo:Valores acoplados.png|centro]]<br />
<br />
Como citado anteriormente, caso a API forneça uma Authorization deve ser informada, já para as linha '''Client-Id''' e '''Client-Secret''' você deve informar os valores que a API fornece, para a chave do aplicativo já é um pouco diferente, pois para o banco do brasil em especifico, eles pedem que seja informado o valor '''gw-dev-app-key=sua_chave''', e como cada API tem seu estilo de nomeclatura, é necessário informar antes do '''gw-dev-app-key=''' o sinal de "?", mas isso pode ser preciso somente para a API do banco do brasil, talvez outras API's tratam isso de uma forma diferente.<br />
<br />
== Parametrização das Ocorrência Bancária ==<br />
Para parametrizar as ocorrências bancárias referentes as requisições por meio da API, segue a imagem abaixo:<br />
[[Arquivo:Parametrizacao Banco API.png|centro]]<br />
<br />
A nova coluna Cod.Api indica uma relação do código de retorno por arquivo com o retorno da API<br />
<br />
O tipo de ação de envio de cobrança por API permanece sendo o '''Envio_Cobranca_Api''', aonde por sua vez pode ser parametrizado com qualquer código, o motivo de ter essa ação é pelo fato de que no modo convencional de gerar as cobranças pela remessa de arquivo não criava o '''Nosso Número''', e sim somente na impressão do boleto. Como para registro de cobranças por meio da API é obrigatório o envio do '''Nosso Número''' ele é gerado assim que é gravada a remessa online, como o tipo de ação '''Envio_Cobranca_Api'''.<br />
<br />
== Formulas ==<br />
No caso do Banco do Brasil é preciso que o nosso número contenha 20 caracteres no total, sendo 7 deles o número do convênio e 10 de controle (que seria o nosso número da cobrança no ERP) e zeros a esquerda para preencher os 20 caracteres, ficando assim: 00031285570001798547, aqui está uma formula que monta esse valor.<br />
<br />
'''Nosso Número Banco do Brasil:''' NrParaTexto([[ConcatenarValores([numeroConvenio], , [[NrParaTexto({Cobranca.NossoNumero}, 10, False, 0, False)]], , , , )]], 20, False, 0, False)<br />
<br />
== Filtros Adicionais ==<br />
Cabeçalhos adicionais podem ser incluídos adicionando novos elementos na seção<br />
de cabeçalho. Devem ser adicionais de acordo com as exigências da API.<br />
<br />
<br />
'''Nome Tag''' deve ser usada quando houver tags com o mesmo nome sendo do tipo <br />
VrAcopl, por exemplo desconto e juros que possuem uma tag filha chamada 'tipo'.<br />
Se não preenchida, será usada a coluna de identificação/descrição.<br />
<br />
<br />
Exemplo utilização campo pai:<br />
<br />
desconto {<br />
'valor':1.00, (Campo pai = desconto)<br />
'vencimento':01.01.0001 (Campo <br />
pai = desconto)<br />
}<br />
<br />
<br />
Filtro de Datas<br />
dataini-nome_do_campo<br />
datafim-nome_do_campo<br />
periodo-nome_do_campo<br />
Filtro de consulta<br />
pagina-nome_do_campo<br />
situacao-nome_do_campo<br />
<br />
Ultima atualização em 10/11/2025</div>Viniciushttps://wiki.dataplussistemas.com.br/index.php?title=RN_Integracao_Magis5&diff=14651RN Integracao Magis52025-11-07T17:28:36Z<p>Vinicius: </p>
<hr />
<div>Regra de negócio do tipo habilitadora que pode ser acoplada ao [[DataPlus ERP]] e tem o objetivo configurar e manipular a integração entre API Magis5 e o DataPlusERP, podendo ser acessada pela tela de integração do sistema.<br />
<br />
== Acoplamento ==<br />
Essa regra de negócio só poder acoplada à entidade Comum.IntegracaoDadosExternos ou Infra.ControleAvisos(). Ela está preparada para funcionar com o elemento '''ExecutaOperacao''', sendo seu designador por '''Execução''' e tempo de execução '''Depois'''.<br />
<br />
Essa regra de negócio foi adaptada para também funcionar no dpServer.<br />
Quando executada pelo dpServer, seu comportamento é restrito à consulta e integração de pedidos, não abrangendo outras operações disponíveis.<br />
<br />
Além disso, algumas propriedades são exclusivas do dpServer e devem ser configuradas apenas quando a execução ocorrer nesse ambiente, como PeriodoExecucao, GerarLog e UsuariosParaNotificacao.<br />
Esses parâmetros controlam o agendamento, e notificações das execuções automáticas realizadas.<br />
<br />
== Parâmetros ==<br />
'''UrlEcommerce:''' Url do e-commerce;<br />
<br />
'''StatusPedido:''' Status do pedido (do e-commerce) a ser considerado na busca de dados: '''ready_to_print''' é o status que a Magis garante que está pronto para ser criado o pedido no ERP e faturado<br><br />
<br />
'''Token:''' Token recebido pela Magis após contratar o serviço de API (Sem esse token a integração não funciona).<br />
<br />
'''StatusCliente:''' Código do status de pessoa para clientes trazidos do e-commerce;<br />
<br />
'''RamoAtividadeCodigo:''' Código do ramo de atividade padrão para a gravação dos clientes;<br />
<br />
'''DefinirEnqFiscal:''' Define o enquadramento fiscal do cliente ao integrá-lo;<br />
<br />
'''EmpresaReceptora:''' Empresa em que a regra será executada.;<br />
<br />
'''DiasPrazoEntrega:''' Prazo de entrega padrão, a partir da emissão, para pedidos (quantidade de dias);<br />
<br />
'''SituacaoCodigo:''' Código da situação padrão para a gravação dos pedidos;<br />
<br />
'''PortadorCodigo:''' Código do portador padrão para a gravação dos pedidos;<br />
<br />
'''TransportadoraCodigo:''' Código da transportadora padrão para a gravação dos pedidos;<br />
<br />
'''OpSaidaCodigo:''' Código da operação de saída padrão para a gravação dos pedidos;<br />
<br />
'''RepresentanteCodigo:''' Código do representante padrão para a gravação dos pedidos;<br />
<br />
'''TelevendasCodigo:''' Código do televendas padrão para a gravação dos pedidos;<br />
<br />
'''CaracteristicaCodigo:''' Código da característica de venda padrão para a gravação dos pedidos;<br />
<br />
'''TipoFrete:''' Tipo de frete;<br />
<br />
'''DescontoPessoaFisica:''' Desconto para cliente pessoa física.<br />
<br />
'''CanalConfigurado:''' Informe o nome dos canais separados por vírgula. Exemplo: Shopee, Mercado Livre, Magazine Luiza. Cada nome de canal está associado à configuração de parcela única.<br />
<br />
'''ValorCanalConfigurado:''' Informe U para parcela única ou N para não parcela única, separados por vírgula e mantendo a sequência da propriedade CanalPagaParcelaUnica. Exemplo: U, N, U.<br />
<br />
'''IdsLojas:''' ID das lojas (separadas por ponto e vírgula), que são utilizadas para coleta de pedidos.<br />
<br />
<br />
'''Propriedades exclusivas para o dpServer:'''<br />
<br />
'''PeriodoExecucao:''' Período que a regra será executada. Informar em minutos ex.: 60 (dpServer).<br />
<br />
'''GerarLog:''' Gera uma log dos pedidos retornados com o mesmo nome da regra (dpServer).<br />
<br />
'''UsuariosParaNotificacao:''' Código dos usuários que receberão a notificação (Separar por vírgula Ex: 1,2,3) (dpServer)<br />
<br />
== OBSERVAÇÃO IMPORTANTE== <br />
É necessário cadastrar todas as formas de parcelamento possíveis que podem ser recebidas de cada marketplace. Para que o sistema identifique que essa condição de pagamento está vinculada à integração da Magis, a descrição deve conter o nome "magis", seguido de um traço e a quantidade de parcelas correspondentes. '''Por exemplo: magis-1x, magis-2x, magis-3x. '''Certifique-se de cadastrar todas as opções necessárias para garantir o correto funcionamento da integração.<br />
Caso não for configurado o '''CanalConfigurado''' e '''ValorCanalConfigurado''' ele vai pegar por padrao a configuração '''magis-1x'''.</div>Viniciushttps://wiki.dataplussistemas.com.br/index.php?title=RN_Integracao_Magis5&diff=14649RN Integracao Magis52025-11-06T18:26:31Z<p>Vinicius: </p>
<hr />
<div>Regra de negócio do tipo habilitadora que pode ser acoplada ao [[DataPlus ERP]] e tem o objetivo configurar e manipular a integração entre API Magis5 e o DataPlusERP, podendo ser acessada pela tela de integração do sistema.<br />
<br />
== Acoplamento ==<br />
Essa regra de negócio só poder acoplada à entidade Comum.IntegracaoDadosExternos ou Infra.ControleAvisos(). Ela está preparada para funcionar com o elemento '''ExecutaOperacao''', sendo seu designador por '''Execução''' e tempo de execução '''Depois'''.<br />
<br />
== Parâmetros ==<br />
'''UrlEcommerce:''' Url do e-commerce;<br />
<br />
'''StatusPedido:''' Status do pedido (do e-commerce) a ser considerado na busca de dados: '''ready_to_print''' é o status que a Magis garante que está pronto para ser criado o pedido no ERP e faturado<br><br />
<br />
'''Token:''' Token recebido pela Magis após contratar o serviço de API (Sem esse token a integração não funciona).<br />
<br />
'''StatusCliente:''' Código do status de pessoa para clientes trazidos do e-commerce;<br />
<br />
'''RamoAtividadeCodigo:''' Código do ramo de atividade padrão para a gravação dos clientes;<br />
<br />
'''DefinirEnqFiscal:''' Define o enquadramento fiscal do cliente ao integrá-lo;<br />
<br />
'''EmpresaReceptora:''' Empresa em que a regra será executada.;<br />
<br />
'''DiasPrazoEntrega:''' Prazo de entrega padrão, a partir da emissão, para pedidos (quantidade de dias);<br />
<br />
'''SituacaoCodigo:''' Código da situação padrão para a gravação dos pedidos;<br />
<br />
'''PortadorCodigo:''' Código do portador padrão para a gravação dos pedidos;<br />
<br />
'''TransportadoraCodigo:''' Código da transportadora padrão para a gravação dos pedidos;<br />
<br />
'''OpSaidaCodigo:''' Código da operação de saída padrão para a gravação dos pedidos;<br />
<br />
'''RepresentanteCodigo:''' Código do representante padrão para a gravação dos pedidos;<br />
<br />
'''TelevendasCodigo:''' Código do televendas padrão para a gravação dos pedidos;<br />
<br />
'''CaracteristicaCodigo:''' Código da característica de venda padrão para a gravação dos pedidos;<br />
<br />
'''TipoFrete:''' Tipo de frete;<br />
<br />
'''DescontoPessoaFisica:''' Desconto para cliente pessoa física.<br />
<br />
'''CanalConfigurado:''' Informe o nome dos canais separados por vírgula. Exemplo: Shopee, Mercado Livre, Magazine Luiza. Cada nome de canal está associado à configuração de parcela única.<br />
<br />
'''ValorCanalConfigurado:''' Informe U para parcela única ou N para não parcela única, separados por vírgula e mantendo a sequência da propriedade CanalPagaParcelaUnica. Exemplo: U, N, U.<br />
<br />
'''IdsLojas:''' ID das lojas (separadas por ponto e vírgula), que são utilizadas para coleta de pedidos.<br />
<br />
'''PeriodoExecucao:''' Período que a regra será executada. Informar em minutos ex.: 60 (dpServer).<br />
<br />
'''GerarLog:''' Gera uma log dos pedidos retornados com o mesmo nome da regra (dpServer).<br />
<br />
== OBSERVAÇÃO IMPORTANTE== <br />
É necessário cadastrar todas as formas de parcelamento possíveis que podem ser recebidas de cada marketplace. Para que o sistema identifique que essa condição de pagamento está vinculada à integração da Magis, a descrição deve conter o nome "magis", seguido de um traço e a quantidade de parcelas correspondentes. '''Por exemplo: magis-1x, magis-2x, magis-3x. '''Certifique-se de cadastrar todas as opções necessárias para garantir o correto funcionamento da integração.<br />
Caso não for configurado o '''CanalConfigurado''' e '''ValorCanalConfigurado''' ele vai pegar por padrao a configuração '''magis-1x'''.</div>Viniciushttps://wiki.dataplussistemas.com.br/index.php?title=RN_Pedido_Documento&diff=14639RN Pedido Documento2025-10-31T18:34:15Z<p>Vinicius: Criou página com 'Regra de negócio do tipo Derivação que pode ser acoplada ao DataPlus ERP e tem por objetivo gerar um documento em previsão do valor do imposto ICMSST no momento da gra...'</p>
<hr />
<div>Regra de negócio do tipo Derivação que pode ser acoplada ao [[DataPlus ERP]] e tem por objetivo gerar um documento em previsão do valor do imposto ICMSST no momento da gravação do pedido de venda. Essa regra de negócio precisa ser acoplada junto com a [[RN Pedido Duplicata Ajuste]] para seu correto funcionamento.<br />
<br />
== Acoplamento ==<br />
Essa regra de negócio deve ser acoplada à entidade Pedido de Venda (Faturamento.Pedido). Ela está preparada para funcionar com designador '''Execucao''' em conjunto com o elemento '''grava''', com o elemento de exclusão '''exclui''', com o elemento secundário '''CancelaPedido''', no tempo de execução '''Depois'''.</div>Viniciushttps://wiki.dataplussistemas.com.br/index.php?title=RN_NFEntrada_BaixaEstoqueTemporarioFornecedor&diff=14271RN NFEntrada BaixaEstoqueTemporarioFornecedor2025-08-19T15:28:15Z<p>Vinicius: Criou página com 'Regra de negócio do tipo habilitadora que pode ser acoplada ao DataPlus ERP e tem por objetivo realizar a baixa do estoque temporário que foi realizada a entrada pela AP...'</p>
<hr />
<div>Regra de negócio do tipo habilitadora que pode ser acoplada ao [[DataPlus ERP]] e tem por objetivo realizar a baixa do estoque temporário que foi realizada a entrada pela API.<br />
<br />
== Acoplamento ==<br />
Essa regra de negócio só pode ser acoplada a [[NFEntrada]]. Ela está preparada para funcionar em conjuntos com o elemento '''grava()''', designador '''Execução''' e tempo de Execução '''Depois'''.</div>Vinicius