Ativação eSales

Entre em contato com a instituição bancária para solicitar o ID Token e o ID Secret. Como apoio para esta ação, nosso parceiro eSales disponibiliza os seguintes materiais:

• Manual Cobranças Pix - Banco do Brasil
• Manual Cobranças Pix - Itaú, Bradesco e Santander

Crie uma Chave de acesso e Secret, para que o parceiro consiga se autenticar na nossa plataforma e chamar as primitivas de retorno.

Para isso, siga os passos abaixo: 

1. Acesse Tecnologia > Administração > Gerenciamento de Aplicações;
2. Clique em Nova aplicação;
3. Preencha os campos Nome e Descrição;
4. No campo Geração de tokens, recomendamos utilizar a opção Reutilizar o mesmo token para as múltiplas sessões da aplicação. Deste modo, não há necessidade de os integradores chamarem a autenticação na plataforma a cada sessão, pois os tokens recebem a validade de uma semana.
5. Ao clicar em Salvar, o sistema exibe os campos Chave de acesso e o Secret com as informações correspondentes.

Para que seja possível utilizar a plataforma integrada com o parceiro eSales, é necessário a criação de um papel com as devidas permissões. Esse papel é o responsável por liberar apenas as APIs necessárias para os usuários que estiverem vinculados a ele. Veja abaixo como proceder:

1. Acesse Tecnologia > Administração > Autorização > Gestão de Papéis;
2. Clique em Novo papel;
3. Informe os campos Nome do papel e Descrição do papel;
4. Clique em Salvar;
5. Acesse a guia Permissões;
6. Na opção Agrupar por, selecione Serviço;
7. Preencha o campo Pesquisar domínios / serviços com a informação erpx_bnk e clique em Filtrar;
8. O sistema lista os serviços de acordo com o termo filtrado. Clique no botão para expandir. Você deve ativar as opções de cada recurso conforme indicado na tabela erpx_bnk;
9. Ao finalizar o passo anterior, retorne ao campo Pesquisar domínios / serviços, informe o domínio e serviço platform / events_hub e clique em Filtrar;
10. O sistema lista os serviços de acordo com o termo filtrado. Clique no botão para expandir. Você deve ativar as opções de cada recurso conforme indicado na tabela platform / events_hub;
11. Clique em Salvar.

Tabelas

erpx_bnk

