以下のコンセプトの中には、一般的なアイデアながら Apigee において独自の意味合いを持つものがいくつかあります。
用語 | 定義 |
---|---|
API | 既存の API のファサードとして機能するプロキシ。デベロッパーは、既存の API を呼び出すのではなく、Apigee によって生成された新しい API を呼び出します。ファサードによって、公開インターフェースがバックエンド API から切り離され、デベロッパーがバックエンドの変更を気にする必要がなくなるため、内部の開発チームに影響を与えることなくエッジを刷新できます。バックエンドを変更しても、中断せずに引き続き同じ API を使い続けることができます。たとえば、Apigee では複数のインターフェースを同じ API に公開でき、API のシグネチャをカスタマイズして、デベロッパーのさまざまな分野におけるニーズを同時に満たすことができます。 |
API のベースパスとリソース | API は、ベースパスと一連のリソース(リソースパス)から構成されます。API ごとに、1 つのルート URL と複数のリソースパスを定義します。API は、単純に一連の URI であると考えることができます。すべての API は共通のベースパスを共有します。API を管理しやすくするため、Apigee では、この未加工の URI に表示名と説明を付加しています。 |
API コンシューマ | 「アプリ デベロッパー」と同義。API プロバイダによって作成された API を使用します。 |
API デベロッパー | API プロバイダ組織内で API を作成するソフトウェア エンジニア。アプリ デベロッパー(API コンシューマ)はこれらの API を使用してアプリを構築します。 |
API パッケージ | デベロッパーに提供される API プロダクトの集まり。1 つのバンドルとして提供されます。通常は料金プランに関連付けられます。 |
API プロダクト | API リソース(URI)の集まりに、サービスプランを組み合わせたもので、デベロッパーに 1 つのバンドルとして提供されます。また API プロダクトには、モニタリングや分析のために、ビジネスに固有のメタデータを付加することもできます。1 つ以上のリソースを API プロダクトに付加して収益化することが可能です。さらに、こうした API プロダクトを API パッケージにバンドルして収益化することもできます。 |
API プロバイダ | API プロバイダは、API コンシューマ(アプリ デベロッパー)が使用する API を(Edge を使用して)ビルドします。 |
アプリ デベロッパー | Edge では、アプリ デベロッパーは作成したアプリを API プロバイダに登録します。これにより、アプリ デベロッパーは、プロバイダの API プロキシの呼び出しに必要な API キーを取得します。 |
アプリ | デベロッパーは、アプリを使用して API プロダクトのリソースにアクセスします。アプリを作成する際に、アプリに含める API プロダクトを選択します。Apigee によってキーが生成されます。各アプリには、複数の API プロダクトへのアクセスを可能にする単一のキーが付与されます。アプリでは、リソースにアクセスできるユーザーを制御できます。アプリのキーを取り消しおよび更新することにより、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 プロキシにはリビジョンがあるということです。 |