Integrações: mudanças entre as edições
Sem resumo de edição |
|||
| (86 revisões intermediárias pelo mesmo usuário não estão sendo mostradas) | |||
| Linha 2: | Linha 2: | ||
== Banco do Brasil == | == Banco do Brasil == | ||
=== Pix === | |||
Recebimentos de pix | |||
<code> | |||
{"pix":[{"endToEndId":"E18236120202310241126s0094c62752","txid":"1110323296010000001895700011417535","valor":"4.60","componentesValor":{"original":{"valor":"4.60"}},"chave":"485e87ab-9f2c-4f18-83c9-10dbbaf35173","horario":"2023-10-24T08:26:39.00-03:00","infoPagador":"Servico Funerario de Botucatu","pagador":{"cpf":"00000000000","nome":"NOME DO PAGADOR"}}]} | |||
</code> | |||
'''Fluxo''' | |||
* Pix é pago pelo usuário | |||
* BB envia webhook | |||
* AWS - API gateway recebe o webhook (bbwh.doth.link) | |||
* SQS (filaBBPix) | |||
* Lambda (bb_MySql) | |||
'''txid''' | |||
GG.FFF.YYZZZ.TT.IIIIIIIIIII.RRRRRRRRRRR | |||
* GG - grupo econômico | |||
* FFF - 101 - unidade | |||
* YYZZZZ - 23065 - (ano/dia) | |||
* TT - 03 - tipo | |||
* IIIIIIIIIII - 00000000001 - id do pix | |||
* RRRRRRRRRRR - 00000000023 - id da referencia do pix | |||
'''Tipos de Pix''' | |||
* 01 – caixa mensalidade única | |||
* 02 – caixa mensalidades múltiplas | |||
* 03 – caixa ordem de serviço | |||
* 04 – caixa parcela única (fazer) | |||
* 05 – caixa contrato (fazer) | |||
* 06 – avulsos – ok | |||
* 07 – pré vendas – ok | |||
* 08 – clinica | |||
* 09 – exames | |||
== Conciliadora == | |||
cadastro de novo cliente | |||
suporte.conciliadora.com.br/form/4040 | |||
== ClickSign == | |||
Processo de integração para assinatura de documentos | |||
# Criar conta na clicksign | |||
# Plano de intração | |||
# Gerar novo Token | |||
# Cadastrar webhook | |||
## No webhook copiar a chave Hash | |||
=== Webhook === | |||
Retorno de eventos pré definidos | |||
'''WhatsApp''' | |||
Url base: https:/doth/apis/clicksign/whatsapp.php?g=xx | |||
<code> | |||
acceptance_term_completed | |||
acceptance_term_refused | |||
acceptance_term_canceled | |||
acceptance_term_expired | |||
acceptance_term_error | |||
attempts_by_whatsapp_exceeded | |||
acceptance_term_sent | |||
</code> | |||
== Enotas == | == Enotas == | ||
Processo de integração utilizado para emissão de nota fiscal (serviços e produtos) | |||
* A empresa deve possuir certificado digital | |||
* Para cadastro de emissão de NFC-e deve possuir o códico CSC (cadastrado no Sefaz) | |||
=== WebHook === | |||
Recebido após a emissão da nota fiscal (serviço ou produto) | |||
Documentação: https://docs.enotasgw.com.br/docs/webhook | |||
'''Headers''' | |||
* x-token - chave de validação (fixa) | |||
''' Status ''' | |||
nfeStatus": "Negada", | |||
nfeStatus": "CancelamentoNegado" | |||
'''tipo''' - NFS-e / NFC-e | |||
'''nfeIdExterno''' | |||
H.GG.FFF.T.IIIIIIIIIII.X.RRRRRRRRRRR | |||
* H - Servidor (Homologação/Produção) | |||
* GG - Grupo econôminco (000) | |||
* FFF - Unidade (000) | |||
* T - Tipo de nota: Plano, Os, Serviço, Venda, E cafe) | |||
* IIIIIIIIIII - Id do tipo (00000000000) | |||
* X - Separador (X) | |||
* RRRRRRRRRRR - Id de referência (00000000000) | |||
'''Tipos''' | |||
* P - Plano | |||
* O - Ordem de serviço | |||
* S - Serviços | |||
* V - Vendas | |||
* E - Café | |||
=== Tabelas === | |||
* P - Plano - insert tabela enotas_plns | |||
* O - Ordem de serviço - insert tabela enotas_os | |||
* S - Serviços - update tabela ordemservico_nfs | |||
* V - Vendas - update tabela ordemservico_nfs | |||
* C - Café - sem definição | |||
''' Updates ''' | |||
<code> | |||
P - | |||
O - | |||
S - UPDATE ordemservico_nfs SET status_osnfs = ?, rps_osnfs=nfeNumeroRps, numero_osnfs=nfeNumero, erie_osnfs=nfeSerieRps, chave_osnfs=nfeCodigoVerificacao WHERE id_osnfs = RRRRRRRRRRR AND os_osnfs = IIIIIIIIIII | |||
E - UPDATE cafe_vendas SET cfnum_cfvd=nfeNumero, cfserie_cfvd=nfeSerie, cfchave_cfvd=nfeChaveAcesso, cfdnfe_cfvd=nfeLinkDanfe WHERE id_cfvd = IIIIIIIIIII AND gprf_cfvd = GG | |||
</code> | |||
'''NFS-e''' | |||
<code> | |||
{ | |||
"tipo": "NFS-e", | |||
"empresaId": "string", | |||
"nfeId": "string", | |||
"nfeIdExterno": "string", | |||
"nfeStatus": "string", | |||
"nfeMotivoStatus": "string", | |||
"nfeLinkPdf": "http://api.enotasgw.com.br/file/(...)/pdf", | |||
"nfeLinkXml": "http://api.enotasgw.com.br/file/(...)/xml", | |||
"nfeNumero": "string", | |||
"nfeCodigoVerificacao": "string", | |||
"nfeNumeroRps": "string", | |||
"nfeSerieRps": "string", | |||
"nfeDataCompetencia": "date" | |||
} | |||
</code> | |||
'''NFC-e''' | |||
<code> | |||
{ | |||
"tipo": "NFC-e", | |||
"empresaId": "string", | |||
"nfeId": "001", | |||
"nfeStatus": "Autorizada", | |||
"nfeMotivoStatus": null, | |||
"nfeLinkDanfe": "http://api.enotasgw.com.br/file/(...)/pdf", | |||
"nfeLinkXml": "http://api.enotasgw.com.br/file/(...)/pdf", | |||
"nfeLinkConsultaPorChaveAcesso": "http://sistemas.sefaz.am.gov.br/nfceweb/formConsulta.do", | |||
"nfeNumero": "123", | |||
"nfeSerie": "1", | |||
"nfeChaveAcesso": "73349650010000005351606919674115087649800517", | |||
"nfeDataEmissao": "2017-01-02T17:20:32Z", | |||
"nfeDataAutorizacao": "2017-01-02T17:21:07Z", | |||
"nfeNumeroProtocolo": "353150000119390", | |||
"nfeDigestValue": "ssiUjiiOQkD2UGw" | |||
} | |||
</code> | |||
== Findcep == | |||
Api para localização de ceps e endereços | |||
Documentação: https://www.findcep.com/docs/index.html | |||
Outro: https://www.findcep.com/success | |||
== MTLS == | |||
=== Api Gateway === | |||
url: bb.doth.com.br | |||
=== Bucket S3 === | |||
versionamento: ativado | |||
colocar o arquivo | |||
=== TrustStore === | |||
* Nome: truststore.pem | |||
* Arquvivo a ser disponiblizado no S3 | |||
* Precisa estar versionado | |||
=== Conteúdo === | |||
Chave enviada pelo fornecedor (banco), unificada em um único arquivo | |||
* chave 1 - chave raiz (autoridade certificadora) | |||
* chave 2 - chave intermediaria (serasa) | |||
* chave 3 - chave privada (api.webhook...) | |||
=== BB Pix === | |||
<code> | |||
{"pix": | |||
[ | |||
{ | |||
"endToEndId":"E0000000020230102105258930087828", | |||
"txid":"1110123001010000000595500054174494", | |||
"valor":"15.00","componentesValor":[{"original":{"valor":"15.00"}}],"chave":"485e87ab-9f2c-4f18-83c9-10dbbaf35173","horario":"2023-01-02T07:53:32.00-03:00","infoPagador":"Aluguel cadeira de banho" | |||
} | |||
] | |||
} | |||
</code> | |||
== Openssl == | |||
Gerador de chave SSL | |||
=== Instalar === | |||
Baixa open ssl sourceforge | |||
#set OPENSSL_CONF=openssl.cnf | |||
#export OPENSSL_CONF=/dev/null | |||
=== Criar/configurar chave === | |||
padrao: | |||
#openssl pkcs12 -in maya.pfx -clcerts -nokeys -out maya.pem | |||
#openssl pkcs12 -in maya.pfx -nocerts -nodes -out maya.pem | |||
corrigido: | |||
#openssl pkcs12 -legacy -in certificado.pfx -clcerts -nokeys -out certificado.pem | |||
#openssl pkcs12 -legacy -in certificado.pfx -nocerts -nodes -out certificado_key.pem | |||
== PagSeguro == | |||
Processo de integração junto a PagSeguro | |||
=== Checkouts (links de pagamento) === | |||
Processo para gerar links de pagamento através do sistema | |||
a) necesário ter um token pagseguro | |||
#Acesse a sua conta PagBank; | |||
#No menu lateral, selecione Venda online; | |||
#Selecione a opção Integrações; | |||
#Clique em Gerar Token. | |||
=== Terminais POS === | |||
# Estabelecimento credenciado junto a PagSeguro | |||
# Habilitar o terminal para o aplicativo junto a PagSeguro | |||
# Solicitar exclusão do PagVendas | |||
# Cadastrar o serial do terminal no Doth | |||
== PontoMais == | == PontoMais == | ||
== Rd Station == | |||
=== Configuração === | |||
Tutorial: https://developers.rdstation.com/reference/autentica%C3%A7%C3%A3o | |||
01 - Criar aplicativo | |||
* acessar o publisher https://appstore.rdstation.com/pt-BR/publisher | |||
* criar um app privado | |||
* url callback: https://testes.doth.com.br/apis/rdstation | |||
* copiar client id e client secret | |||
02 - Executar passo 2 no navegador | |||
* url: https://api.rd.services/auth/dialog?client_id=client_id&redirect_uri=redirect_uri | |||
* obter o code | |||
03 - obter bearer | |||
* pegar codigo beare | |||
* pegar refresh token | |||
04 - refresh token | |||
* colocar no codigo do lambda | |||
=== Pré venda === | |||
Opção utilizada dentro da própria tela de pré vendas | |||
Tags: planosweb,vendas, filial, cidade (substituem as tags anteriores) | |||
Objetivos: disparo | |||
=== Planos Ativos === | |||
Opção de envio: 5.07.08.02 | |||
Tags: planos, associados, filial, cidade (substituem as tags anteriores) | |||
== Vindi == | == Vindi == | ||
| Linha 13: | Linha 326: | ||
O Doth possui integração com o software Vindi. Isso significa que quando a fatura for paga na vindi, será enviado a informação de baixa para o sistema | O Doth possui integração com o software Vindi. Isso significa que quando a fatura for paga na vindi, será enviado a informação de baixa para o sistema | ||
=== Configuração === | === Geral === | ||
Informações gerais a respeito do processo vindi | |||
==== Configuração do Cliente ==== | |||
No código externo do cliente deve estar informado o número da inscrição | |||
==== Ficha do Associado ==== | |||
# Status Recorrente: | |||
## Não, Sim (cliente cadastrado), A (assinatura ok recorrente) | |||
#Code, assinatura, cartão | |||
## code: codigo do cliente na vindi | |||
## assinatura: codigo vindi de assiantura | |||
## codigo na vidi | |||
## todos devem estar preenchidos para uma assinatura ativa | |||
=== Módulo de assinaturas === | |||
Quando já existe o plano cadastrado | |||
==== Configuração Vindi ==== | |||
# cadastro de produto | |||
## cadastro de produtona Vindi de valor 0,00 (preço fixo) | |||
## colocar o codigo do produto na tabela de filiais (vindiProduto) | |||
# cadastro de plano | |||
## cadastro de plano de assinautura na vindi sem nenhum produto | |||
## inputar o codigo na tabela de filiais (vindiPln) | |||
# chave de acesso | |||
## criar uma chave de api | |||
## inputar o codigo na tabela fiiais (vindiKey) | |||
#webhook | |||
## Criar webhook com status de fatura paga para o endereço: https://erp.doth.com.br/apis/vindi/hook.php?secret=x | |||
## Cobrança (cancelada, estornada, rejeitda) | |||
=== Funcionamento === | ==== Funcionamento ==== | ||
# A cada fatura paga será enviada a informação da baixa diretamente para o sistema | # A cada fatura paga será enviada a informação da baixa diretamente para o sistema | ||
| Linha 26: | Linha 376: | ||
Obs: é considerado como mês de pagamento o mês onde a fatura foi efetivamente lançada no cartão do cliente. | Obs: é considerado como mês de pagamento o mês onde a fatura foi efetivamente lançada no cartão do cliente. | ||
=== Módulo de Vendas === | |||
Vendas pela internet direto pelo sistema recorrente | |||
==== Vindi ==== | |||
# Produtos | |||
## É o item com o valor final | |||
# Planos | |||
# ciclo permanente - mensalidade | |||
# ciclo temporario - adesão | |||
Edição atual tal como às 15h24min de 30 de março de 2025
Processo de integração do sistema
Banco do Brasil
Pix
Recebimentos de pix
{"pix":[{"endToEndId":"E18236120202310241126s0094c62752","txid":"1110323296010000001895700011417535","valor":"4.60","componentesValor":{"original":{"valor":"4.60"}},"chave":"485e87ab-9f2c-4f18-83c9-10dbbaf35173","horario":"2023-10-24T08:26:39.00-03:00","infoPagador":"Servico Funerario de Botucatu","pagador":{"cpf":"00000000000","nome":"NOME DO PAGADOR"}}]}
Fluxo
- Pix é pago pelo usuário
- BB envia webhook
- AWS - API gateway recebe o webhook (bbwh.doth.link)
- SQS (filaBBPix)
- Lambda (bb_MySql)
txid
GG.FFF.YYZZZ.TT.IIIIIIIIIII.RRRRRRRRRRR
- GG - grupo econômico
- FFF - 101 - unidade
- YYZZZZ - 23065 - (ano/dia)
- TT - 03 - tipo
- IIIIIIIIIII - 00000000001 - id do pix
- RRRRRRRRRRR - 00000000023 - id da referencia do pix
Tipos de Pix
- 01 – caixa mensalidade única
- 02 – caixa mensalidades múltiplas
- 03 – caixa ordem de serviço
- 04 – caixa parcela única (fazer)
- 05 – caixa contrato (fazer)
- 06 – avulsos – ok
- 07 – pré vendas – ok
- 08 – clinica
- 09 – exames
Conciliadora
cadastro de novo cliente suporte.conciliadora.com.br/form/4040
ClickSign
Processo de integração para assinatura de documentos
- Criar conta na clicksign
- Plano de intração
- Gerar novo Token
- Cadastrar webhook
- No webhook copiar a chave Hash
Webhook
Retorno de eventos pré definidos
Url base: https:/doth/apis/clicksign/whatsapp.php?g=xx
acceptance_term_completed
acceptance_term_refused
acceptance_term_canceled
acceptance_term_expired
acceptance_term_error
attempts_by_whatsapp_exceeded
acceptance_term_sent
Enotas
Processo de integração utilizado para emissão de nota fiscal (serviços e produtos)
- A empresa deve possuir certificado digital
- Para cadastro de emissão de NFC-e deve possuir o códico CSC (cadastrado no Sefaz)
WebHook
Recebido após a emissão da nota fiscal (serviço ou produto)
Documentação: https://docs.enotasgw.com.br/docs/webhook
Headers
- x-token - chave de validação (fixa)
Status
nfeStatus": "Negada",
nfeStatus": "CancelamentoNegado"
tipo - NFS-e / NFC-e
nfeIdExterno
H.GG.FFF.T.IIIIIIIIIII.X.RRRRRRRRRRR
- H - Servidor (Homologação/Produção)
- GG - Grupo econôminco (000)
- FFF - Unidade (000)
- T - Tipo de nota: Plano, Os, Serviço, Venda, E cafe)
- IIIIIIIIIII - Id do tipo (00000000000)
- X - Separador (X)
- RRRRRRRRRRR - Id de referência (00000000000)
Tipos
- P - Plano
- O - Ordem de serviço
- S - Serviços
- V - Vendas
- E - Café
Tabelas
- P - Plano - insert tabela enotas_plns
- O - Ordem de serviço - insert tabela enotas_os
- S - Serviços - update tabela ordemservico_nfs
- V - Vendas - update tabela ordemservico_nfs
- C - Café - sem definição
Updates
P -
O -
S - UPDATE ordemservico_nfs SET status_osnfs = ?, rps_osnfs=nfeNumeroRps, numero_osnfs=nfeNumero, erie_osnfs=nfeSerieRps, chave_osnfs=nfeCodigoVerificacao WHERE id_osnfs = RRRRRRRRRRR AND os_osnfs = IIIIIIIIIII
E - UPDATE cafe_vendas SET cfnum_cfvd=nfeNumero, cfserie_cfvd=nfeSerie, cfchave_cfvd=nfeChaveAcesso, cfdnfe_cfvd=nfeLinkDanfe WHERE id_cfvd = IIIIIIIIIII AND gprf_cfvd = GG
NFS-e
{
"tipo": "NFS-e",
"empresaId": "string",
"nfeId": "string",
"nfeIdExterno": "string",
"nfeStatus": "string",
"nfeMotivoStatus": "string",
"nfeLinkPdf": "http://api.enotasgw.com.br/file/(...)/pdf",
"nfeLinkXml": "http://api.enotasgw.com.br/file/(...)/xml",
"nfeNumero": "string",
"nfeCodigoVerificacao": "string",
"nfeNumeroRps": "string",
"nfeSerieRps": "string",
"nfeDataCompetencia": "date"
}
NFC-e
{
"tipo": "NFC-e",
"empresaId": "string",
"nfeId": "001",
"nfeStatus": "Autorizada",
"nfeMotivoStatus": null,
"nfeLinkDanfe": "http://api.enotasgw.com.br/file/(...)/pdf",
"nfeLinkXml": "http://api.enotasgw.com.br/file/(...)/pdf",
"nfeLinkConsultaPorChaveAcesso": "http://sistemas.sefaz.am.gov.br/nfceweb/formConsulta.do",
"nfeNumero": "123",
"nfeSerie": "1",
"nfeChaveAcesso": "73349650010000005351606919674115087649800517",
"nfeDataEmissao": "2017-01-02T17:20:32Z",
"nfeDataAutorizacao": "2017-01-02T17:21:07Z",
"nfeNumeroProtocolo": "353150000119390",
"nfeDigestValue": "ssiUjiiOQkD2UGw"
}
Findcep
Api para localização de ceps e endereços
Documentação: https://www.findcep.com/docs/index.html
Outro: https://www.findcep.com/success
MTLS
Api Gateway
url: bb.doth.com.br
Bucket S3
versionamento: ativado colocar o arquivo
TrustStore
- Nome: truststore.pem
- Arquvivo a ser disponiblizado no S3
- Precisa estar versionado
Conteúdo
Chave enviada pelo fornecedor (banco), unificada em um único arquivo
- chave 1 - chave raiz (autoridade certificadora)
- chave 2 - chave intermediaria (serasa)
- chave 3 - chave privada (api.webhook...)
BB Pix
{"pix":
[
{
"endToEndId":"E0000000020230102105258930087828",
"txid":"1110123001010000000595500054174494",
"valor":"15.00","componentesValor":[{"original":{"valor":"15.00"}}],"chave":"485e87ab-9f2c-4f18-83c9-10dbbaf35173","horario":"2023-01-02T07:53:32.00-03:00","infoPagador":"Aluguel cadeira de banho"
}
]
}
Openssl
Gerador de chave SSL
Instalar
Baixa open ssl sourceforge
- set OPENSSL_CONF=openssl.cnf
- export OPENSSL_CONF=/dev/null
Criar/configurar chave
padrao:
- openssl pkcs12 -in maya.pfx -clcerts -nokeys -out maya.pem
- openssl pkcs12 -in maya.pfx -nocerts -nodes -out maya.pem
corrigido:
- openssl pkcs12 -legacy -in certificado.pfx -clcerts -nokeys -out certificado.pem
- openssl pkcs12 -legacy -in certificado.pfx -nocerts -nodes -out certificado_key.pem
PagSeguro
Processo de integração junto a PagSeguro
Checkouts (links de pagamento)
Processo para gerar links de pagamento através do sistema
a) necesário ter um token pagseguro
- Acesse a sua conta PagBank;
- No menu lateral, selecione Venda online;
- Selecione a opção Integrações;
- Clique em Gerar Token.
Terminais POS
- Estabelecimento credenciado junto a PagSeguro
- Habilitar o terminal para o aplicativo junto a PagSeguro
- Solicitar exclusão do PagVendas
- Cadastrar o serial do terminal no Doth
PontoMais
Rd Station
Configuração
Tutorial: https://developers.rdstation.com/reference/autentica%C3%A7%C3%A3o
01 - Criar aplicativo
- acessar o publisher https://appstore.rdstation.com/pt-BR/publisher
- criar um app privado
- url callback: https://testes.doth.com.br/apis/rdstation
- copiar client id e client secret
02 - Executar passo 2 no navegador
03 - obter bearer
- pegar codigo beare
- pegar refresh token
04 - refresh token
- colocar no codigo do lambda
Pré venda
Opção utilizada dentro da própria tela de pré vendas
Tags: planosweb,vendas, filial, cidade (substituem as tags anteriores)
Objetivos: disparo
Planos Ativos
Opção de envio: 5.07.08.02
Tags: planos, associados, filial, cidade (substituem as tags anteriores)
Vindi
Empresa especializada na cobrança de valores recorrentes via cartão de crédito
O Doth possui integração com o software Vindi. Isso significa que quando a fatura for paga na vindi, será enviado a informação de baixa para o sistema
Geral
Informações gerais a respeito do processo vindi
Configuração do Cliente
No código externo do cliente deve estar informado o número da inscrição
Ficha do Associado
- Status Recorrente:
- Não, Sim (cliente cadastrado), A (assinatura ok recorrente)
- Code, assinatura, cartão
- code: codigo do cliente na vindi
- assinatura: codigo vindi de assiantura
- codigo na vidi
- todos devem estar preenchidos para uma assinatura ativa
Módulo de assinaturas
Quando já existe o plano cadastrado
Configuração Vindi
- cadastro de produto
- cadastro de produtona Vindi de valor 0,00 (preço fixo)
- colocar o codigo do produto na tabela de filiais (vindiProduto)
- cadastro de plano
- cadastro de plano de assinautura na vindi sem nenhum produto
- inputar o codigo na tabela de filiais (vindiPln)
- chave de acesso
- criar uma chave de api
- inputar o codigo na tabela fiiais (vindiKey)
- webhook
- Criar webhook com status de fatura paga para o endereço: https://erp.doth.com.br/apis/vindi/hook.php?secret=x
- Cobrança (cancelada, estornada, rejeitda)
Funcionamento
- A cada fatura paga será enviada a informação da baixa diretamente para o sistema
- É realizada uma pré-baixa que fica disponível em: Processos > Externos > Importar Vindi/pago. 5.07.04. - Imporar vindi/pago
- É possível consultar as faturas em Aberto (ainda não processadas) ou Baixadas (já processadas)
- Processar as baixas
Obs: é considerado como mês de pagamento o mês onde a fatura foi efetivamente lançada no cartão do cliente.
Módulo de Vendas
Vendas pela internet direto pelo sistema recorrente
Vindi
- Produtos
- É o item com o valor final
- Planos
- ciclo permanente - mensalidade
- ciclo temporario - adesão