Domínio / Serviço	Permissão
erpx_bnk / foundation	Primitiva responsável pelo retorno se o cliente possui a conta bancária implantada no banking res://senior.com.br/erpx_bnk/foundation/queries/listServiceStatusReceivable
erpx_bnk / onboarding	autenticacaoBtg res://senior.com.br/erpx_bnk/onboarding/entities/autenticacaoBtg
erpx_bnk / onboarding	autenticacaoBtgHistorico res://senior.com.br/erpx_bnk/onboarding/entities/autenticacaoBtgHistorico
erpx_bnk / onboarding	Primitiva responsável por gerar a url de consentimento com o banco BTG res://senior.com.br/erpx_bnk/onboarding/actions/gerarUrlConsentimentoBtg
erpx_bnk / onboarding	Primitiva responsável por gerar os tokens de autenticação com o banco BTG res://senior.com.br/erpx_bnk/onboarding/actions/gerarAutenticacaoBtg
erpx_bnk_cob / boleto	cobrancaDadosBoleto res://senior.com.br/erpx_bnk_cob/boleto/entities/cobrancaDadosBoleto
erpx_bnk_cob / boleto	cobrancaItemBoleto res://senior.com.br/erpx_bnk_cob/boleto/entities/cobrancaItemBoleto
erpx_bnk_cob / boleto	cobrancaItemBoletoDescontoDataFixa res://senior.com.br/erpx_bnk_cob/boleto/entities/cobrancaItemBoletoDescontoDataFixa
erpx_bnk_cob / boleto	cobrancaItemBoletoErro res://senior.com.br/erpx_bnk_cob/boleto/entities/cobrancaItemBoletoErro
erpx_bnk_cob / boleto	cobrancaItemBoletoHistorico res://senior.com.br/erpx_bnk_cob/boleto/entities/cobrancaItemBoletoHistorico
erpx_bnk_cob / boleto	cobrancaItemBoletoHistoricoMotivoOcorrencia res://senior.com.br/erpx_bnk_cob/boleto/entities/cobrancaItemBoletoHistoricoMotivoOcorrencia
erpx_bnk_cob / boleto	cobrancaItemBoletoMensagem res://senior.com.br/erpx_bnk_cob/boleto/entities/cobrancaItemBoletoMensagem
erpx_bnk_cob / boleto	cobrancaItemBoletoRegistro res://senior.com.br/erpx_bnk_cob/boleto/entities/cobrancaItemBoletoRegistro
erpx_bnk_cob / boleto	e001pes res://senior.com.br/erpx_bnk_cob/boleto/entities/e001pes
erpx_bnk_cob / boleto	e006pai res://senior.com.br/erpx_bnk_cob/boleto/entities/e006pai
erpx_bnk_cob / boleto	e007ufs res://senior.com.br/erpx_bnk_cob/boleto/entities/e007ufs
erpx_bnk_cob / boleto	e008rai res://senior.com.br/erpx_bnk_cob/boleto/entities/e008rai
erpx_bnk_cob / boleto	e085pes res://senior.com.br/erpx_bnk_cob/boleto/entities/e085pes
erpx_bnk_cob / boleto	Item da operação de registro boleto res://senior.com.br/erpx_bnk_cob/boleto/entities/operacaoItemBoleto
erpx_bnk_cob / boleto	motivoOcorrenciaBanco res://senior.com.br/erpx_bnk_cob/boleto/entities/motivoOcorrenciaBanco
erpx_bnk_cob / boleto	ocorrenciaBanco res://senior.com.br/erpx_bnk_cob/boleto/entities/ocorrenciaBanco
erpx_bnk_cob / boleto	Operações de registro boleto res://senior.com.br/erpx_bnk_cob/boleto/entities/operacaoBoleto
erpx_bnk_cob / boleto	Primitiva de listagem dos títulos de cobrança boleto res://senior.com.br/erpx_bnk_cob/boleto/queries/listTitulosCobrancaBoleto
erpx_bnk_cob / boleto	Primitiva responsável pelas informações de acompanhamento da cobrança boleto res://senior.com.br/erpx_bnk_cob/boleto/queries/getAcompanhamentoCobrancaBoleto
erpx_bnk_cob / boleto	Primitiva responsável por retornar todas as informações relacionadas a um título de cobrança boleto res://senior.com.br/erpx_bnk_cob/boleto/queries/getDetal
erpx_bnk_cob / cobranca	API responsável pelo retorno da criação do registro de cobrança assíncrona do parceiro BTG res://senior.com.br/erpx_bnk_cob/cobranca/actions/retornoCobrancaBoletoBtg
erpx_bnk_cob / cobranca	API responsável pelo retorno da criação do registro e pagamento de cobrança assíncrona do parceiro eSales res://senior.com.br/erpx_bnk_cob/cobranca/actions/retornoCobrancaESales
erpx_bnk_cob / cobranca	Entidade de dados da cobrança de boleto res://senior.com.br/erpx_bnk_cob/cobranca/entities/cobrancaDadosBoleto
erpx_bnk_cob / cobranca	Entidade de dados do título de cobrança de boleto res://senior.com.br/erpx_bnk_cob/cobranca/entities/cobra
erpx_bnk_cob / database	asyncBatches res://senior.com.br/erpx_bnk_cob/database/entities/asyncBatches
erpx_bnk_cob / database	asyncReceivedMessage res://senior.com.br/erpx_bnk_cob/database/entities/asyncReceivedMessage
erpx_bnk_cob / database	asyncTransactions res://senior.com.br/erpx_bnk_cob/database/entities/asyncTransactions
erpx_bnk_cob / database	asyncTransactionsLog res://senior.com.br/erpx_bnk_cob/database/entities/asyncTransactionsLog
erpx_bnk_cob / pix	API pública responsável pela geração de cobrança do PIX res://senior.com.br/erpx_bnk_cob/pix/actions/registerPixBilling
erpx_bnk_cob / pix	API responsável pelo cancelamento do registro de cobrança do PIX res://senior.com.br/erpx_bnk_cob/pix/actions/cancelPixBilling
erpx_bnk_cob / pix	cancelamentoItemPix res://senior.com.br/erpx_bnk_cob/pix/entities/cancelamentoItemPix
erpx_bnk_cob / pix	cancelamentoPix res://senior.com.br/erpx_bnk_cob/pix/entities/cancelamentoPix
erpx_bnk_cob / pix	cobrancaDadosPix res://senior.com.br/erpx_bnk_cob/pix/entities/cobrancaDadosPix
erpx_bnk_cob / pix	cobrancaItemPix res://senior.com.br/erpx_bnk_cob/pix/entities/cobrancaItemPix
erpx_bnk_cob / pix	cobrancaItemPixErro res://senior.com.br/erpx_bnk_cob/pix/entities/cobrancaItemPixErro
erpx_bnk_cob / pix	cobrancaItemPixHistorico res://senior.com.br/erpx_bnk_cob/pix/entities/cobrancaItemPixHistorico
erpx_bnk_cob / pix	cobrancaItemPixRegistro res://senior.com.br/erpx_bnk_cob/pix/entities/cobrancaItemPixRegistro
erpx_bnk_cob / pix	descontoDataFixa res://senior.com.br/erpx_bnk_cob/pix/entities/descontoDataFixa
erpx_bnk_cob / pix	e001pes res://senior.com.br/erpx_bnk_cob/pix/entities/e001pes
erpx_bnk_cob / pix	e006pai res://senior.com.br/erpx_bnk_cob/pix/entities/e006pai
erpx_bnk_cob / pix	e007ufs res://senior.com.br/erpx_bnk_cob/pix/entities/e007ufs
erpx_bnk_cob / pix	e008rai res://senior.com.br/erpx_bnk_cob/pix/entities/e008rai
erpx_bnk_cob / pix	e070emp res://senior.com.br/erpx_bnk_cob/pix/entities/e070emp
erpx_bnk_cob / pix	e070fil res://senior.com.br/erpx_bnk_cob/pix/entities/e070fil
erpx_bnk_cob / pix	e085pes res://senior.com.br/erpx_bnk_cob/pix/entities/e085pes
erpx_bnk_cob / pix	informacoesAdicionaisPix res://senior.com.br/erpx_bnk_cob/pix/entities/informacoesAdicionaisPix
erpx_bnk_cob / pix	Primitiva de listagem dos títulos na tela de cobranças PIX res://senior.com.br/erpx_bnk_cob/pix/queries/listTitulosCobrancaPix
erpx_bnk_cob / pix	Primitiva responsável pelas informações do acompanhamento da tela de cobranças PIX res://senior.com.br/erpx_bnk_cob/pix/queries/getAcompanhamentoCobrancaPix
erpx_bnk_cob / pix	Primitiva responsável pelos detalhes do título res://senior.com.br/erpx_bnk_cob/pix/queries/getDetalhe
erpx_bnk_cob / register_boleto	Execução de operações sobre o registro de cobrança do boleto res://senior.com.br/erpx_bnk_cob/register_boleto/actions/
erpx_bnk_cob / register_boleto	Geração de cobrança do boleto res://senior.com.br/erpx_bnk_cob/register_boleto/actions/registerBankSlipBilling
erpx_bnk_cob / register_pix	API pública responsável pela geração de cobrança do PIX res://senior.com.br/erpx_bnk_cob/register_pix/actions/registerPixBilling
erpx_bnk_cob / register_pix	API responsável pelo cancelamento do registro de cobrança do PIX res://senior.com.br/erpx_bnk_cob/register_pix/actions/cancelPixBilling
erpx_bnk_cob / register_pix	cancelamentoPix res://senior.com.br/erpx_bnk_cob/register_pix/entities/cancelamentoPix
erpx_bnk_cob / register_pix	cobrancaDadosPix res://senior.com.br/erpx_bnk_cob/register_pix/entities/cobrancaDadosPix
erpx_bnk_cob / register_pix	cobrancaItemPix res://senior.com.br/erpx_bnk_cob/register_pix/entities/cobrancaItemPix
erpx_bnk_cob / register_pix	e070emp res://senior.com.br/erpx_bnk_cob/register_pix/entities/e070emp
erpx_bnk_cob / register_pix	e070fil res://senior.com.br/erpx_bnk_cob/register_pix/entities/e07

