API クライアント

機能概要

DataSpider BPMの提供するAPIを使用して外部のソフトウェアやサービスとの連携を行う際の設定を行います。
DataSpider BPMでは、以下の認証方式により設定内容が異なります。
システム管理権限を持つユーザが対象です。

項目説明

項目名 必須 説明
Basic 認証による API アクセス Basic 認証による API アクセスを有効にする 任意 Basic認証によるAPIアクセスを有効・無効にします。
チェックを入れることで、有効になります。
Basic認証によるAPIアクセス用のパスワードは、各ユーザのアカウント設定画面で設定します。
Basic認証によるAPIアクセス用のパスワードに関する詳細は、「パスワード」を参照してください。
Basic認証の方式および仕様に関する詳細は、「APIの認証方式」を参照してください。
OAuth2 クライアント一覧 名前 - クライアントアプリケーションの名称です。
OAuth2認証の方式および仕様に関する詳細は、「APIの認証方式」を参照してください。
クライアントID - クライアントアプリケーションのIDです。
クライアントアプリケーションの設定を登録した際に自動的に付与されます。
状態 - クライアントアプリケーションへの接続許可状態です。
「無効」に設定した場合は、OAuth2認証によるAPIアクセスは拒否されます。
作成日時 - クライアントアプリケーションの設定を登録した日時を表示します。

操作メニュー説明

表示 操作メニュー 説明
- [ヘルプリンク]アイコン 機能を説明するオンラインマニュアル(ヘルプ)ページを表示します。
Basic 認証による API アクセス [Basic 認証による API アクセス]タブ Basic 認証による API アクセス設定プロパティを表示します。
[保存]ボタン 設定内容を保存します。
OAuth2 クライアント一覧 [OAuth2 クライアント一覧]タブ OAuth2クライアント一覧プロパティを表示します。
[OAuth2 クライアント追加]ボタン OAuth2クライアント設定を追加します。
[OAuth2 クライアント]アイコン OAuth2クライアント設定の設定詳細を表示します。
[削除]アイコン OAuth2クライアント設定を削除します。
[OAuth2 クライアント編集]ボタン 登録済のOAuth2クライアント設定を変更します。
OAuth2クライアント編集プロパティが表示されます。
[保存]ボタン 編集したOAuth2クライアント設定を保存します。
[OAuth2 クライアント削除]ボタン 登録済のOAuth2クライアント設定を削除します。
[OAuth2 クライアント無効化]ボタン 登録済のOAuth2クライアント設定を無効にします。
[OAuth2 クライアント有効化]ボタン 登録済のOAuth2クライアント設定を有効にします。
[OAuth2 クライアント一覧へ戻る]ボタン OAuth2クライアント一覧プロパティに戻ります。

操作手順

OAuth2 クライアントを追加する

  1. [OAuth2 クライアント一覧]タブを選択します。
  2. [OAuth2 クライアント追加]ボタンを押下します。
  3. API クライアントにて、以下の項目を入力します。
    項目名 必須 説明
    名前 必須 クライアントの名称を入力します。
    リダイレクトURL 必須 認可リクエスト承認後に、リダイレクトされるクライアントのURLを設定します。
  4. [追加]ボタンを押下します。
APIへのアクセス権の範囲(スコープ)は、デフォルトで「any」(すべてのAPIへのアクセスを許可)が設定されます。
      「read」(データを取得するAPIへのアクセスを許可)を設定したい場合は、追加後に編集してください。

OAuth2 クライアント設定を編集する

  1. [OAuth2 クライアント一覧]タブを選択します。
  2. 一覧から、変更したいクライアントの[OAuth2 クライアント]アイコンを押下します。
  3. OAuth2 クライアントプロパティから、[OAuth2 クライアント編集]ボタンを押下します。
  4. OAuth2 クライアント編集にて、以下の項目を変更します。
    項目名 必須 説明
    名前 必須 クライアントの名称を入力します。
    リダイレクトURL 必須 認可リクエスト承認後に、リダイレクトされるクライアントのURLを設定します。
    スコープ 必須 APIへのアクセス権の範囲(スコープ)を以下から選択します。
    • any: すべてのAPIへのアクセスを許可(all)
    • read: データを取得するAPIへのアクセスを許可(readonly)
  5. [保存]ボタンを押下します。
APIへのアクセス権の範囲(スコープ)をすべて選択した場合でも「any」(すべてのAPIへのアクセスを許可)の権限が適用されます。

OAuth2 クライアント設定を削除する

  1. [OAuth2 クライアント一覧]タブを選択します。
  2. 一覧から、削除したいクライアントの[OAuth2 クライアント]アイコンを押下します。
  3. OAuth2 クライアントプロパティから、[OAuth2 クライアント削除]ボタンを押下します。
  4. 「OAuth2 クライアントを削除しますか？」の確認ダイアログが表示されます。
  5. [OK]ボタンを押下します。

OAuth2 クライアント設定を無効化または有効化する

  1. [OAuth2 クライアント一覧]タブを選択します。
  2. 一覧から、無効化または有効化したいクライアントの[OAuth2 クライアント]アイコンを押下します。
  3. OAuth2 クライアントプロパティから、[OAuth2 クライアント無効化]または[OAuth2 クライアント有効化]ボタンを押下します。
  4. 「OAuth2 クライアントを無効化(有効化)しますか？」の確認ダイアログが表示されます。
  5. [OK]ボタンを押下します。