ARSマニュアル

最終更新日: 2025/5/20

ARSマニュアル

ARS（API Registration Server）は、APIサービス登録プラットフォームです。 このマニュアルでは、ARSの基本的な使用方法と主要機能について説明します。

目次

1. ARSの概要

ARSは、APIレジスターを実装したサーバーで、以下の主要機能を提供します：

  • RESTful APIの登録と管理：システムのAPIを一元管理
  • 複数APIを組み合わせたフロー管理：APIの連携による高度な機能の実現
  • APIの入出力パラメータの設定：詳細なパラメータマッピングと型定義
  • データベースによるツール管理：APIツールの永続的な管理
  • 組織単位でのアクセス制御：組織内でのリソース管理

2. はじめ方

1

アカウント作成

ARSポータルにアクセスし、以下の手順で新規アカウントを作成します：

  1. 画面右上の「新規登録」ボタンをクリックします。
  2. アカウントタイプを選択します：
    • 個人アカウント：個人での利用に最適
    • 組織アカウント：チームでの利用や、組織内でのAPI管理に最適
  3. 必要な情報を入力します：
    • ユーザー名（半角英数字、4文字以上）
    • メールアドレス（有効なメールアドレス）
    • パスワード（半角英数字記号、8文字以上）
    • 組織名（組織アカウントの場合のみ）
  4. 利用規約とプライバシーポリシーを確認し、同意にチェックを入れます。
  5. 「アカウント作成」ボタンをクリックします。

※組織アカウントを作成することで、組織内でのAPI管理やユーザー権限の設定が可能になります。

2

ログイン

作成したアカウントでARSポータルにログインします。

  1. ARSポータルにアクセスします。
  2. 画面右上の「ログイン」ボタンをクリックします。
  3. 以下のいずれかの方法でログインします：
    • ユーザー名とパスワードを入力してログイン
    • メールアドレスとパスワードを入力してログイン

※パスワードは大切に保管してください。パスワードを忘れた場合は、システム管理者にお問い合わせください。

3. ツール管理

ARSでは、外部APIをツールとして登録・管理できます。主な機能は以下の通りです：

  • 基本設定：
    • ツール名と説明：目的と機能を明確に示す名前と説明文
    • HTTPメソッドの選択：GETまたはPOSTを指定
    • エンドポイントURL：APIのベースURLを設定
  • パラメータ設定：
    • APIパラメータ名の定義：
      • 通常パラメータ：固定のパラメータ名
      • 動的パラメータ：実行時に値をキーとして使用
    • パラメータタイプの指定：
      • text：テキスト入力
      • option：選択肢から選択
    • データソースの設定：
      • 固定値：決まった値を使用
      • パラメータ：実行時のパラメータから取得
      • ツールリクエスト：他のツールのリクエストから取得
      • ツールレスポンス：他のツールのレスポンスから取得
  • 組織設定：
    • ツールの所有組織の設定
    • アクセス権限の管理
  • 管理機能：
    • ツールの作成・更新・削除
    • ツールの検索と表示

4. APIフロー管理

複数のツールを組み合わせて実行するフローを作成・管理できます。主な機能は以下の通りです：

  • 基本設定：
    • フロー名：目的を示す明確な名前
    • 説明文：フローの処理内容や用途の説明
    • 組織設定：フローを利用できる組織の指定
  • ステップ設定：
    • ステップの追加：使用するツールの選択と順序の指定
    • ツール連携：
      • 前のステップの結果を次のステップに引き継ぎ
      • ツール間でのパラメータマッピング
  • フロー操作：
    • 一覧表示：所属組織のフロー一覧の取得
    • 詳細表示：フローの詳細情報の確認
    • 作成・更新：フローの新規作成と編集
    • 削除：不要なフローの削除

※フローの実行と管理は組織単位で行われます。

5. オプション管理

APIツールで使用する選択肢（オプション）を管理するための機能です：

  • オプションセットの管理：
    • 基本情報の設定：
      • セット名：用途を示す分かりやすい名前
      • 説明文：オプションセットの用途や内容の説明
      • 組織設定：オプションセットを利用できる組織
    • オプション項目の設定：
      • 選択値（Value）：システムで使用する値
      • 表示ラベル（Label）：ユーザーに表示する名称
  • オプションセットの操作：
    • 一覧表示：所属組織のオプションセット一覧の取得
    • 詳細表示：オプションセットの詳細情報の確認
    • 作成・更新：オプションセットの新規作成と編集
    • 削除：不要なオプションセットの削除

※オプションセットは組織単位で管理され、権限のある組織のメンバーのみが編集できます。

6. 認証と権限

ARSでは、以下の認証方式を提供しています：

  • APIキーについて：
    • 外部システムからのAPI呼び出しに使用
    • プレフィックス「ars_」で始まる一意の文字列
    • 組織単位でのアクセス制御
  • APIキーの使用方法：
    • HTTPヘッダー：X-API-Key: ars_your_api_key
    • Authorizationヘッダー：Authorization: ApiKey ars_your_api_key
    • Bearer認証：Authorization: Bearer ars_your_api_key

※セキュリティ上の理由から、APIキーは定期的に更新し、必要最小限の権限のみを付与することをお勧めします。

7. 組織管理

ARSでは組織単位でのリソース管理を行います：

組織の操作

  • 一覧表示：組織の一覧を取得
  • 詳細表示：組織の詳細情報を確認
  • 作成・更新：組織の新規作成と編集
  • 削除：不要な組織の削除

組織ユーザー管理

  • ユーザーの追加・削除：メンバーシップの管理
  • 権限設定：ユーザーの役割とアクセス権の管理

リソース共有の設定

  • ツールの共有範囲：APIツールのアクセス制御
  • フローの共有設定：ワークフローの公開範囲
  • オプションセットの共有：選択肢リストの公開設定

組織は、ユーザー、ツール、フロー、オプションセットなどのリソースを管理する基本単位です。適切な権限設定により、チーム間の効率的なリソース共有が可能になります。