platform / events_hub

Domínio / Serviço	Permissão
platform / events_hub	Webhook res://senior.com.br/platform/events_hub/webhook

Agora, é necessário vincular o papel criado à aplicação criada nos passos anteriores. Para isso, siga os passos abaixo:

1. Acesse Tecnologia > Administração > Autorização > Gestão de Papéis;
2. Em Pesquisar papéis, digite o nome do papel criado anteriormente;
3. Localize o papel e clique em Editar;
4. Acesse a guia Aplicações;
5. Localize na lista de aplicações a aplicação criada anteriormente, e ative a associação;
6. Clique em Salvar.

Após isso, é preciso habilitar os recursos que necessitam de acesso. Para isso, acesse a guia Permissões e siga os passos abaixo:

1. Em Agrupar por, selecione a opção Serviço;
2. Preencha o campo de pesquisa com erpx_bnk, para que sejam listados todos os serviços do Banking;
3. Em cada serviço listado, clique no botão para expandir, e habilite todas as opções para Processar e Visualizar;
4. Clique em Salvar.

Por fim, é preciso vincular os acessos do webhook, conforme demonstrado abaixo:

1. Ainda na guia Permissões, mantenha a opção Agrupar por como Serviço;
2. Preencha o campo de pesquisa com events;
3. No serviço listado platform / events_hub, clique no botão para expandir e habilite todas as opções.

