Qamaq - AI-Powered Teammate for Every Employee

APIキー

Qamaq APIはAPIキーを使用してリクエストを認証します。APIキーは組織に紐づけられ、実行可能なアクションを制御するために異なる権限スコープを設定できます。

APIキーを安全に保管してください

公開リポジトリ、クライアントサイドコード、その他の公開アクセス可能な場所でAPIキーを共有しないでください。パスワードと同様に扱ってください。

APIキーの作成

APIキーを作成するには：

1Qamaqダッシュボードにログインします
2「設定」>「APIキー」に移動します
3「新しいAPIキーを作成」をクリックします
4キーに説明的な名前を付け、適切なスコープを選択します
5APIキーをコピーして安全に保管してください。再度表示されません

APIキーの使用

Bearerスキームを使用して、AuthorizationヘッダーにAPIキーを含めてください：

cURL

curl -X GET "https://api.qamaq.io/api/v1/me" \
  -H "Authorization: Bearer qmq_your_api_key"

JavaScript

const response = await fetch('https://api.qamaq.io/api/v1/me', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer qmq_your_api_key'
  }
});
const data = await response.json();

Python

import requests

response = requests.get(
    'https://api.qamaq.io/api/v1/me',
    headers={'Authorization': 'Bearer qmq_your_api_key'}
)
data = response.json()

APIキースコープ

APIキーには、アクセスできるリソースを制御するための異なるスコープを設定できます：

Scope	Description
`entities:read`	エンティティスキーマとレコードの読み取り
`entities:write`	エンティティレコードの作成と変更
`knowledge:read`	ナレッジベースからのフォルダーとファイルの読み取り
`knowledge:write`	フォルダーとファイルの作成と変更
`boards:read`	ボードとチケットの読み取り
`boards:write`	ボードとチケットの作成と変更

認証エラー

認証に失敗した場合、以下のエラーレスポンスのいずれかが返されます：

401Unauthorized

APIキーが提供されていないか、キーの形式が無効です。

403Forbidden

APIキーは有効ですが、リクエストされたリソースまたはアクションに対する権限がありません。

ベストプラクティス

環境変数を使用してAPIキーを保存し、ハードコードしないでください
異なるアプリケーションや環境用に別々のAPIキーを作成してください
各APIキーには必要最小限のスコープを使用してください
セキュリティを向上させるためにAPIキーを定期的にローテーションしてください
ダッシュボードでAPIキーの使用状況を監視してください
漏洩した可能性のあるAPIキーは直ちに無効化してください