Перейти к основному содержимому

Аутентификация

ArchiCore использует API-ключи для аутентификации.

Получение API-ключа

  1. Войдите в ArchiCore
  2. Перейдите в НастройкиРазработчик
  3. Нажмите Сгенерировать API-ключ
  4. Скопируйте и сохраните ключ
warning

API-ключи показываются только один раз. Сохраните их надёжно!

Использование API-ключа

Включите ключ в заголовок Authorization:

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

Или как query-параметр (не рекомендуется):

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

Типы ключей

ПрефиксТипОписание
sk_live_ProductionПолный доступ
sk_test_TestОграниченный доступ для разработки

Права доступа

ПравоFreeProEnterprise
Чтение проектов
Создание проектов
Анализ
Вебхуки-
Командный доступ--

Отзыв ключей

Для отзыва API-ключа:

  1. Перейдите в НастройкиРазработчик
  2. Найдите ключ в списке
  3. Нажмите Отозвать

Отозванные ключи немедленно прекращают работать.

Лучшие практики безопасности

  1. Никогда не коммитьте API-ключи в систему контроля версий
  2. Используйте переменные окружения для хранения ключей
  3. Ротируйте ключи регулярно (рекомендуется: каждые 90 дней)
  4. Используйте тестовые ключи для разработки

Переменные окружения

# .env (добавьте в .gitignore!)
ARCHICORE_API_KEY=sk_live_xxxxx
const client = new ArchiCore({
apiKey: process.env.ARCHICORE_API_KEY
});