Para testar as credenciais e garantir o correto funcionamento antes de configurar o eSales, siga os seguintes passos:

1. Primeiro, é necessário chamar a primitava loginWithKey e informar os campos abaixo:
   • accessKey: valor da Chave de Acesso configurado;
   • secret: valor do Secret;
   • tenantName: nome do tenant.
2. Caso a chamada retorne corretamente o token gerado, é possível dar continuidade no processo:

cURL da requisição

curl --location 'https://platform.senior.com.br/t/senior.com.br/bridge/1.0/anonymous/rest/platform/authentication/actions/loginWithKey' \
--header 'Content-Type: application/json' \
--data '{
    "accessKey": "e6cc9508-0215-4ad5-97e7-ba134ce2cabe",
    "secret": "4ea9c0a3-cc72-4ee7-b944-f19ba3ea518d",
    "tenantName": "testeserpxcombr"
}'

Veja um exemplo de caso de sucesso:

É necessário cadastrar o parceiro no portal da Theke da eSales. Para isso, siga os passos abaixo:

1. Acesse o porta da Theke da eSales;
2. Acesse o menu Parceiros;
3. Clique em Adicionar parceiro;
4. Adicione o CNPJ e a Razão Social;

É preciso informar o ID Token e o ID Secret ao parceiro eSales, para que seja possível cadastrar na solução e estabelecer a conexão com a instituição bancária.

Deste modo, as informações abaixo precisam ser enviadas para o contato implantacoes.theke@esales.com.br com cópia para theke.apis@esales.com.br :

• CNPJ da empresa;
• Razão social;
• Banco;
• Agência + dígito;
• Conta + dígito;
• Chave PIX;
• Client ID;
• Token temporário.

Exemplos de e-mails

Banco Itaú:

Título do e-mail: Implantação Cobrança PIX - Theke APIs

Dados do cliente

CNPJ:

Razão Social:

Dados bancários

Banco:

Agência + dígito:

Conta + dígito

Chave PIX:

Credencial bancária

Cliente ID:

Token temporário:

Banco do Brasil:

Título do e-mail: Implantação Cobrança PIX - Theke APIs

Dados do cliente

CNPJ:

Razão Social:

Dados bancários

Banco:

Agência + dígito:

Conta + dígito

Chave PIX:

Credencial bancária

Cliente ID:

Token temporário:

Developer key:

Anexar no e-mail certificado digital e-CNPJ a1 do cliente

Outros bancos

Título do e-mail: Implantação Cobrança PIX - Theke APIs

Dados do cliente

CNPJ:

Razão Social:

Dados bancários

Banco:

Agência + dígito:

Conta + dígito

Chave PIX:

Credencial bancária

Cliente ID:

Token temporário:

Anexar no e-mail certificado digital e-CNPJ a1 do cliente

1. Acesse o portal do eSales e localize o parceiro do cliente. Cada cliente deve ter um usuário criado dentro do portal.

   

