Skip to main content

Autenticação

Para utilizar a API Update Contact, é 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 Update Contact 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 também: Usuários no Invenio Center.

Endpoint de Login

POST https://api.robbu.global/v1/login

Exemplo de corpo da requisição:

{
  "Company": "NOME_DA_EMPRESA",
  "Username": "USUARIO_API",
  "Password": "SENHAUSUARIO_API"
}
CampoDescrição
CompanyNome do ambiente utilizado no login da plataforma
UsernameNome do usuário com permissão do grupo de acesso “Integração API”
PasswordSenha do usuário de integração
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.

Requisição para Atualização de Contato

Endpoint

POST https://robbuapi.azurewebsites.net/v1/updatecontact
O envio deve incluir no cabeçalho a autenticação no formato: Authorization: Bearer {access_token}

Body

{
  "invenioPrivateToken": "SEU_TOKEN_PRIVADO",
  "name": "João da Silva",
  "customCode": "cliente_001",
  "id": "12345678900",
  "tag": "Alta",
  "jokers": ["R$50,00", "Contrato123", "Xpto", "coringa4", "coringa5"],
  "walletClientCode": "CART001"
}

Especificação dos Parâmetros

CampoTipoObrigatórioDescrição
invenioPrivateTokenStringSimToken privado obtido em Invenio Center > Configurações de conta
nameStringSimNome completo do contato
customCodeStringNãoCódigo personalizado para o contato
idStringSimCPF ou CNPJ do contato
tagStringNãoTag associada para segmentação/classificação
jokersArrayNãoLista de até 5 variáveis coringa usadas dinamicamente em templates
walletClientCodeStringNãoCódigo da carteira/segmento vinculado ao contato

Respostas da API

A API pode retornar 400 – Bad Request quando algum parâmetro da requisição não atende às validações exigidas. Nesses casos, o response body informa exatamente qual campo gerou o problema. Alguns exemplos são:
  • invalid private token – O private token informado é inválido ou não autorizado.
  • invalid id (cpf/cnpj/nif) – O documento enviado (CPF, CNPJ ou NIF) está incorreto ou fora do padrão esperado.
  • invalid wallet – O segmento especificado não existe ou não está ativo.
CódigoDescrição
200Contato atualizado ou inserido com sucesso
400Erro de validação nos parâmetros da requisição
401Token inválido ou expirado
500Erro interno do servidor

Criação de Contatos

Quando a API recebe uma requisição contendo dados de um contato, ela verifica se já existe um registro correspondente no ambiente Invenio, com base nas informações encaminhadas (como nome e CPF/CNPJ). Caso nenhum contato existente seja encontrado, a API interpreta a operação como uma criação de novo registro. Dessa forma, um novo contato é automaticamente inserido na base utilizando exatamente os dados fornecidos na requisição. Esse processo garante que informações novas sejam incorporadas ao sistema de forma consistente, evitando duplicidade e mantendo a base sempre atualizada.

⁉️ Perguntas Frequentes (FAQ)

Não. O token tem tempo de expiração configurado (até 3333 dias). Gere um novo somente se expirar.
Não. O campo id é obrigatório e deve conter o CPF ou CNPJ do contato.
Até 5 valores no array, que podem ser utilizados dinamicamente em templates personalizados.
Verifique o código de resposta HTTP. Um retorno 200 indica sucesso.