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 erro401 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
Exemplo de corpo da requisição:
Não é necessário gerar um novo token a cada envio. O campoexpires_indefine 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 retornar401 Unauthorized.
Requisição para Atualização de Contato
Endpoint
O envio deve incluir no cabeçalho a autenticação no formato: Authorization: Bearer {access_token}
Body
Especificação dos Parâmetros
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.
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.🔗 Links e assuntos relacionados
- Usuários no Invenio Center
- API Send Message
- Segmentos no Invenio Center
- Criação de contatos - Invenio Center
- Configurações Gerais da Conta
- Variaveis de sistema - Invenio
⁉️ Perguntas Frequentes (FAQ)
É necessário gerar um novo token a cada requisição?
É necessário gerar um novo token a cada requisição?
Não. O token tem tempo de expiração configurado (até 3333 dias). Gere um novo somente se expirar.
Posso atualizar um contato sem CPF ou CNPJ?
Posso atualizar um contato sem CPF ou CNPJ?
Não. O campo
id é obrigatório e deve conter o CPF ou CNPJ do contato.Quantas variáveis 'jokers' posso enviar?
Quantas variáveis 'jokers' posso enviar?
Até 5 valores no array, que podem ser utilizados dinamicamente em templates personalizados.
Como saber se o contato foi atualizado corretamente?
Como saber se o contato foi atualizado corretamente?
Verifique o código de resposta HTTP. Um retorno
200 indica sucesso.