Integração
Como o seu sistema conversa com os serviços da MEDAN: a API da Mensageria WhatsApp, para enviar mensagens, e a do MemoDocs, para levar as notas recebidas ao ERP. Em linguagem simples.
Mensageria WhatsApp: o caminho de um envio
Uma API HTTP comum, que qualquer linguagem chama. O pedido volta na hora com um protocolo, e a mensagem sai por uma fila, com novas tentativas automáticas e limite de ritmo.
Identifique o sistema
Cada chamada leva a chave de acesso do sistema no cabeçalho
X-Api-Key. A chave aparece uma vez só, quando é criada.Veja antes de enviar
A pré-visualização recebe o mesmo pedido de um envio e devolve o texto pronto, sem enviar nada.
Envie
Um modelo aprovado pela Meta, com os campos preenchidos, ou texto livre se a janela de 24 h com o cliente estiver aberta.
Sem duplicidade
Todo envio leva uma chave de idempotência (
Idempotency-Key). Repetir o pedido devolve o protocolo do primeiro.Acompanhe o status
Consulte uma mensagem, peça só o que mudou desde a última consulta ou receba um aviso assinado a cada mudança.
Receba as respostas
As mensagens que os clientes mandam de volta ficam disponíveis para o sistema, pela consulta ou pelo aviso.
Bom saber antes da primeira chamada
O telefone vai com DDD, com ou sem o +55. Texto livre fora da janela de 24 h é recusado com o motivo; para começar a conversa, use um modelo aprovado.
Quando algo dá errado, a resposta diz o porquê em código legível: contato que pediu para sair, modelo com problema, destinatário indisponível. O sistema decide o que fazer com cada caso.
O aviso de status é assinado, para o seu sistema conferir que veio mesmo da Mensageria. Consultar a API continua valendo, mesmo com o aviso ligado.
- Chave
X-Api-Key, uma por sistema- Duplicidade
Idempotency-Keyem todo envio- Delphi
- Unidade pronta, sem DLL extra
- .NET
- Exemplo de integração
- Retorno
- Consulta ou aviso assinado
MemoDocs: as notas recebidas no seu ERP
A coleta roda nos servidores do MemoDocs. O seu ERP só busca o que é novo, por uma API com chave de acesso e conexão criptografada (HTTPS).
Liste os pendentes
O ERP pergunta quais documentos da empresa ainda não foram importados.
Baixe os XMLs num ZIP
Os pendentes chegam juntos, num arquivo só.
Marque como processados
O que foi importado não volta na próxima lista. Nenhuma nota entra duas vezes, nenhuma fica de fora.
ERP instalado no computador
O agente MemoDocs Sync, para Windows, baixa os XMLs novos para o computador da empresa ou do contador e se atualiza sozinho. Serve inclusive para sistemas antigos.
Aviso do certificado
Além do e-mail, o ERP integrado pode receber o aviso de vencimento do certificado A1, para ninguém ser pego de surpresa.
Como começar
Conte o que vai integrar
Qual sistema, em que linguagem e o que ele precisa enviar ou receber.
Receba a chave de acesso
Uma por sistema. Se ela vazar, uma chave nova cancela a anterior na hora.
Faça a primeira chamada
Comece pela pré-visualização na Mensageria ou pela lista de pendentes no MemoDocs.
Perguntas frequentes
-
Preciso de uma biblioteca especial para usar a Mensageria?
Não. É uma API HTTP comum, que qualquer linguagem chama. Para Delphi há uma unidade pronta, sem DLL extra, e para .NET há um exemplo de integração.
-
Como evito enviar a mesma mensagem duas vezes?
Cada envio leva uma chave de idempotência. Se o mesmo pedido chegar de novo, a Mensageria devolve o protocolo do primeiro em vez de mandar outra mensagem.
-
Como o meu sistema fica sabendo do status?
Consultando a API, mensagem a mensagem ou só o que mudou desde a última consulta, ou recebendo um aviso assinado a cada mudança de status e a cada resposta do cliente.
-
Como o ERP recebe as notas do MemoDocs?
Pela API, o ERP lista os documentos pendentes, baixa os XMLs num ZIP e marca como processados. Para ERP instalado no computador, o agente MemoDocs Sync baixa os XMLs para uma pasta.
-
Preciso instalar alguma coisa para o MemoDocs funcionar?
Não. A coleta roda nos servidores do MemoDocs e você acompanha pelo portal. O MemoDocs Sync é opcional, para quem quer os XMLs também no computador.
-
Como consigo uma chave de acesso?
Fale com a MEDAN. Na Mensageria, cada sistema recebe a sua chave, mostrada uma vez só; se ela vazar, uma chave nova cancela a anterior na hora.