メインコンテンツまでスキップ

認証

ArchiCore は認証に API キーを使用します。

API キーの取得

  1. ArchiCore にログイン
  2. 設定開発者 に移動
  3. API キーを生成 をクリック
  4. キーをコピーして安全に保管
警告

API キーは一度しか表示されません。安全に保管してください!

API キーの使用

Authorization ヘッダーにキーを含めます:

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

またはクエリパラメータとして(非推奨):

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

キーの種類

プレフィックスタイプ説明
sk_live_本番アカウントへのフルアクセス
sk_test_テスト開発用の制限付きアクセス

キーの権限

API キーはアカウントプランの権限を継承します:

権限無料ProEnterprise
プロジェクト読み取り
プロジェクト作成
分析
Webhooks-
チームアクセス--

キーの取り消し

API キーを取り消すには:

  1. 設定開発者 に移動
  2. リストでキーを見つける
  3. 取り消し をクリック

取り消されたキーは即座に機能しなくなります。

セキュリティのベストプラクティス

  1. API キーをコミットしない バージョン管理に
  2. 環境変数を使用 してキーを保存
  3. 定期的にキーをローテーション(推奨:90日ごと)
  4. 開発にはテストキーを使用
  5. ダッシュボードで使用状況を監視

環境変数

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

OAuth(近日公開)

OAuth 2.0 サポートはチーム統合用に計画されています。