APIキーを使用してNotiondesk APIで認証します。

すべての Notiondesk API リクエストは、ベアラートークン（ワークスペース API キー、または他の Notiondesk 顧客に代わって動作するアプリの OAuth アクセス トークン）で認証されます。この記事では、Notiondesk API キーの作成方法、スコープの選択方法、リクエストへの送信方法、およびキーのローテーションまたは失効方法について説明します。

独自のワークスペースで実行する自動化（スクリプト、スケジュールされたジョブ、CIステップ、または内部ツール）には、APIキーを使用してください。他のNotiondeskの顧客が接続するアプリを構築する場合は、代わりにOAuthを使用してください。

始める前に

• お客様のワークスペースはエンタープライズプランです。

• あなたはワークスペースの所有者、または管理者です。

Notiondesk APIキーを作成します

1. Notiondesk ダッシュボードで、 [設定]をクリックします。

2. ワークスペースの下にある「開発者」を開き、次に「API キー」を開きます。

3. 「キーの作成」をクリックします。

4. キーの用途を示すラベルを入力してください。例えば、CI automation または Redirect import などです。

5. 「スコープ」で、統合に必要なスコープのみを選択してください。 「適切なスコープを選択する」を参照してください。

6. 有効期限を選択してください： 30日間、 90日間、 1年間、または有効期限なし。

7. 「作成」をクリックします。

8. 「キーをコピー」をクリックし、キーをシークレットマネージャーまたは環境変数に保存してください。

9. 「キーを保存しました」をクリックしてください。

鍵は一度しか表示されません。紛失した場合は、鍵を回転させて新しい秘密を入手してください。

注：キーの作成時に鍵マークが表示され、ツールチップに「APIアクセスが可能なプランで利用可能です。」と表示される場合、ご利用のプランにはAPIが含まれていません。クリックするとアップグレードオプションが開きます。

適切なスコープを選択する

スコープとは、キーに紐づけられた権限のことです。各APIルートには1つのスコープが必要で、1つのキーに複数のスコープを設定できます。

各統合に必要な最小限のスコープセットを割り当てます。

ワークスペースロールがキーを制限する方法

キーは、それを作成した人があなたのワークスペースでできること以上のことは決してできません。

作成者の役割が変更されると、キーの有効範囲もそれに合わせて変更されます。作成者がワークスペースを離れると、キーは機能しなくなります。役割の管理については、「チームメンバーを招待する方法」を参照してください。

各リクエストにキーを添付してください。

Bearer スキームを使用して、Authorization ヘッダーにキーを送信します。

ヘルプセンターの一覧を含む「200 OK」が表示されれば、キーが正しく機能していることが確認できます。ワークスペース内のヘルプセンターごとに1つのキーが有効です。

JavaScriptでの同じリクエスト：

Pythonでは次のようになります。

Notiondesk APIキーは安全に保管してください。

curl "<https://api.notiondesk.so/sites>" \
  -H "Authorization: Bearer $NOTIONDESK_API_KEY" \
  -H "nd-version: 2026-10-16"

const response = await fetch("<https://api.notiondesk.so/sites>", {
  headers: {
    Authorization: `Bearer ${process.env.NOTIONDESK_API_KEY}`,
    "nd-version": "2026-10-16",
  },
});

const sites = await response.json();

import os
import requests

response = requests.get(
    "<https://api.notiondesk.so/sites>",
    headers={
        "Authorization": f"Bearer {os.environ['NOTIONDESK_API_KEY']}",
        "nd-version": "2026-10-16",
    },
)
sites = response.json()

• 鍵はサーバー上に保管してください。ブラウザのコード、モバイルアプリ、公開リポジトリに鍵を絶対に含めないでください。

• 鍵はソースコードではなく、環境変数またはシークレットマネージャに保存してください。

• 統合ごとに1つのキーを作成し、それぞれに固有のラベルを付けることで、1つのキーを失効させても他のキーに影響を与えないようにします。

• 一時的なスクリプトで使用されるキーの有効期限を選択してください。

• 鍵を知っていた人がチームを離れたら、その鍵を別の鍵に交換しましょう。

• 「最終使用日時」列を確認し、誰も使用していないキーは取り消してください。

キーを回転または取り消す

設定 > 開発者 > APIキーを開き、キーの行の一番下にあるメニューを使用します。

ローテーションを実行すると、シークレットが置き換えられます。ローテーションを確認すると、現在のシークレットはすぐに無効になり、新しいシークレットが一度表示されます。すぐに統合を更新してください。有効期限切れのキーはローテーションできません。代わりに新しいキーを作成してください。

取り消しを実行すると、キーは完全に無効になります。取り消しを確認すると、そのキーを使用している自動化機能は直ちに停止し、元に戻すことはできません。

認証のトラブルシューティング

WWW-Authenticate: Bearer error="insufficient_scope", scope="sync"

よくある質問

次は？

• Notiondesk REST API を使い始めましょう

• OAuthを使用してアプリをNotiondeskに接続します。

• Notiondesk APIエラー、レート制限、および再試行を処理する