APIアクセスキーの生成

最後の更新
PDFとして保存

重要 - 画像/情報は四半期ごとのリリースで更新されます!

四半期ごとのリリースにて、最新の機能・情報を反映し、画像を含めた情報は更新されます。

重要: Gainsight は、Horizon Experience を使用して Conn ectors 2.0 をアップグレードしています。この記事は、Horizon Experience for Connectors 2.0 にアップグレードされたテナントに適用されます。以前のバージョンで Connectors 2.0 を使用している場合は、こちらのドキュメントを参照してください。

この記事では、管理者が Gainsight API アクセスキーを生成する方法について説明します。

管理者は組織ごとに作成できるアクセスキーは 1 つだけで、有効期限はありません。Gainsightは、このアクセスキーを検証することでREST APIリクエストを認証し、認証が成功すると、REST APIを通じてGainsightプラットフォームへのアクセスが開発者に許可されます。

既存のアクセスキーはいつでもリセットできますが、今後のすべての API リクエストのヘッダーにある新しいアクセスキーを置き換える必要があります。

[概要]

Gainsight API アクセスキーは、Gainsight REST API リクエストの認証に使用されるユニークなアクセスキーです。Gainsightの管理者はAPIキーを生成でき、開発者はすべてのAPIリクエストのリクエストヘッダー「アクセスキー」のキーをGainsightに渡す必要があります。

アクセスキーを生成

アクセスキーを生成するには:

[管理] > [コネクタ 2.0] > [接続] ページに移動します。
「接続を作成」をクリックします。[接続の作成] ダイアログが表示されます。
コネクタのドロップダウンリストから、Gainsight API を選択します。
「アクセスキーを生成」をクリックします。

新しいアクセスキーが生成され、これをコピーして、GainsightへのすべてのREST APIリクエストの認証として使用できます。

Gainsight API 接続を編集

接続が確立されると、管理者はGainsight API接続を編集して既存のAPIアクセスキーをリセットできます。

既存の API アクセスキーをリセットするには:

作成した接続のコンテキストメニューをクリックし、[接続の編集] を選択します。[接続の編集] ダイアログが表示されます。
「アクセスキーをリセット」をクリックして、新しいアクセスキーを生成します。
確認メッセージで [はい] をクリックします。

新しいアクセスキーが生成され、これをコピーして、今後の Gainsight へのすべての REST API リクエストの認証として使用できます。

メモ: 今後のすべての API リクエストのヘッダーにある新しいアクセスキーを置き換える必要があります。置き換えなければ、特定の Gainsight 組織への今後の API リクエストはすべて失敗します。