⚙ Funcionalidades:
Criação de pedidos | |
Criação de pedidos para clientes existentes | |
Criação de lead | |
Listagem de boletos | |
Listagem de boletos para totem | |
PDF de boleto | |
Baixa de boleto | |
Informações do cliente | |
Criação de chamado | |
Listagem de nota fiscal | |
PDF da nota fiscal | |
Listar planos do cliente | |
Listar planos bloqueados do cliente | |
Desbloqueio de confiança | |
Listar faturas do cliente | |
Editar dados do cliente | |
🔧 Configurações:
Para a configuração dessa integração é preciso criar uma automação para cada função, o guia de como configurar as automações segue abaixo
https://myog.atlassian.net/l/cp/sBcxiw2W
Cada função tem determinadas informações que podem ser usadas nas ações, as funcionalidades disponíveis, assim como informações de cada função são as seguintes:
Criação de pedido:
Entrada
ORDER order = Pedido feito pelo cliente
STRING message = mensagem com inforrmações do pedido, geralmente usado num campo de observações
Saída
{
"remote_id" = ""
"remote_message" = ""
"is_issue" = False
}
STRING remote_id = ID do pedido dentro do ERP
STRING remote_message = Resposta da API ou None
BOOL is_issue = Pedido foi aberto como chamado ou não
Este método é chamado quando um pedido é criado dentro do sistema e o cliente não é usuário do erp, ou ele é cliente do erp e a configuração Procedimento para Pedidos Migração esta em Criar Pedido/Prospecto
Criação de pedido para cliente já existente:
Entrada
ORDER order= Pedido feito pelo cliente
STRING message= Mensagem com informações do pedido, geralmente usado num campo de observações
STRING customer_document_number = CPF/CNPJ do cliente
USER wda_user = Usuário do cliente
Saída
STRING remote_id = ID do pedido no ERP
Este método é chamado quando um pedido é criado dentro do sistema e o cliente já é usuário do erp, e a configuração Procedimento para Pedidos Migração esta em Criar Chamado/Atendimento
Criação de lead:
Entrada
LEAD lead= Informações do lead gerado
Este método é chamado quando um lead é gerado durante o checkout para criar um lead dentro do ERP
Listar revendedores:
Saída
[
{
"code" = ""
"name" = ""
"taxvat" = ""
"email" = ""
}
]
STRING code = ID do revendedor no ERP
STRING name = Nome do revendedor
STRING taxvat = CPF/CNPJ do revendedor
STRING email = Email do revendedor
Este método é chamado quando se abre a página para configurar um revendedor, ele é usado para associar um revendedor no sistema datacake com o ERP
Listar produtos:
Saída
[
{
"codigo" = ""
"nome" = ""
}
]
STRING codigo = ID do produto no ERP
STRING nome = Nome do produto
Este método é chamado quando se abre a página para configurar um produto, ele é usado para associar um produto no sistema datacake com o ERP
Listar datas de vencimento:
Saída
[
{
"code" = ""
"name" = ""
}
]
STRING code = ID da data de vencimento no ERP
STRING name = Dia do vencimento
Este método é chamado quando se abre a página para configurar um vencimento de fatura, ele é usado para associar uma data de vencimento no sistema datacake com o ERP
Listar origens comerciais:
Saída
[
{
"code" = ""
"description" = ""
}
]
STRING code = ID da origem comercial no ERP
STRING description = Nome da origem comercial
Este método é chamado quando se abre a página para configurar uma origem comercial, ele é usado para associar uma origem comercial no sistema datacake com o ERP
Listar faturas:
Entrada
STRING customer_document_number = CPF/CNPJ do cliente
STRING contract_id= ID do contrato (opcional)
Saída
[
{
"document_number" = ""
"fatura" = ""
"nome_cliente" = ""
"valor_inicial" = ""
"valor_final" = ""
"juros" = ""
"multa" = ""
"emissao" = ""
"vencimento" = ""
"historico" = ""
"link_boleto" = ""
"linha_digitavel" = ""
"code_fatura" = ""
"identifier" = ""
"remote_id" = ""
"pix_code" = ""
}
]
STRING document_number = CPF/CNPJ do cliente
STRING fatura = ID da fatura
STRING nome_cliente = Nome do cliente
STRING valor_inicial = Valor inicial da fatura
STRING valor_final = Valor final da fatura
STRING juros = Juros da fatura
STRING multa = Multa da fatura
STRING emissao = Data de emissão do boleto
STRING vencimento = Data de vencimento
STRING historico = ID ou nome do plano
STRING link_boleto = url do boleto (usa a função “Pegar pdf de um boleto“ se estiver vazio)
STRING linha_digitavel = Código da linha digitável, usado para criar o código de barra no boleto do totem
STRING code_fatura = Código da fatura no ERP
STRING identifier = Identificador de qual método pix utilizar, caso haja vários configurados
STRING remote_id = ID do boleto no ERP
STRING pix_code = Código do pix pra ser usado nesse boleto, usa o configurado no sistema se estiver vazio
Este método é chamado nas listagem de boleto, tanto do site, quanto do app e do totem, deve retornar as faturas do cliente no ERP
Pegar pdf de um boleto:
Entrada
STRING boleto_id= ID do boleto no ERP
Saída
STRING base_64 = string contendo o pdf do boleto em formato de base64
Este método é chamado quando o cliente quer acessar o pdf de uma fatura e o campo link_boleto da fatura veio vazio, tanto do site, quanto do app e do totem, o aplicativo pode exigir esse método por questões de segurança para não acessar um link fora do sistema.
Pegar uma fatura pelo ID:
Entrada
STRING customer_bill_id= ID do boleto no ERP
STRING customer_document_number = CPF/CNPJ do cliente
Saída
[
{
"document_number" = ""
"fatura" = ""
"nome_cliente" = ""
"valor_inicial" = ""
"valor_final" = ""
"juros" = ""
"multa" = ""
"emissao" = ""
"vencimento" = ""
"historico" = ""
"link_boleto" = ""
"linha_digitavel" = ""
"code_fatura" = ""
"identifier" = ""
"remote_id" = ""
"pix_code" = ""
}
]
STRING document_number = CPF/CNPJ do cliente
STRING fatura = ID da fatura
STRING nome_cliente = Nome do cliente
STRING valor_inicial = Valor inicial da fatura
STRING valor_final = Valor final da fatura
STRING juros = Juros da fatura
STRING multa = Multa da fatura
STRING emissao = Data de emissão do boleto
STRING vencimento = Data de vencimento
STRING historico = ID ou nome do plano
STRING link_boleto = url do boleto (usa a função “Pegar pdf de um boleto“ se estiver vazio)
STRING linha_digitavel = Código da linha digitável, usado para criar o código de barra no boleto do totem
STRING code_fatura = Código da fatura no ERP
STRING identifier = Identificador de qual método pix utilizar, caso haja vários configurados
STRING remote_id = ID do boleto no ERP
STRING pix_code = Código do pix pra ser usado nesse boleto, usa o configurado no sistema se estiver vazio
Este método é usado na listagem de faturas do totem e na baixa de fatura, funciona de forma similar ao Listar faturas, porém deve retornar apenas a fatura que o id é igual ao customer_bill_id
Baixa de boleto:
Entrada
TRANSACTION transaction= Transação do boleto que foi pago
STRING boleto_id = ID do boleto que foi pago
STRING customer_document_number = CPF/CNPJ do cliente
Saída
{
"success" = Booleano falando se a baixa foi um sucesso ou não
"api_response" = Resposta completa da api, independente se deu certo ou não
}
BOOL success = Booleano falando se a baixa foi um sucesso ou não
STRING api_response = Resposta completa da api, independente se deu certo ou não
Este método é chamado quando uma fatura é paga pelo sistema (pix se ele foi integrado com o banco e TEF), usado para dar baixa em uma fatura dentro do erp
Pegar contatos do cliente (email, celular):
Entrada
STRING customer_document_number = CPF/CNPJ do cliente
Saída
[
{
type = ""
value = ""
}
]
STRING type = Tipo do contato, os valores podem ser "email" ou "phone"
STRING value = String contendo o contato do cliente
Este método é chamado para compartilhar faturas, criar conta no app e alguns outros pontos que precisam do contato do cliente, ele deve retornar os contatos (email, celular) do cliente do ERP
Pegar texto para avaliar pendência interna:
Entrada
STRING customer_document_number = CPF/CNPJ do cliente
Saída
[
“mensagem de pendencia interna“,
“outra mensagem de pendencia interna“
]
Este método é chamado para fazer a validação de pendência interna do cliente dentro do ERP, ele deve retornar as mensagens que vão ser avalidadas para saber se aquele cliente já tem uma pendência com o provedor, caso o cliente não esteja no ERP ou não tenha pendencias com o provedor esse método deve retornar uma lista vazia
Adicionar Comentário