Pular para o conteúdo principal

Autenticação

ArchiCore usa chaves API para autenticação.

Obtendo uma Chave API

  1. Faça login em ArchiCore
  2. Vá para ConfiguraçõesDesenvolvedor
  3. Clique em Gerar Chave API
  4. Copie e armazene sua chave com segurança
aviso

Chaves API são mostradas apenas uma vez. Armazene-as com segurança!

Usando a Chave API

Inclua a chave no header Authorization:

curl -H "Authorization: Bearer sk_live_xxxxx" \
https://api.archicore.io/api/v1/projects

Ou como parâmetro de consulta (não recomendado):

curl "https://api.archicore.io/api/v1/projects?api_key=sk_live_xxxxx"

Tipos de Chave

PrefixoTipoDescrição
sk_live_ProduçãoAcesso total à sua conta
sk_test_TesteAcesso limitado, para desenvolvimento

Permissões de Chave

Chaves API herdam permissões do nível da sua conta:

PermissãoGrátisProEnterprise
Ler projetos
Criar projetos
Análise
Webhooks-
Acesso de equipe--

Revogando Chaves

Para revogar uma chave API:

  1. Vá para ConfiguraçõesDesenvolvedor
  2. Encontre a chave na lista
  3. Clique em Revogar

Chaves revogadas param de funcionar imediatamente.

Melhores Práticas de Segurança

  1. Nunca commite chaves API no controle de versão
  2. Use variáveis de ambiente para armazenar chaves
  3. Rotacione chaves regularmente (recomendado: a cada 90 dias)
  4. Use chaves de teste para desenvolvimento
  5. Monitore o uso no painel

Variáveis de Ambiente

# .env (adicione ao .gitignore!)
ARCHICORE_API_KEY=sk_live_xxxxx
const client = new ArchiCore({
apiKey: process.env.ARCHICORE_API_KEY
});

OAuth (Em Breve)

Suporte OAuth 2.0 está planejado para integrações de equipe.