Para gerar a chave de API da Nextags, abra Configurações › Integrações › Chave de API do NexTags e clique em Gerar. Depois, valide a conexão com GET /accounts/me: essa consulta identifica a conta vinculada à chave sem alterar seus dados.
Faça essa conferência antes de montar uma integração maior. Se a autenticação estiver errada, investigar formulário, contato e fluxo ao mesmo tempo só aumenta o trabalho. O primeiro objetivo é obter uma resposta válida da conta certa.
1. Separe o acesso e o ambiente de teste
Você precisa de um Super Administrador para acessar as Configurações. Um atendente pode trabalhar normalmente e ainda não enxergar essa área; isso depende das permissões da equipe.
Combine quem gerencia a integração e onde a credencial será guardada. Para acompanhar o roteiro, tenha cURL disponível em um computador ou servidor autorizado. Ao documentar a configuração para outra pessoa, registre o nome da variável e a finalidade da conexão, preservando o valor da chave no local seguro escolhido pela equipe.
2. Gere e copie a chave completa
Siga o tutorial de geração da chave:
- Entre na conta Nextags que será integrada.
- Abra Configurações e a aba Integrações.
- Selecione Chave de API do NexTags.
- Clique em Gerar e copie o conteúdo inteiro do campo.
- Confira o selo Ativa no cartão.
Se já houver uma chave ativa, confira com o responsável quais integrações a utilizam antes de alterar qualquer coisa. O botão Excluir apaga a chave imediatamente, sem uma segunda confirmação. Uma exclusão feita durante uma tentativa de configuração pode interromper ferramentas que já estavam funcionando.
3. Guarde a credencial fora do código
A documentação de autenticação orienta usar a variável de ambiente NEXTAGS_API_KEY. Configure seu valor no ambiente que executará a chamada; em hospedagens, use o painel de variáveis ou o cofre de segredos disponível.
A chave concede acesso à conta pela API e não possui permissões separadas por área. Por isso, mantenha as chamadas no servidor ou em um ambiente de trabalho controlado. Não coloque a credencial no JavaScript público do site, em aplicativo distribuído aos clientes, em repositório ou em conversa aberta.
Em ferramentas de automação, prefira o recurso próprio de credenciais. Ao compartilhar uma captura para pedir suporte, esconda o valor antes de enviar. O cabeçalho necessário é X-ACCESS-TOKEN; conhecer esse nome basta para discutir a configuração.
4. Faça a primeira consulta
Com NEXTAGS_API_KEY já definida no ambiente, execute:
curl -i --max-time 30 \
"https://app.nextagsai.com.br/api/accounts/me" \
-H "X-ACCESS-TOKEN: $NEXTAGS_API_KEY"
O comando usa a URL base da API com o caminho /accounts/me. A opção -i mostra o código HTTP e os cabeçalhos; o tempo limite evita uma espera indefinida. O guia da primeira requisição também oferece alternativas em JavaScript, Python e PHP.
Não substitua a variável pelo valor da chave em exemplos que serão compartilhados. Se alguém ajudar na implementação, essa pessoa pode preparar a chamada com o nome da variável e deixar o preenchimento da credencial para o ambiente autorizado.
5. Confira a resposta e a identidade da conta
O resultado esperado é HTTP 200. A referência de Consultar a conta descreve estes campos:
| Campo | O que conferir |
|---|---|
page_id | Identificador da conta consultada |
name | Nome correspondente à conta escolhida no painel |
active | Condição de acesso dos administradores ao painel |
total_users | Quantidade de contatos da conta |
Compare principalmente o nome e a conta pretendida. Uma resposta bem-sucedida de outra conta ainda exige corrigir a credencial usada. Guarde um registro da data, do resultado e do ambiente validado, sem copiar a chave.
O campo created também existe, mas sua unidade temporal não está definida no contrato. Evite converter esse valor automaticamente antes de conferir o comportamento necessário ao seu projeto.
Se aparecer erro, investigue o ponto certo
HTTP 401: confira se a variável chegou ao processo, se o cabeçalho foi escrito corretamente e se a chave está completa e atual. Repetir a mesma chamada com uma credencial inválida não corrige a autenticação.
Falha ao interpretar JSON: o erro de chave tem corpo JSON, embora o cabeçalho possa informar text/html. Confira o corpo recebido e o status antes de concluir que o endereço está errado.
Funciona no computador, mas falha no servidor: revise a variável no serviço que executa a integração. Uma variável definida em outro terminal não comprova que a aplicação a recebeu.
Quando precisar trocar a chave
Mapeie primeiro as ferramentas dependentes. Exclua a antiga, gere outra e atualize cada ambiente, verificando novamente a consulta da conta. Há um intervalo sem credencial válida nessa troca.
Depois dessa validação, avance para a operação desejada e consulte os limites e erros da API. Uma conexão autenticada confirma a primeira etapa; cada cadastro ou envio seguinte precisa de sua própria conferência.
Fontes e referências
Regras e recursos dos canais podem mudar. Confira as condições atuais nas fontes oficiais antes de colocar sua operação no ar.
Conteúdo de Angelo Sebastião Silva Goncalves. Preparado com apoio de IA. Consulte as fontes e os critérios editoriais. Conheça nossos critérios editoriais e como solicitar uma correção.