用語集

以下の用語の中には、一般的な用語でありながら、Apigee において独自の意味を持つ用語があります。

用語 定義
API 既存の API に対するファサードとして動作するプロキシです。デベロッパーは、既存の API ではなく、Apigee が生成した新しい API を呼び出します。ファサードが公開インターフェースをバックエンド API から分離し、デベロッパーがバックエンドの変更を気にする必要がなくなるため、内部の開発チームに影響を与えることなくエッジを刷新できます。バックエンドを変更しても、中断せずに引き続き同じ API を使い続けられます。たとえば、Apigee が同じ API を複数のインターフェースで公開することにより、さまざまなデベロッパーに合わせて同時に API のシグネチャをカスタマイズする必要がなくなります。
API のベースパスとリソース API は、ベースパスとリソース(リソースパスとも呼ばれます)の集まりからなります。API ごとに、1 つのルート URL と複数のリソースパスを決めます。単純に、共通のベースパスを使う URI の集まりと考えても構いません。API を管理しやすくするため、Apigee では、この未加工の URI に表示名と説明を付加しています。
API コンシューマ API プロバイダによって作成された API を使用する「アプリ デベロッパー」と同義です。
API デベロッパー API プロバイダ組織内で API を作成するソフトウェア エンジニアです。アプリ デベロッパー(API コンシューマ)はこれらの API を使用してアプリを構築します。
API パッケージ デベロッパーに 1 つのバンドルとして公開される API プロダクトの集まりです。通常は料金プランに関連付けられています。
API プロダクト API リソース(URI)の集まりに、サービスプランを組み合わせたもので、デベロッパーに 1 つのバンドルとして公開されます。また API プロダクトには、モニタリングや分析のために、ビジネスに固有なメタデータを付加することもできます。それらを API プロダクトに付加することにより 1 つ以上のリソースから収益を得られます。さらに、こうした API プロダクトを、収益化を目的とした API パッケージにバンドルすることもできます。
API プロバイダ API プロバイダは、API コンシューマ(アプリ デベロッパー)が使用する API を、(Edge を使用して)作成します。
アプリ デベロッパー Edge で、アプリ デベロッパーは作成したアプリを API プロバイダに登録します。これにより、アプリ デベロッパーはプロバイダの API プロキシを呼び出すために必要な API キーを取得します。
アプリ デベロッパーは、アプリを使って API プロダクトのリソースにアクセスします。アプリを作るときには、それを入れる API プロダクトを選び、Apigee がキーを生成します。各アプリは、複数の API プロダクトへのアクセス権を与えるキーを 1 つずつ持っています。アプリは、リソースへのアクセス権を誰に与えるかを管理できます。アプリのキーを取り消したり更新したりして、API プロダクトへのアクセスを制御できます。リソースのバンドルに対するアクセスは、アプリ内のプロダクトに対するアクセス権を取り消したり削除したりすることによって制御できます。
残高詳細 前払デベロッパーの場合、デベロッパーの口座残高です。
締切済調整 発行された請求書に適用された調整のことです。
締切済請求月 請求書が発行された月のことです。
カスタム制限 API プロダクトに対するトランザクション数の制限など、収益化を使って明示的に設定できる制限のことです。明示的制限とも呼びます。
デベロッパー カテゴリ料金プラン 特定のカテゴリのデベロッパーに適用される料金プランです。そのカテゴリのすべてのデベロッパーが購入できます。
デベロッパー料金プラン 特定のデベロッパーに適用される料金プランです。そのデベロッパーだけが購入できます。
公開代理人 商法では、第三者との法的関係を構築するために本人を代理する権限を持つ者です。収益化では、API 提供者がデベロッパーの代理として収益(場合によっては売上税も)を徴収するための公開された代理人として行動するように、共同収益計画に対して税モデルを設定できます。
公開税モデル API 提供者がデベロッパーの公開代理人として行動する税モデルです。
環境 API 実行時の実行コンテキストです。API は、実行時にアクセスされる前に、環境へデプロイしなければなりません。デフォルトで、Apigee 組織は「test」と「prod」という 2 つの環境にプロビジョニングされます。「test」は、通常、テスト中の API をデプロイするために使います。「prod」は、通常、本番環境用の API をデプロイするために使います。
混合税モデル API 提供者がデベロッパーの公開代理人として行動する税モデルです。ただし、API 提供者が、契約者から集めた売上税をデベロッパーに代わって地方税務当局に支払います。
非明示的制限 収益化が設定する、デベロッパーの前払残高制限などの制限です。
収益化 Apigee Edge Developer Services のコンポーネントで、API プロダクトの使いやすく柔軟な収益化方法を提供します。
月次使用料 ある月のデベロッパーの総使用額です。設定料金、トランザクション料金、定期料金が含まれます。
月払い 購入したプランに基づいてデベロッパーが支払った定期払い。料金プランには、使用頻度に関係なく毎月デベロッパーに請求される定期料金が課されることがあります。
相殺明細書 請求書と収益分配明細の間の正味の差額を示す財務書類。
締切前調整 発行された請求書に適用されていない調整のことです。
締切前請求月 「最終的な」請求書がまだ発行されていない月のことです。
組織 API、API プロダクト、API パッケージ、アプリ、デベロッパーなど、Apigee アカウントに含まれるあらゆるオブジェクトのコンテナです。所属する組織ごとにユーザー アカウントが必要です。(ほとんどのユーザーは 1 つの組織にしかアカウントを持ちません。)API リクエストを送信するたびに、認証情報(ユーザー名とパスワード)と組織の名前を提示する必要があります。
パッケージ カタログ API パッケージの目録です。パッケージごとに、API プロダクトと料金プランが記載されています。
前払残高 前払デベロッパーが API パッケージに対して事前に支払う金額の残高。
前払デベロッパー API プロダクトの使用料を前払いするデベロッパーです。所持金は、API プロダクトが使用されたときに前払デベロッパーの残高から差し引かれます。このデベロッパーは、API プロダクトを購入するのに十分な前払残高を維持する必要があります。API 提供者が、デベロッパーを前払いか後払いの状態に割り当てます。
ポリシー API フロー内において、ロジックのアトミックで再利用可能な単位として実行される処理ステップです。通常、ポリシーには、適切なエンドポイントへのルーティング要求、メッセージの形式変換、アクセス制御の強制、追加情報を要求するためのリモート サービスの呼び出し、外部ユーザーに対する機密情報の秘匿、潜在的な脅威を見つけるためのメッセージ内容の検証、一般的なレスポンスのキャッシュ処理を通じたパフォーマンス向上などがあります。ポリシーは、リクエスト メッセージやレスポンス メッセージの内容やコンテキストに基づき、条件付きで実行されることがあります。たとえば、リクエスト メッセージがスマートフォンから送信されてきた場合に、変換ポリシーを実行してレスポンスの形式をカスタマイズできます。
後払デベロッパー API プロダクトの使用料を毎月(請求書で)請求されるデベロッパーです。デベロッパーは、請求書に含まれるプランで設定された支払条件に基づいて、API プロダクトの使用料を支払います。API 提供者が、デベロッパーを前払いか後払いの状態に割り当てます。
プライス ポイント 販売される可能性のある価格の範囲です。
料金表料金プラン デベロッパーに対して、収益化された API プロダクトに係わる各トランザクションの固定料金あるいは変動料金が課金される料金プランです。
料金プラン 収益化された API パッケージで提供される API プロダクトの使用に関する料金、その他の費用、収益分配の仕様です。
リソース
パス
RESTful コンセプトの 1 つで、所定のリソースまでのネットワーク パスを指定する統一資源識別子(URI)です。
収益分配料金プラン 収益化された API プロダクトに係わる各トランザクションから発生した収益の一定割合を、リクエストを発行したアプリのデベロッパーと分け合う料金プランです。
収益分配料金表料金プラン 収益化された API プロダクトに係わる各トランザクションから発生した収益の一定割合を、リクエストを発行したアプリのデベロッパーと分け合う料金プランです。また、デベロッパーに対して、各トランザクションの固定料金あるいは変動料金も課金されます。
自己請求書 収益分配明細の代わりに生成される財務書類です。デベロッパーに支払われる金額の明細であり、デベロッパーの代わりに API プロバイダへ発行される請求書の役目を果たします。
標準料金プラン すべてのデベロッパーが購入できる料金プランです。
デベロッパーの使用料と手数料にかかる税金の合計です。
チャージ 前払デベロッパーが前払残高に資金を追加する行為です。
トランザクション記録ポリシー 収益化でトランザクション パラメータとカスタム属性を保存することを可能にするメカニズムです。収益化には、各トランザクションで保存されたカスタム属性に基づいて API リクエストと API レスポンスへ料金プランを適用するなど、収益化処理にこの情報が必要です。
匿名代理人 デベロッパーの代わりにコンテンツを購入するとみなされるような(税務目的のみ)、アプリケーションの基本的な供給に参加する組織(または運営者)。匿名の代理人として、組織(または運営者)はエンドユーザーが支払うべき税金を回収し、会計処理することができます。この扱いは税務目的のみに関連するものであり、デベロッパーのサプライ チェーンにおける法的な扱いには影響を与えません。
非公開税モデル API 提供者がエンドユーザーから収集した税金を控除し、地方税務当局に支払う税モデルです。
バージョン デベロッパーに公開されている API インターフェースのバージョンです。たとえば、pivotaltracker.com/services/v3 や api.enterprise.apigee.com/v1 です。この用語と「リビジョン」には使い分けがあります。リビジョンは、構成やポリシーをバンドルして API プロキシにした、バージョン管理された番号付きパッケージを指します。つまり、API インターフェースにはバージョンがあり、API プロキシにはリビジョンがあるということです。