Skip to main content

Authentication

ArchiCore uses API keys for authentication.

Obtaining an API Key

  1. Log in to ArchiCore
  2. Go to SettingsDeveloper
  3. Click Generate API Key
  4. Copy and securely store your key
warning

API keys are shown only once. Store them securely!

Using the API Key

Include the key in the Authorization header:

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

Or as a query parameter (not recommended):

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

Key Types

PrefixTypeDescription
sk_live_ProductionFull access to your account
sk_test_TestLimited access, for development

Key Permissions

API keys inherit permissions from your account tier:

PermissionFreeProEnterprise
Read projects
Create projects
Analysis
Webhooks-
Team access--

Revoking Keys

To revoke an API key:

  1. Go to SettingsDeveloper
  2. Find the key in the list
  3. Click Revoke

Revoked keys immediately stop working.

Security Best Practices

  1. Never commit API keys to version control
  2. Use environment variables to store keys
  3. Rotate keys regularly (recommended: every 90 days)
  4. Use test keys for development
  5. Monitor usage in the dashboard

Environment Variables

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

OAuth (Coming Soon)

OAuth 2.0 support is planned for team integrations.