API を呼び出す前に API 権限を申請する必要があります。ここでは、API 権限を申請および返却する方法について説明します。
前提条件
現在のテナントで、データサービスの付加価値サービスが購入済みかつ有効化済みである必要があります。テナント管理で有効化してください。
権限
アプリケーションの所有者のみが API 権限を返却できます。
API 権限の申請
-
Dataphin のホームページの上部メニューで、[Management Center] > [Permission Management] を選択します。
-
左側メニューで [My Permissions] > [Data Service Permissions] を選択し、[API Permissions] タブをクリックします。[API Permissions] タブで、[+ Apply for API Permissions] をクリックします。
-
[API Permission Application] ページで、パラメーターを設定します。
パラメーター
説明
[権限オブジェクト]
[アカウントタイプ]
アカウントタイプを選択します： [アプリケーション] または [個人アカウント]。デフォルトでは [アプリケーション] が選択されています。
-
[アプリケーション]：API オペレーションタイプが Create、Update、または Delete の場合、アプリケーションのみを認可できます。
-
[個人アカウント]：基本モードでは、開発環境の API が本番環境のデータにアクセスするため、注意して操作してください。Dev-Prod モードでは、開発データにアクセスします。
[サービスプロジェクト]
1 つ以上のサービスプロジェクトを選択します。
[API]
サービスプロジェクトと API グループごとに API を選択します。キーワードで検索するか、一括検索を使用するか、
アイコンをクリックして [API Group] で絞り込みます。[Batch Search and Add]：[Batch Search and Add] をクリックし、[Batch Search] ダイアログボックスに API 名を入力します。完全一致には
service_project.API_name形式を使用します。名前はセミコロン (;)、カンマ (,)、または改行で区切ります。最大 50 個の API。説明個人アカウントの権限については、参加しているサービスプロジェクトを選択してください。
[API 環境]
アカウントタイプがアプリケーションの場合に必要です。API 実行環境 ([開発環境]、[本番環境]、またはその両方) を選択します。
説明API は、開発環境に送信された設定、または本番環境に公開された設定を使用します。
[アプリケーション]
アカウントタイプがアプリケーションの場合に必要です。アプリケーショングループからアプリケーションを選択します。参加しているアプリケーションのみが利用可能です。キーワードで検索するか、一括検索を使用するか、
アイコンをクリックして [Application Group] で絞り込みます。[Batch Search and Add]：[Batch Search and Add] をクリックし、[Batch Search] ダイアログボックスにアプリケーション名を入力します。完全一致には
application_group.application_name形式を使用します。名前はセミコロン (;)、カンマ (,)、または改行で区切ります。最大 50 個のアプリケーション。[適用範囲]
アカウントタイプが アプリケーション の場合に必要です。利用可能なフィールドは API 実行環境 によって決まり、本番環境 または 開発環境 で認可が必要なフィールドが含まれます。行レベルの権限を持つ API は、[Row-level permission in effect] ステータスを表示します。[View Row-level Permission] をクリックして、[View Row-level Permission] パネルで環境ごとの権限詳細を表示します。
説明-
基本モードでは、開発環境の API が本番環境のデータにアクセスするため、注意して操作してください。
-
本番環境：API の現在のオンラインバージョンからレスポンスパラメーターを選択します。開発環境：最新バージョンから選択します。
-
プロキシモードでは、プロキシされたユーザーの行レベルの権限に基づいてデータを返します。プロキシ権限がない場合、データはアプリケーション自体の行レベルの権限に従います。
-
Create、Update、または Delete のオペレーションの場合、API はその実行環境に基づいてデータにアクセスします。フィールドの選択は必要ありません。
[権限設定]
[権限タイプ]
デフォルトで [使用権限] が選択されており、変更はできません。アカウントタイプが アプリケーション の場合は、[プロキシ権限] も選択できます。
-
[使用権限]：Create、Update、または Delete オペレーションの場合、使用権限のみを要求できます。
-
[プロキシ権限]：行レベルの権限が有効で、
DelegationUidパラメーターが設定されている場合に有効になります (この設定は [Data Service] > [Invocation] > [Authorized API Services] ページで行います)。アプリケーションがユーザーに代わって API を呼び出すには、プロキシ権限が必要です。API の呼び出しとテストのダイレクトモードとプロキシモード。
[有効期間]
オプション： [30 日間]、[90 日間]、[180 日間]、[無期限]、または [カスタム] (終了日を指定)。
[申請理由]
申請理由を入力します。最大 128 文字まで入力できます。
-
-
[Submit] をクリックします。
API 権限の返却
-
[API Permissions] タブで、対象 API の [Actions] 列にある [Return] をクリックします。
-
[Return This Permission] ダイアログボックスで [OK] をクリックし、API 権限を返却します。