Skip to main content

​
Autenticação

Para utilizar a API Carteiro Digital , é necessário obter um token de acesso (access_token). Esse token deve ser solicitado através da rota de login e posteriormente enviado na requisição da API Carteiro Digital como Bearer Token, permitindo que a operação seja autorizada e executada corretamente.
⚠️ Importante:
  • Caso o token esteja ausente, inválido ou expirado, a API retornará o erro 401 Unauthorized, impedindo a atualização ou criação do contato.
  • O usuário utilizado na autenticação deve ser do tipo API, garantindo a segurança da integração e o funcionamento adequado do processo.
    Consulte: Usuários no Invenio Center.
  • Não é necessário gerar um novo token a cada envio. O campo expires_in define sua validade em segundos e, por padrão, pode ser considerado válido por até 3333 dias.
    É importante lembrar que, caso a rota de login seja executada novamente, o token anterior será invalidado. Por isso, a recomendação é armazená-lo e solicitar um novo apenas quando a requisição de envio retornar 401 Unauthorized.

​
Endpoint de Login

  • Método: POST
  • URL: https://api.robbu.global/v1/login
Body (JSON): 
{
  "Company": "NOME_DA_EMPRESA",
  "Username": "USUARIO_API",
  "Password": "SENHAUSUARIO_API"
}
Campos:
  • Company: Nome do ambiente/empresa no Invenio Center.
  • Username: Usuário com permissão de integração (tipo API).
  • Password: Senha do usuário.
Exemplo de response de login: 
{
  "access_token": "eyJhbGciOi...",
  "expires_in": 287971200,
  "refresh_token": "",
  "token_type": "bearer"
}

​
Endpoint de Envio de Documento

  • Método: POST
  • URL: https://api.robbu.global/v2/digitalpostman
O envio deve incluir o cabeçalho Authorization: Bearer {access_token}. Exemplo de request (completo)
POST https://api.robbu.global/v2/digitalpostman
{
  "senderName": "Robbu",
  "contactName": "Robbu Teste",
  "contactId": "11122233344",
  "walletCode": "CarteiraTeste",
  "contactPhoneNumber": "5511999999999",
  "invalidTokenMessage": "Opção inválida!\r\n\r\nAqui estão os nossos canais de atendimento:\r\n📞551199999999",
  "instructionsMessage": "*Tem dúvidas? Fale com a Robbu:😀*\r\n📞551199999999",
  "documentCollection": [
    {
      "documentCode": "1946753214860",
      "documentFileName": "boleto.pdf",
      "documentBase64": "JVBERi0xLjMKJcTl8uXrp..."
    }
  ]
}

​
Detalhamento dos Campos

CampoDescrição
senderNameNome do remetente exibido ao destinatário.
contactNameNome completo do destinatário.
contactIdCPF/CNPJ do destinatário — usado para validação (3 primeiros dígitos).
walletCodeCódigo da carteira cadastrada no Invenio.
contactPhoneNumberNúmero do destinatário com DDI + DDD (ex.: 5511999999999).
invalidTokenMessageMensagem exibida quando o token informado pelo usuário for inválido.
instructionsMessageMensagem com instruções enviada junto ao documento disparado.
documentCollectionArray com os documentos a serem enviados (veja estrutura abaixo).
⚠️ Importante:
  • Com exceção dos campos invalidTokenMessage e instructionsMessage, nenhuma outra mensagem ou frase exibida durante a jornada do contato pode ser personalizada, além dos próprios campos variáveis da integração. Esses dois campos são os únicos que permitem customização textual completa.
  • Além disso, para ambos é possível inserir emojis diretamente no código, bem como realizar quebras de linha utilizando os caracteres \r\n, garantindo maior flexibilidade na formatação da comunicação.

​
Estrutura do campo documentCollection

CampoTipoObrigatórioDescrição
documentCodeStringSimLinha digitável do boleto ou identificador do documento / código Pix.
documentFileNameStringSimNome do arquivo (ex.: boleto.pdf, qrcode.png).
documentBase64StringSimArquivo codificado em Base64.
documentValueStringNão (Pix: Sim)Valor do documento — obrigatório para envios de Pix.
⚠️ Observações:

​
Responses

CódigoDescrição
200 OKRequisição processada com sucesso; envio iniciado.
400 Bad RequestParâmetros inválidos ou incompletos.
401 UnauthorizedToken ausente, inválido ou expirado.
404 Not FoundURL incorreta.
500 Internal Server ErrorErro interno da API.
A API pode não retornar detalhes de erros de provedores externos (Por exemplo: Meta/WhatsApp).
Para logs e detalhes de entrega, verifique o Invenio Center.

​
Fluxo de Validação por Token

Ao enviar o documento, o usuário destinatário precisa validar o acesso informando os 3 primeiros dígitos do contactId (CPF/CNPJ). Se a validação for correta, o arquivo é disponibilizado.
⚠️ Observação sobre CPFs iniciados por zero:
  • Para CPFs que começam com 0, aceitamos a digitação dos três dígitos com ou sem o zero inicial. Ex.: 011.222.333-44 aceita 011 ou 112.

​
Exemplos de uso

  • Envio de documento (boleto) — já mostrado acima.
  • Envio de Pix — neste caso inclua documentValue com o valor do pagamento no objeto do documentCollection.
Exemplo:
POST https://api.robbu.global/v2/digitalpostman
{
  "senderName": "Robbu",
  "contactName": "Robbu Teste",
  "contactId": "11122233344",
  "walletCode": "c141",
  "contactPhoneNumber": "5511998037663",
  "invalidTokenMessage": "Opção inválida!\r\n\r\nAqui estão os nossos canais de atendimento:\r\n📞551199999999",
  "instructionsMessage": "*Tem dúvidas? Fale com a Robbu:😀*\r\n📞551199999999",
  "documentCollection": [
    {
      "documentCode": "c9f1a3b4-82d7-4e0e-9a21-55f4d7b98f10",
      "documentValue": "1200.00",
      "documentFileName": "pix-qrcode.png",
      "documentBase64": "..."
    }
  ]
}

​
🔗 Links e assuntos relacionados

​
⁉️Perguntas Frequentes (FAQ)

Não. Guarde o access_token até expirar ou até a API retornar 401 Unauthorized.
Sim. Adicione múltiplos objetos dentro do array documentCollection.
Utilize qualquer conversor online ou uma biblioteca local para gerar o Base64 do arquivo antes de enviar.
A mensagem definida em invalidTokenMessage será exibida; você pode personalizá-la conforme o fluxo desejado.
Sim. Para Pix, documentValue é obrigatório e deve conter o valor associado ao pagamento.