API を呼び出す前に、API 権限をリクエストする必要があります。このトピックでは、API 権限をリクエストして返却する方法について説明します。
前提条件
DataService Studio 付加価値サービス (VAS) を購入済みであり、現在のテナントで DataService Studio モジュールが有効になっている必要があります。モジュールを有効にする方法の詳細については、「テナント管理」をご参照ください。
権限の説明
アプリケーションのオーナーのみが API 権限を返却できます。
API 権限のリクエスト
Dataphin ホームページの上部メニューバーで、[管理センター] > [権限管理] を選択します。
左側のナビゲーションウィンドウで、[マイ権限] > [データサービス権限] を選択します。次に、上部のメニューバーで [API 権限] をクリックします。[API 権限] タブで、右上の [+ API 権限のリクエスト] ボタンをクリックします。
[API 権限リクエスト] ページで、パラメーターを構成します。
パラメーター
説明
API 権限オブジェクト
API
サービスプロジェクトと API グループに基づいて API を選択します。個人アカウントの API 権限をリクエストする場合は、リクエストが成功するように、現在のオペレーターが参加しているサービスプロジェクトを選択します。
アカウントタイプ
API 権限付与のアカウントタイプを選択します。[アプリケーション] または [ユーザーアカウント] を選択できます。システムはデフォルトで [アプリケーション] を選択します。
アプリケーション: API の操作タイプが作成、更新、または削除の場合、アプリケーションにのみ権限を付与できます。
ユーザーアカウント: ユーザーアカウントを選択し、API が開発環境にあり、API が基本モードである場合、API は本番データ環境にアクセスします。注意して進めてください。API が開発環境にあり、Dev-Prod モードである場合、API は開発データ環境にアクセスします。
API ランタイム環境
この構成は、アカウントタイプがアプリケーションの場合に必要です。API のランタイム環境を選択します。[開発環境] と [本番環境] を選択できます。複数選択がサポートされています。
説明API は、選択されたランタイム環境に基づいて実行されます。API ランタイム環境が開発環境に設定されている場合、API は開発環境に送信された構成に基づいて実行されます。API ランタイム環境が本番環境に設定されている場合、API は本番環境に公開されている構成に基づいて実行されます。
権限プロジェクト
API によって選択されたサービスプロジェクトに基づいて表示されます。変更はサポートされていません。
アプリケーション
このパラメーターは、[アカウントタイプ] を [アプリケーション] に設定した場合に必要です。アプリケーショングループからアプリケーションを選択します。現在のオペレーターが参加しているアプリケーションを選択できます。
権限フィールドテーブル
この構成は、アカウントタイプがアプリケーションの場合に必要です。権限付与が必要な API ランタイム環境（本番環境または開発環境）に基づいて、オプションフィールドが選択されます。API が行レベルの権限に関連付けられている場合、システムはそれを [行レベルの権限がアクティブ] として識別します。[行レベルの権限を表示] ボタンをクリックすると、[行レベルの権限を表示] パネルで対応する環境の行レベルの権限情報を表示できます。
説明API が開発環境を選択し、基本モードになっている場合、アクセスされるデータ環境は本番データ環境です。注意して進めてください。
API ランタイム環境が本番環境の場合、現在の API オンラインバージョンの戻りパラメーターを選択できます。API ランタイム環境が開発環境の場合、開発環境の現在の API 最新バージョンの戻りパラメーターを選択できます。
アプリケーションが API を呼び出すためのプロキシモード権限をリクエストする場合、システムは委任されたユーザーの行レベルの権限に基づいてデータを返します。アプリケーションにプロキシモード権限がない場合、データはアプリケーションの行レベルの権限に基づいて返されます。
API の操作タイプが作成、更新、または削除の場合、データは API ランタイム環境に基づいてアクセスされ、フィールドを選択する必要はありません。
権限構成
権限タイプ
システムはデフォルトで [使用権限] を選択します。変更はサポートされていません。アカウントタイプがアプリケーションの場合、[プロキシ権限] を選択できます。
使用権限: API の操作タイプが作成、更新、または削除の場合、使用権限のみをリクエストできます。
プロキシ権限: この権限は、API で行レベルの権限が有効になっており、DelegationUid パラメーターが空でない場合に有効になります。[DataService Studio] > [呼び出し] > [承認済み API サービス] の呼び出しページの共通パラメーターリストで行レベルの権限パラメーターを設定できます。API を呼び出すには、プロキシモードの権限をリクエストする必要があります。これにより、アプリケーションはユーザーに代わって行レベルの権限に関連付けられた API を呼び出すことができます。API 呼び出しの直接接続モードとプロキシモードの詳細については、「API 呼び出しとテストの直接接続モードとプロキシモード」をご参照ください。
有効期間
[30 日]、[90 日]、[180 日]、または [長期] を選択します。または、カスタムを選択して終了日を指定します。
申請理由
承認者のレビューを容易にするために、申請理由を入力してください。128 文字以内。
[送信] をクリックして、API 権限リクエストを完了します。
API 権限の返却
[API 権限] タブで、ターゲット API 列の下の [アクション] をクリックし、[返却] を選択します。
[権限の返却] ダイアログボックスで、[確認] をクリックして、API 権限の返却を完了します。