Este documento traz as especificações técnicas para chamada da API “DigitalPostman” que faz disparos de QR CODE e pix cópia e cola 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
{
“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 pagamentos pela rota /digitalpostman devem utilizar o mesmo token, a renovação só é necessário caso API retorne não autorizado.
ENVIO DE PAGAMENTOS #
Para efetuar o envio de pagamentos 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”: “”,
“documentValue”: “”,
“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 dígitos 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.
InstructionsMessage: Mensagem de orientação enviada antes do código pix cópia e cola.
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.
DocumentCollection: Destinada a informações do documento a ser enviado. (Obrigatório)
DocumentCollection.DocumentCode: Código pix cópia e cola.
DocumentCollection.FileName: Nome do arquivo QR CODE (imagem).
Exemplo: QRCODE.png
Document.Value: Valor do pagamento. (Obrigatório)
DocumentCollection.DocumentBase64: Base64 do QR Code.
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”: “RobbuTeste”,
“contactId”: “ 11122233344″,
“walletCode”: “teste”,
“contactPhoneNumber”: “553199999999”,
“documentCollection”: [
{
“documentCode”: “00020126580014BR.GOV.BCB.PIX0136d7764682-05ae-4668-864f-287c980c9b4d52040000530398654040.105802BR5924Gilmar dos Santos Junior6009SAO PAULO621405102MrZd3N9JE6304BE9B”,
“documentFileName”: “QrCodePix.png”,
“documentValue”: 101.25,
“documentBase64”: “iVBORw0KGgoAAAANSUhEUgAAAPoAAAD6AQAAAACgl2eQAAACzElEQVR4Xu2WwXHsMAxDxUbE/rv4pZCNSMGjMllnD5kcYv6LNTtZL4UDAoCkx/75/BvvlbfzAM55AOc8gHN+B4gxbFnm8uV7jTHm8KTYCEh9wkLVZWE7XD+MYidAP5cuhkimyvWTYjMgQ+qE9JJSvsb0/wAQq+OUcXGkawXok7lFUI9iK82sio0A8pnv5z3V7/d/DKgjeguvMhy7/LPcBQgcEoJvde50nifffQB4mVrWeZxTid3qoGgFLOcCazBJ0PqzXqFtAKCKQYpJulDLljPTGgGpni1xdKMWzjUN0eIrtB0AAlI1nQVDigyUPoDmp4bo5K/o4pyj2susBoCUmYOIjKoiFN10Net2ABjN0QqNMEIz1Kj1AcjLZLVPpgZ9THgUoUYAvTrpFFposNVkn7DWCFhkBWloXukj2wzinYCgWRNuckmyyTWMepnVAOBoWtCsJFfDZEk3CPcBWGcSatc0U3bQTJVLZ90P0Pzc9abFcq/ESjU9dAJkSxmTGCai7Fb86gQk3IwRJl7MEOW42DYCsAiNkEwe6SZquVLpAmALGU36uKLDL7V0I4Cssk0ZZsSmJivDrBFQfRqDQY48UTNdo90bARpexW7Wyw3bTEy/bd77AUgFKbaq13I/FFsB0mdzT1ZoXt2jWSeAn5VU9azesQqlPXcxqwMgaxTTCVeXUy738jJIGwCBTJqcG5K87TDSvnX3/YBEpOJl6h9niAz0ev0X9wMWCwSDuFP3QtArto0A8qL6LI6ippdfKL5INgBYY2SW5BiiTcZaK0BF5ta0s8sYHWw3240ADnkRsaypCltteW8EiBGBpYXlUZJbHi5C3Q8gIvszsrvECrJzad4GQJyRlWURSIN3tANqo5PcqKQgnHcDfDNMcWlX68i73QnQR32jFuYNy/XOM2u3ZiOgQpuseCxjuUeJBssuwE/nAZzzAM55AOf8AeADE4VMrS5GapcAAAAASUVORK5CYII=”
}
]
}
RESULTADO #
