Developers

Aparência

Vai integrar a plataforma Zarv com ajuda de IA? Copie a instrução que aponta o modelo para esta documentação.
Ver a instrução
Você vai integrar a plataforma Zarv. Use a documentação oficial como fonte da verdade.

- Página desta integração: https://developers.zarv.com/integrations/connect-and-activate
- Comece pelo Setup (hosts, autenticação, loader do SDK): https://developers.zarv.com/setup
- Índice da documentação em markdown: https://developers.zarv.com/llms.txt
- Documentação completa em um arquivo: https://developers.zarv.com/llms-full.txt

Antes de escrever qualquer código, leia a página desta integração. Siga exatamente os nomes de campos, endpoints, callbacks e formatos que estiverem documentados — não invente parâmetros nem endpoints, e não deduza comportamento a partir de outras APIs que você conhece. Se algo de que você precisa não estiver na documentação, diga que não está em vez de supor.

Minha tarefa: [descreva aqui o que você quer construir]

Conectar e ativar uma integração ​

Ligar uma integração tem duas partes: o administrador do workspace a ativa em Configurações › Marketplace, e a campanha recebe a credencial e a própria chave de ativação.

Antes de começar

Você precisa da credencial da integração: na Locavia, Organização (CNPJ), Usuário e Senha; na Cotalk (Helena), o Token de integração. Veja Locavia e Cotalk (Helena).

1. Ative no workspace (administrador) ​

  1. Abra Configurações › Marketplace. Os filtros são Todos, Conectados e Disponíveis; as seções são Conectores conectados, Catálogo e API & Webhooks.
  2. Abra a página do conector (Locavia ou Cotalk (Helena)).
  3. Ligue Integração ativa.
Página do conector no Marketplace, com a chave Integração ativa
Página do conector (Locavia) no Marketplace: a chave Integração ativa e, abaixo, a lista Funis conectados, com as colunas Funil, Conta, Catálogo e Envia leads e o botão Adicionar.Clique para ampliar

Só um administrador do workspace vê essa chave habilitada. Com ela desligada, a página do conector mostra "Integração inativa. Ative a conexão para editar o catálogo, as filiais e os padrões de cadastro."

2. Conecte e ative na campanha ​

  1. Abra a campanha no editor e vá à etapa Integrações ("Envie leads deste fluxo diretamente para parceiros e sistemas externos via SmartFlow.").
  2. Abra o painel da integração. Na faixa da conta, o estado inicial é Nenhuma conta conectada.
  3. Informe as credenciais. O campo é somente escrita: o valor é gravado no cofre e nunca é exibido de volta.
  4. Ligue a chave da própria campanha:
    • Locavia: o Registro de cadastro (automático), na aba Cadastro, e, se quiser contratos, o Registro de contrato (automático), na aba Contrato.
    • Cotalk (Helena): a chave Cotalk (Helena), no alto do painel.
  5. Salve.
Etapa Integrações no editor da campanha
A etapa Integrações do editor da campanha: os cartões Locavia e Cotalk (Helena), cada um com o selo Conectado.Clique para ampliar
Painel da Cotalk (Helena) na campanha, com a faixa da conta e a chave de ativação
Painel da Cotalk (Helena) na campanha: selo Conexão ativa, faixa Conta conectada com Alterar autenticação, a chave Cotalk (Helena) com o selo Ligado e as Etiquetas de status.Clique para ampliar

Conectar salva as credenciais; ativar libera o uso da integração na campanha.

Na Cotalk (Helena), o painel da campanha também exige a Integração ativa, e ao salvar a configuração é validada primeiro e só então a integração é ativada.

Cada painel mostra o selo Conexão ativa no cabeçalho e selos de estado nas chaves: Ligado, Desligado, Revisar ou Erro. Na lista de integrações da campanha, o cartão mostra Conectado.

Trocar a credencial ​

Não existe desconectar: você troca a credencial. Com a conta conectada, use Alterar autenticação na faixa da conta e informe os novos valores. Só um administrador do workspace altera a conta e a conexão.

Mensagens comuns ​

MensagemSignificado
Integração inativa. Ative a conexão para editar o catálogo, as filiais e os padrões de cadastro.A Integração ativa do workspace está desligada.
A integração está inativa. Ative-a em Configurações › Marketplace para editar este fluxo.O painel da campanha está travado pelo mesmo motivo.
Nenhuma conta conectadaA campanha ainda não tem credencial.
Peça a um administrador do workspace…Você não é administrador e a ação exige um.
Só um administrador do workspace altera a conta e a conexão.Mesmo caso: a conta e a conexão são do administrador.

Solução de problemas ​

SintomaCausaO que fazer
O painel da campanha está travadoIntegração ativa desligada no workspacePeça a um administrador para ligá-la em Configurações › Marketplace.
Nenhuma conta conectadaNenhuma credencial salva nesta campanhaInforme as credenciais no painel. Outra campanha com a mesma conta não serve: cada uma tem a sua.
Erro de token recusado ao salvar (Cotalk (Helena))Token inválido ou revogadoGere outro token e use Alterar autenticação. Veja Teste o token.
Você não consegue alterar a conta ou ligar a integraçãoSeu usuário não é administrador do workspacePeça a um administrador do workspace.
Credencial errada, e o valor antigo não apareceAs credenciais são somente escritaUse Alterar autenticação e informe os novos valores.

Para falhas de envio depois da conexão (Locavia: Falhou, Reenviando, Com falha), veja Operação do dia a dia.