Pular para o conteúdo
ArkSales
Operação2 min de leitura

Chaves de API

Crie uma API key com nome e escopos, copie a chave na hora e revogue quando não usar mais.

API keys autenticam integrações externas na conta. O card em Configurações, seção Desenvolvedor, se chama API keys.

Criar uma chave

  1. Abra Configurações e clique em API keys.
  2. Clique em Nova API key.
  3. No painel Nova API key, preencha Nome da integração (Ex.: ERP Acme, Zapier, Script interno).
  4. Em escopos, use os atalhos CRM leitura, CRM escrita ou CRM completo, ou marque grupos como Contatos, Negócios, Timeline, Produtos, Referência e WhatsApp.
  5. Ver permissões / Ocultar permissões detalha o que cada escopo libera.
  6. Clique em Criar chave.

O diálogo API key criada diz: "Copie sua chave antes de fechar. Só aparece agora." Copie o valor em API key e guarde no cofre da integração.

Aviso: API key criada com sucesso.

Manter

  • Editar API key altera nome e escopos (Salvar, aviso API key atualizada.).
  • Revogar pede Revogar API key? e o botão Revogar. Aviso: API key revogada.

A chave completa não é mostrada de novo depois da criação. Se perder, revogue e crie outra.

Se não funcionar

Sem nome: Informe um nome para a chave.

Sem escopo: Selecione ao menos um escopo.

Integração recebendo 401: confira se a key não foi revogada e se o cabeçalho de autenticação usa o valor copiado na criação.

Sem o card API keys: o papel atual não gerencia chaves. Peça a um Proprietário ou Administrador.

Continue aprendendo

Outros tutoriais de Operação