2. Configure no portal do eSales a autenticação para a nossa plataforma.
3. É necessário informar a URL, os dados para autenticação, e a API Webhook para o retorno do registro de cobrança e de pagamento.
   • API Login:
     • URL: https://platform.senior.com.br/t/senior.com.br/bridge/1.0/anonymous/rest/platform/authentication/actions/loginWithKey
     • Payload já contendo as credenciais do cliente:

     
     {
         "accessKey": "<ACCESS_KEY GERADA NO PASSO 2>",
         "secret": "<SECRET GERADA NO PASSO 2>",
         "tenantName": "<TENANT DO CLIENTE>"
     }
     

4. Crie no portal do eSales um novo webhook passando as informações da URL de autenticação e o Payload.

   

5. Veja as URLs que serão utilizadas para o webhook do eSales:
   • Cobrança: https://platform.senior.com.br/t/senior.com.br/bridge/1.0/rest/erpx_bnk_cob/cobranca/actions/retornoCobrancaESales
   • Pagamento: https://platform.senior.com.br/t/senior.com.br/bridge/1.0/rest/erpx_bnk_pag/pagamento/actions/retornoPagamentoESales

1. Após receberem as informações, os parceiros devem retornar o clientId e o clientSecret, que são as credenciais para autenticação em suas plataformas.
• Para autenticar, acesse no portal eSales acesse o menu Aplicações, conforme imagem abaixo:



2. Após isso, é necessário utilizar o evento iniciarIntegracaoESales e criar um webhook para os endpoints utilizados pelo banking.
   • Para realizar esta ação, chame a primitiva createWebhook, conforme cURL abaixo:

curl --location 'https://platform.senior.com.br/t/senior.com.br/bridge/1.0/rest/platform/events_hub/actions/createWebhook' \
--header 'Authorization: bearer qG8bzZgLvqGN8Pi7zv7Eun3kR4FISDoY' \
--header 'Content-Type: application/json' \
--header 'Cookie: TS0122123d=01a760ec21cfd61dc85ebdbede76781725546137a32a42ecdcaf19773def3f378c3028c1bb6c1543d5adc33e2b12e09643e4ae47c3; TS0122123d030=01686c63805c244db7cf84151ede5166a1992a278e224b8ed630523ee71363091720a704f72ce6b134fbc7893253a17595cb9b3009' \
--data '{
    "event": {
        "domainName": "erpx_bnk_cob",
        "serviceName": "pix",
        "primitiveName": "iniciarIntegracaoESales"
    },
    "endpoints": [
        {
            "url": "https://api-finance.theke.com.br/v1/cobrancas",
            "active": true,
            "headers": [
                {
                    "key": "X-Send-Async",
                    "value": "true"
                }
            ],
            "applyRetry": false,
            "authByEndpoint": true,
            "ignoreHttpCode": [],
            "authSettings": {
                "authTestSuccess": true,
                "url": "https://api-finance.theke.com.br/v1/autenticacao/parceiros/token",
                "headers": [],
                "payload": [
                    {
                        "key": "clientId",
                        /"value": "<CLIENTE_ID DISPONIBILIZADO PELA ESALES>"
                    },
                    {
                        "key": "clientSecret",
                        /"value": "CLIENTE_SECRET DISPONIBILIZADO PELA ESALES"
                    }
                ],
                "payloadFilters": [
                    {
                        "key": "TOKEN",
                        "value": "$.token"
                    },
                    {
                        "key": "VALID_FOR_SECONDS",
                        "value": "$.validForSeconds"
                    }
                ],
                "refreshToken": {
                    "url": "",
                    "payload": []
                }
            }
        }
    ]
}'

Veja um exemplo de chamada de sucesso para a criação do webhook:

Realize as parametrizações abaixo para habilitar o cancelamento da conbrança Pix:

1. Acesse Tecnologia > Configuração > Por tenant;
2. Com a barra de rolagem, desça a tela até a sessão de Domínios e Serviços;
3. Preencha o campo Filtrar domínios com erpx_bnk;
4. Acesse o registro erpx_bnk, e clique no botão Editar do serviço foundation;
5. Na tela Propriedades, acesse a guia Sistema e preencha os campos abaixo com as informações recebidas pela eSales:
   • Credencial eSales – ClientId: preencha com o clientId informado pela eSales;
   • Credencial eSales – ClientSecret: preencha com o clientSecret informado pela eSales;
   • Credencial eSales – Produção habilitada: selecione a opção Verdadeiro;
6. Clique no botão Salvar.

Realize testes para verificar se a integração está funcionando corretamente.