APIキーと認証
セールスブレインAPIは、リクエストヘッダーのAPIキーで認証します。APIキーはWebアプリから作成・管理できます。
エンドポイントと項目定義は、WebアプリのAPIドキュメント ↗で確認できます。
APIキーを作成する
- セールスブレインのWebアプリへログインします
- サイドメニューの「API キー」を開きます
- 「新しい API キーを作成」を押します
- 用途が分かる名前と有効期限を設定します
- 表示されたAPIキーを安全な場所へ保存します
APIキーの値が表示されるのは作成直後の一度だけです。画面を閉じる前に保存してください。
環境変数へ保存する
ターミナルで使う場合は、APIキーを環境変数へ設定します。
export SALESBRAIN_API_KEY="取得したAPIキー"
export SALESBRAIN_API_BASE_URL="https://api.salesbrain.jp/rest/v1"APIキーをソースコードへ直接書いたり、Gitへコミットしたりしないでください。
リクエストへ付ける
すべてのAPIリクエストに、X-API-Keyヘッダーを付けます。
curl -s "$SALESBRAIN_API_BASE_URL/master/prefectures" \
-H "X-API-Key: $SALESBRAIN_API_KEY"APIキーを管理する
「API キー」画面では、作成済みキーの名前、有効期限、作成日時を確認できます。
- 用途が分からなくなったキーは名前を変更します
- 不要になったキーは削除します
- 期限切れ前に新しいキーを作り、利用先を切り替えます
- キーが漏えいした可能性がある場合は、直ちに削除して再発行します
401が返る場合
- ヘッダー名が
X-API-Keyになっているか確認します - 環境変数が空になっていないか確認します
- 作成した組織と利用先が一致しているか確認します
- APIキーの有効期限を確認します
- 削除済みのAPIキーを使っていないか確認します
確認のためにAPIキーの値を画面やログへ出力しないでください。