PLaMo APIコンソール マニュアル
PLaMoのAPI機能をご利用いただくためには、APIキーの発行が必要です。 APIキーを使用することで、HTTPリクエストを通じてPLaMoの機能にアクセスできます。
コンセプト
APIコンソールの利用において重要な、以下の3つの概念について説明します。
テナント
テナントは、PLaMoプラットフォーム利用における最上位の管理単位です。
組織的な特徴：
- テナントは、PLaMo APIの課金アカウントにつき1つ作成されます。
- テナントの中で、複数のプロジェクトを作成・管理できます。
- たとえば、企業全体で1つのテナントを持ち、その中に部署やサービス単位でプロジェクトを作成するといった使い方が可能です。
課金管理：
- PLaMo APIの利用額の請求は、テナント単位で行われます。
- テナント内のすべてのプロジェクトにおけるトークン使用量は、テナント単位で集計され、一括して請求されます。
プロジェクト
プロジェクトは、テナント内でのAPIキーの管理や予算管理の単位として機能します。
組織的な特徴：
- 1つのテナントに、複数のプロジェクトが作成できます。
- 1人のメンバーが複数のプロジェクトに所属でき、各プロジェクトには複数のメンバーが参加できます。
APIキーの管理：
- 各プロジェクトには、プロジェクトに紐づくAPIキーを作成できます。
- プロジェクトに紐づくAPIキーを使用した場合、トークン使用量はそのプロジェクトに集計されます。
- 個人用のAPIキーとは異なり、プロジェクトに属する複数メンバーで管理できます。
予算管理：
- 各プロジェクトごとに、日ごと・月ごとのトークン使用量 および 利用額の確認ができます。
- プロジェクトごとに、利用額の上限設定やアラート設定ができます。
- これにより、プロジェクトごとの予算管理や費用の可視化が容易になります。
運用方法：
プロジェクトは、実際の業務プロジェクトや部門に合わせて作成することをお勧めします。 たとえば以下のような単位でプロジェクトを用意することで、その単位ごとのトークン使用量を把握し、 予算の按分やプロジェクト毎の利用額の制限の設定に役立つ可能性があります。
- 製品開発チーム単位
- サービス単位
- 研究開発部門
デフォルトプロジェクト：
Defaultという名前の特別なプロジェクトが初期状態で用意されています。このプロジェクトには、テナントの全メンバーが自動的に所属します。基本的な作業や検証作業にご活用ください。
ロール
PLaMo APIコンソールでは、以下の3つのロールが用意されています。
- テナント管理者
- プロジェクト管理者
- メンバー
テナント管理者：
- テナントのすべてのプロジェクト・リソースにアクセスできます。
- プロジェクトの作成・削除、各プロジェクトの利用額の上限設定・アラート設定ができます。
- テナントへのメンバーの招待・削除、権限設定ができます。
プロジェクト管理者：
- 所属するプロジェクトにて、APIキーの作成、削除、再発行ができます。
- プロジェクトへのメンバーの追加・削除、権限設定ができます。ただし、プロジェクトメンバーとして追加できるのは、すでにテナントに所属しているメンバーのみです。
- プロジェクトのトークン使用量 および 利用額の確認ができます。
メンバー：
- 所属するプロジェクトにて、プロジェクトの利用額の確認ができます。
- APIキーの作成、削除、再発行はできません。
機能
ユーザの招待
ユーザがテナントにアクセスするためには、既存のテナント管理者からの招待が必要です。 招待を受け取ったユーザは、招待を承認することでテナントにアクセスできます。
テナントに招待する際の権限として、テナント管理者 と 一般ユーザ が選択できます。 プロジェクト管理者 もしくは メンバー として招待する場合は、 一般ユーザ を選択してください。
招待を承認してログインしたのち、プロジェクトにメンバーとして追加することで、プロジェクトへのアクセスが可能になります。 プロジェクトへのメンバー追加は、テナント管理者 もしくは プロジェクト管理者が実施できます。
APIキーの管理
APIキーは、PLaMo APIサービスにアクセスする際の認証に使用されます。 APIキーは厳重に管理し、他者と共有しないようにしてください。
APIキーには、個人用のAPIキーとプロジェクト用のAPIキーの2種類があります。
個人用APIキー:
- 各メンバーは、個人用のAPIキーを1つ発行できます。プロファイルページから発行できます。
- メンバーがテナントのメンバーから削除された場合、そのメンバーに紐づくAPIキーは即時無効になります。
- 個人用APIキーを使用した場合、使用したトークンはテナント全体のトークン使用量にのみ集計されます。
プロジェクトAPIキー:
- プロジェクト管理者は、プロジェクト用のAPIキーを複数発行できます。
- プロジェクトAPIキーは、プロジェクトメンバーが削除されても無効になりません。
- プロジェクトAPIキーを使用した場合、使用したトークンはそのプロジェクトのトークン使用量とテナント全体のトークン使用量の両方で集計されます。
APIキーの再発行
APIキーが漏洩したり、不正利用された懸念がある場合は、APIキーを再発行 もしくは 削除してください。
APIキーを再発行すると、古いAPIキーは即時無効になります。 稼働中のサービスに組み込んでいる場合は、事前に別のAPIキーを発行し、入れ替えてから再発行をするなど、サービスに影響が出ないようにご注意ください。
課金の上限設定
課金に関する制限は以下の3つのレベルで設定されます。
テナント単位のクオータ
- テナント全体での利用額に対する制限で、予期せぬ使用により多額の請求が発生しないように最初から一定の制限がかかっています。
- この制限を引き上げるには、クオータ引き上げの申請が必要です。
- 利用額がクオータに到達した場合、APIリクエストはブロックされます。
テナント単位の課金上限
- テナント全体での利用金額に対する上限を、お客様ご自身で設定できます。
- クオータを上回らない範囲で自由に設定できます。
- 月単位で設定が可能です。設定額に達すると自動的にAPI利用が制限されます。
- アラート通知の設定も可能です。特定の閾値に達した際、管理者に通知を送ることができます。
プロジェクト単位の課金上限
- 各プロジェクトごとに独立して利用金額の上限を設定できます。
- プロジェクトの予算管理に活用できます。
- 月単位で設定が可能です。プロジェクトの上限に達した場合、そのプロジェクトのみAPI利用が制限されます。
- テナントと同様アラート通知も可能です。
利用額やアラートの閾値の引き下げについて
テナントとプロジェクトの制限に関して、 超過した後でそれを下回る制限に引き下げたとしても、確定している課金額は変わりません。 アラートも同様で、すでに達している課金額以下に引き下げられたときにはアラートは発出しません。 あくまでAPI利用で利用額が増加したタイミングですでに設定されている額を超過した時に アラートを発出したり、利用を制限する機能です。
コンソールの使い方
基本的な画面構成：
画面上部のヘッダ右側でテナントかプロジェクトを選択することで、それぞれ テナントの設定モードかプロジェクトの設定モードかを切り替えることができます。
テナント設定
テナントモードでは、以下の6つの主要な機能を左サイドバーから利用できます。
プロジェクト管理：
- 新規プロジェクトの作成
- 既存プロジェクトの設定変更
- 既存プロジェクトの削除
ユーザ管理：
- テナントメンバーの権限設定
- メンバーの削除
- 新規メンバーの招待
利用状況：
- テナント全体の利用金額の確認
- 日次でのトークン使用量の確認
- トークン使用量の推移グラフ表示
利用上限設定：
- テナント全体の利用額制限の設定
- 各プロジェクトの利用額制限の設定
- アラート閾値の設定
テナント設定：
- テナント名の変更
- 2要素認証の有効化
- テナントの基本情報の確認
請求管理：
- 外部の請求管理サイトへのリンク
- 請求履歴の確認
- 支払い方法の登録・変更
- サブスクリプションの解約
プロジェクト設定
プロジェクトモードでは、以下の4つの主要な機能を左サイドバーから利用できます。
APIキー管理：
- 新規APIキーの発行
- 既存APIキーの削除
- APIキーの再発行
メンバー管理：
- プロジェクトメンバーの追加
- メンバーの権限設定
- メンバーの削除
利用状況：
- プロジェクト単位での利用金額の確認
- 日次でのトークン使用量の確認
- トークン使用量グラフ表示
プロジェクト情報：
プロジェクト名の確認・変更
プロジェクトの基本情報の確認