Pular para o conteúdo
NovoVeja como

Como Criar e Gerenciar Chaves de API de Desenvolvedor no FirstSales

Gere chaves de API com privilégio mínimo e escopos por recurso, use-as com a CLI e a API REST, e rotacione ou revogue com segurança sem causar interrupção.

Tutoriais
Desenvolvedor e CLI
min de leitura
7 min
etapas
6 · Intermediário

  1. Abra Configurações → API

    As chaves de API ficam em Configurações → API. É aqui que você gera a credencial que autentica o CLI e qualquer chamada direta a https://api.app.firstsales.io. Você precisa da permissão certa para ver essa aba.

  2. Crie uma chave com escopos de privilégio mínimo

    Clique para criar uma chave, dê a ela um nome (algo que indique onde é usada, ex.: "ci-contact-sync"), e marque apenas os escopos que ela precisa. Escopos são por recurso e separam leitura de escrita: ex.: contacts:read, contacts:write, campaigns:read, kb:read. Há um escopo * que concede tudo; evite-o a menos que você realmente precise de acesso total.

    Crie uma chave com escopos de privilégio mínimo

  3. Copie a chave imediatamente

    A chave completa é exibida exatamente uma vez: "Copie esta chave agora. Ela não será mostrada novamente." Copie-a diretamente para seu cofre de segredos ou gerenciador de senhas. Se você a perder, não poderá recuperá-la; você revoga e cria uma nova. Nunca cole em código, chat ou commit.

  4. Use-a com o CLI

    Exporte a chave como FIRSTSALES_API_KEY e o CLI a detecta automaticamente. Verifique com whoami antes de fazer qualquer outra coisa:

    export FIRSTSALES_API_KEY="fs_live_..."   # do seu cofre de segredos, nunca fixo no código
firstsales whoami --json

  5. Use-a diretamente com a API

    Para HTTP puro, envie a chave como um token Bearer. Comece com whoami para confirmar que a chave é válida e ler qual org/workspace ela alcança:

    curl -s https://api.app.firstsales.io/api/v1/whoami \
  -H "Authorization: Bearer $FIRSTSALES_API_KEY"

  6. Rotacione e revogue

    Cada chave na lista pode ser revogada, e a revogação é imediata e sem desfazer: qualquer CLI ou serviço usando-a falha na próxima chamada. Para rotacionar: crie a nova chave, implante-a no seu cofre de segredos, confirme que a nova funciona, depois revogue a antiga. Revogue instantaneamente se uma chave for exposta.

Dicas de especialista

  • Uma chave por consumidor

    Dê ao CI, ao seu laptop e a cada integração sua própria chave nomeada. Quando uma vaza ou um serviço é desativado, você revoga só aquela chave em vez de quebrar tudo.

  • Privilégio mínimo vence conveniência

    Uma sincronização somente leitura não precisa de contacts:write, e quase nada precisa de `*`. Restrinja o escopo: uma chave somente leitura vazada não consegue alterar seus dados.

  • Copie uma vez, guarde em um gerenciador de segredos

    A chave é mostrada uma única vez. Cole diretamente no seu cofre de segredos do CI ou gerenciador de senhas: nunca no código-fonte, em um .env que você possa commitar, ou em uma mensagem de chat.

  • Rotacione com sobreposição, não com lacuna

    Crie-implante-verifique-depois revogue. Revogar antes que a substituta esteja ativa causa uma indisponibilidade; a janela de sobreposição mantém as chamadas fluindo durante a rotação.

Perguntas frequentes

Onde crio uma chave de API?

Configurações → API. Dê um nome, marque os escopos necessários e crie. A chave autentica tanto o CLI quanto chamadas diretas à API.

O que são escopos?

Permissões por recurso, separadas em leitura e escrita: ex.: contacts:read, campaigns:write, kb:read, além de um * que concede tudo. Marque apenas o que o consumidor da chave precisa.

Perdi minha chave: posso vê-la de novo?

Não. A chave completa é exibida uma vez na criação (“Ela não será mostrada novamente”). Se você a perder, revogue aquela chave e crie uma nova.

