Este documento traz as especificações técnicas para chamada da API “DigitalPostman” que faz disparos de arquivos via canal Whatsapp utilizando a plataforma Carteiro Digital.
AUTENTICAÇÃO #
Para efetuar chamadas em nosso portal de integrações o primeiro passo é a obtenção do Token de acesso. Para isto, deverá ser utilizada a seguinte requisição do tipo POST:
URL: https://api.robbu.global/v1/login
Body:
{
“Company”: “#####”,
“Username”: “#####”,
“Password”: “#####”
}
ESPECIFICAÇÕES DO BODY #
ESPECIFICAÇÕES DO BODY
{
“Company“: “Nome da empresa utilizado no login do ambiente“,
“Username“: ” NomeUsuarioAPI“,
“Password“: ” SenhaUsuarioAPI“
}
Informações utilizadas na tela inicial de login da Invenio
https://accounts.robbu.global/
Obs: O usuário deve ser do grupo de acesso Integração API
Obs: Não é obrigatório gerar um novo token a cada disparo de documento, pois o próprio
campo “expires_in” traz a quantidade em segundos de sua validade (porém por padrão
podem considerar como limite, a expiração do token em 3333 dias). Caso nossa API de
envio de boletos retorne “title”: “Unauthorized” é necessário renovar o TOKEN.
Uma vez criado um token, todos disparos de boletos pela rota /digitalpostman devem
utilizar o mesmo token, a renovação só é necessário caso API retorne não autorizado.
ENVIO BOLETOS #
Para efetuar o envio de boletos deverá ser utilizada a seguinte requisição do tipo POST:
URL: https://api.robbu.global/v2/digitalpostman
BODY #
{
"senderName": "",
"contactName": "",
"contactId": "",
"walletCode": "",
"contactPhoneNumber": "",
"invalidTokenMessage": "",
"instructionsMessage": "",
"documentCollection": [
{
"documentCode": "",
"documentFileName": "",
"documentBase64": ""
}
]
}
ESPECIFICAÇÕES DO BODY #
SenderName: Nome do usuário remetente, pode ser o próprio CPF do usuário.(Obrigatório)
ContactName: Nome do destinatário que receberá o arquivo. (Obrigatório)
ContactId: CPF/CNPJ do destinatário. Os 3 primeiros digitos do CPF/CNPJ são o token de confirmação para recebimento do arquivo.(Obrigatório)
Exemplo: 11122233344
O Token de confirmação é 111
WalletCode: Identificador da Carteira(Segmento), cadastrado pelo cliente dentro do Invenio. (Obrigatório)
ContactPhoneNumber: Telefone do destinatário. (Obrigatório)
InvalidTokenMessage: Mensagem a ser enviada caso o usuário digite uma opção inválida.
Obs: Para realizar a quebra de linha tanto para o InvalidTokenMessage quanto para o InstructionsMessage, basta utilizar \r\n para cada quebra de linha desejada.
Exemplo: “Agradecemos o seu contato!\r\n\r\nAqui estão os nossos canais de atendimento, qualquer dúvida ou dificuldade é só chamar:”
Para personalizar a mensagem com emojis:
Os Emojis também são caracteres do UTF-8. Por exemplo, o rostinho feliz 😀tem o código 128512, e para usar basta colocar o código 😀 nesse formato, sempre começando com &# e terminando com ponto e vírgula para código decimal. Em hexadecimal, comece com &#x.Exemplo:
Exemplo: “instructionsMessage”: “*Tem dúvidas? Fale com a Robbu:😀*\r\n📞551131362846”,
obs: O emoji exibido pode variar conforme o valor esperado pela API do WhatsApp (Meta). Recomendamos testar diferentes opções para verificar qual se adapta melhor à sua mensagem.
InstructionsMessage: Mensagem de instrução enviada antes da linha digitavel e do PDF.
DocumentCollection: Destinada a informações do documento a ser enviado.
DocumentCollection.DocumentCode: Linha digitavel(Cód.Barras) do boleto.
DocumentCollection.FileName: Nome que será apresentado no arquivo junto a sua extensão: (Obrigatório)
Exemplo: Arquivo.pdf
DocumentCollection.DocumentBase64: Base 64 do boleto a ser enviado. (Obrigatório)
RESPONSE DAS CHAMADAS #
A chamada possuirá os seguintes códigos de retorno:
200: A mensagem foi enviada corretamente
400: Parâmetros incorretos
500: Algum erro ocorrido no processo de envio.
EXEMPLO DE REQUISIÇÃO #
{
"senderName": "Robbu",
"contactName": "Robbu Teste",
"contactId": "11122233344",
"walletCode": "Carteira Teste",
"contactPhoneNumber": 5531993307121,
"invalidTokenMessage": "Opção inválida!\r\n\r\nAqui estão os nossos canais de atendimento, qualquer dúvida ou dificuldade é só chamar:\r\n\r\n*Robbu atendimento:*\r\n📞551131362846\r\n.",
"instructionsMessage": "*Tem dúvidas? Fale com a Robbu:😀*\r\n📞551131362846",
"documentCollection": [
{
"documentCode": "1946753214860",
"documentFileName": "download.pdf",
"documentBase64": "JVBERi0xLjMKJcTl8uXrp/Og0MTGCjQgMCBvYmoKPDwgL0xlbmd0aCA1IDAgUiAvRmlsdGVyIC9GbGF0ZURlY29kZSA+PgpzdHJlYW0KeAF9jr0KwkAQhPs8xUSN3kVz2TuT3NkqNnaBhRTG6tBCiBDz/mD+Cm1kF3YWduebFiVaaDN07hxs4fC+o8IL6anT8B1orM73d6RMNu2DOBAsOWUNfIMjBwkpItJgj3x6mgc3SJl7BviBK0S4kEg0xHIVrTezrkVUyzjc7iRuAV9w5jHZL1HbTBV708f84v6DiVgG/JzMyg+1fjByCmVuZHN0cmVhbQplbmRvYmoK"
}
]
}Resultado
#
Sucesso:
Digitação incorreta:
