Upnify CRM
← Voltar ao produto

CRM · Integrações

Como conectar um sistema externo pela API da Upnify

Crie uma integração segura, troque o token por uma sessão e escolha as rotas do CRM adequadas ao seu processo.

Ilustração da troca de credenciais para conectar um sistema à API do Upnify CRM.

Publicado em 27 de outubro de 2026

A API da Upnify conecta o CRM a sistemas próprios ou de terceiros para evitar a digitação dos mesmos dados em vários lugares. Ela pode ajudar um aplicativo interno a consultar prospectos, enviar registros de uma plataforma comercial ou coordenar um processo com a equipe de desenvolvimento.

Não confunda os fluxos: Integração de sistemas externos fornece credenciais para que um aplicativo autorizado use as rotas da API. Integração de prospectos oferece uma rota de recebimento para enviar contatos. Para incorporar um formulário no site, consulte Como gerar e instalar um formulário HTML da Upnify.
Diagrama conceitual de autenticação: token de integração, token de sessão e rotas da API CRM.
O token de integração é trocado por uma sessão; o token de sessão acompanha as solicitações autenticadas.

Antes de começar

  • Defina quais informações os sistemas trocarão, em que direção e com que frequência.
  • Peça a uma pessoa administradora do CRM para criar a integração e a uma pessoa desenvolvedora para implementá-la.
  • Consulte a documentação oficial da API de CRM. Cada operação descreve parâmetros, campos e resposta.

1. Crie uma integração para sistemas externos

  1. No CRM, abra Configurações > Integrações > API e selecione Adicionar integração.
  2. No catálogo, escolha Upnify e selecione Integração de sistemas externos.
  3. Defina um nome para o projeto e configure os dados iniciais solicitados pelo CRM, como responsável, fase, origem ou etiquetas.
  4. Salve. Os detalhes mostrarão as credenciais associadas. Compartilhe-as com a equipe técnica por um canal seguro, não em documentos compartilhados nem em código público.
Formulário atual do CRM para configurar uma integração de sistemas externos pela API.
Selecione Sistemas externos para preparar o acesso de um aplicativo próprio ou sistema conectado.
Documentação oficial da API da Upnify mostrando o endpoint POST /prospectos e os parâmetros de cadastro.
Consulte a documentação vigente para confirmar o endpoint e os campos exigidos em cada solicitação.

2. Troque o token de integração por uma sessão

O guia atual recomenda solicitar uma sessão com POST /integraciones/sesion, enviando o token de integração no cabeçalho token. Confira se a resposta indica code: 0; o campo token retornado é usado nas rotas autenticadas.

POST https://api.upnify.com/integraciones/sesion
Accept: application/json
 token: TOKEN_DA_INTEGRACAO

Uma sessão nova dura dois dias. A documentação orienta repetir a troca para renová-la quando faltarem menos de cinco horas. Guarde ambos os tokens e o vencimento em configuração segura no servidor.

3. Implemente somente as operações necessárias

  1. Escolha as rotas do CRM para cada tarefa e confira os campos obrigatórios antes de programar.
  2. Use HTTPS e envie o token de sessão no cabeçalho token quando a rota exigir autenticação.
  3. Valide o código, a mensagem e os detalhes de cada resposta; uma conexão concluída nem sempre significa que o registro foi processado como esperado.
  4. Trate sessões expiradas, dados rejeitados e limites. A documentação informa um limite geral de 100 solicitações por minuto; diante do HTTP 429, aguarde e tente novamente gradualmente.
  5. Registre apenas o necessário para diagnosticar e nunca grave tokens ou senhas nos logs.

A autenticação documentada troca o token de integração por um token de sessão. Se o CRM também mostrar um código de autenticação, não o use no lugar do token indicado no guia; confirme com a equipe técnica se uma integração específica precisa dele.

Exemplo

Uma empresa quer que seu portal comercial interno consulte prospectos registrados no CRM. A pessoa administradora cria a integração; a pessoa desenvolvedora obtém uma sessão, consulta as rotas documentadas e exibe apenas os dados autorizados. Se o portal também precisar criar registros, a equipe combina campos e regras contra duplicidade antes de habilitar o envio.

Prática de segurança: mantenha as credenciais no servidor, restrinja o acesso, use HTTPS e troque o token se houver suspeita de exposição. Não o inclua em JavaScript público, que qualquer visitante poderia ler.

Consulte Comece aqui: autenticação e primeira solicitação e a documentação da API de CRM. Se precisar apenas receber prospectos por uma URL, consulte Como receber prospectos pela integração da Upnify.