Como o CLI usa a chave?

Defina-a como a variável de ambiente FIRSTSALES_API_KEY; o CLI a lê automaticamente. Execute firstsales whoami para confirmar que funciona.

Como revogo uma chave?

Na lista de configurações de API, revogue-a. A revogação é imediata e permanente: qualquer coisa usando aquela chave falha na próxima chamada, então rotacione uma substituta antes.

Como devo rotacionar chaves com segurança?

Crie a nova chave, implante-a, confirme que funciona, depois revogue a antiga. Essa sobreposição evita uma indisponibilidade. Revogue imediatamente (sem sobreposição) apenas se uma chave for exposta.

Desenvolvedor e CLI

Prospecção que continua quando você desconecta.Leads, emails, follow-ups e respostas, resolvidos.

Conecte caixas ilimitadas e deixe os agentes de IA encontrarem leads, escreverem cada email e fazerem follow-up. Ou envie seus próprios modelos no modo manual. A partir de $29/mês.

Comece seu teste de $1 Ver preços

$1 por 3 dias · Cancele quando quiser · Sem contrato

Instalar com IA

Seu agente de código configura a CLI e as skills do FirstSales para você.

Prompt para Claude Code

I'm setting up FirstSales (https://firstsales.io), an AI outbound sales platform: campaigns, contacts, a reply inbox, deliverability and lead signals. Help me get my workspace sending real, good emails end to end, from Claude Code.

Read these first so you know how FirstSales works:
- Developer docs and API: https://developer.firstsales.io
- CLI: https://www.npmjs.com/package/@firstsales.io/cli
- Skills for coding agents: https://github.com/firstsalesio/firstsales-skills (read README.md and GUIDE.md)

Setup
1. Install the CLI: npm install -g @firstsales.io/cli
2. Install the FirstSales skills:
   claude plugin marketplace add firstsalesio/firstsales-skills
   claude plugin install firstsales@firstsales
3. Ask me if I already have a FirstSales account. If not, send me to https://app.firstsales.io to sign up.
4. Ask me to create an API key under Settings → API → API Keys, with only the scopes we need.
   Never ask me to paste the key into this chat. Tell me to run this in my own terminal, so the key stays hidden:
   read -rs FS_KEY && firstsales auth login --api-key "$FS_KEY"; unset FS_KEY
5. Run `firstsales whoami` and tell me which workspace and organisation we are connected to.

Then ask me about my business: what I sell, who I sell to (roles, company size, countries), my best customers, and what I use today for outbound (tools, lists, mailboxes). Walk me through:
1. Teaching FirstSales my business: website, offer, proof points and case studies in the knowledge base, so the AI writes like someone who knows the product.
2. Connecting my sending mailboxes and checking my sending domain: SPF, DKIM, DMARC and warm-up. If anything is unhealthy, tell me the exact DNS record to add.
3. Bringing in contacts: import my CSV or CRM export into a clean list, remove duplicates and bad emails, and block domains I must never email (customers, competitors, my own).
4. Building my first campaign: the right list, senders, steps and timing. Write the sequence with me, show me the drafts, and do not launch until I say yes.
5. Setting up Signals if it fits: find people engaging with LinkedIn posts about topics my buyers care about, and turn them into leads.
6. Inviting my team and giving each person the right access.

Once campaigns run, show me how to work the reply inbox from here: which replies need an answer, draft responses in my voice, and move good conversations into deals. If I use Cal.com, connect it so follow-ups can offer my booking link (not the first email).

Throughout, as you learn about my business, proactively suggest and help create:
- Reply templates for the questions and objections my prospects are likely to raise, based on my product, site and codebase if you can see them.
- Campaign ideas and segments worth testing, with the reason for each.

Safety rules:
- Show every change as a dry run (--dry-run) first and wait for my yes. Never send emails, launch campaigns or delete anything without my yes.
- Tell me before anything that spends credits, and how many.

Be opinionated. If the docs give a sensible default, just use it. Don't make me choose between five options.
Developer docs ↗npm: @firstsales.io/cli ↗GitHub: firstsales-skills ↗