オプションのプロジェクト API
必要なときに、合意されたアプリケーション操作を表示します。
対象プロジェクトのAPIスコープを確認し、計画中のルートとすでに構築済みのエンドポイントを区別します。
APIを、定義されたプロジェクトオプションとして扱ってください
- オプションを確認
API の利用状況と、それに対応するプロジェクトのプランを確認してください。
- ルートの範囲を定義
APIが提供すべきビジネスオペレーションを明確にしてください。
- ルートカタログを確認する
各ルートの状況、経路、および計画または現在のステータスを確認します。
プロジェクトに必要な場合に API を追加します
プロジェクトAPIは、オファーにおけるオプションの機能です。有効にする前に、その範囲と条件を確認してください。すべてのアプリケーションにAPIが含まれていると想定しないでください。
APIツールは、提案されたルートをビジネスエリア別に整理します。明確化により、各操作の実装前に、その操作が何をするかを定義できます。
意図されたルートと実際の動作エンドポイントを区別する
他のシステムへのアクセスを設定します. プロジェクトでは、ビジネスオペレーションに別のアプリケーションが必要になる場合があります。すべての機能が自動的に公開されると想定するのではなく、オプションの API スコープと提供内容を確認してください。合意されたオペレーションは、統合がアクセスする必要があるものを定義します。
ルートカタログを確認する. カタログには、各ルートの方法、パス、説明、および状態が表示されます。提案されたスコープと、ライブとして登録されているエンドポイントを区別するのに役立ちます。これは、APIの準備に従う際の便利なリファレンスです。
適切な連携方向を選択してください. 別のプロバイダーのAPIを使用し、独自のアプリケーションを公開することは、異なるニーズです。外部接続は前者に対応し、プロジェクトAPIは合意された公開に対応します。目的のビジネス取引に合った方法を選択してください。
公開されているAPIと外部接続の違いを説明する
プロジェクトAPIは、アプリケーションの合意された操作を公開します。外部接続は、アプリケーションが別のサービスをどのように使用するかを記述します。これらは異なるニーズに対応します。
ルートカタログを使用して、メソッド、パス、およびエンドポイントが計画されているか、またはライブ状態であるかを確認します。このプレゼンテーションは、プロジェクトのAPIをアクティブ化するものではありません。
具体的なニーズに対して、APIオプションを評価する
プロジェクトのデータを利用する対象者と、その統合に必要な操作を特定します。これにより、オプションの API 範囲と、既存の外部サービスへの接続を区別できます。
対象となるプロジェクトの場合、計画されたルートとその建設状況を確認してください。統合で利用可能なエンドポイントを検討する前に、関連するサービスと環境を確認してください。
オプションの範囲から、検証済みの対象範囲へ
空き状況と条件をご確認ください. 実際のプロジェクトオファーで API オプションを確認してください。API の公開が必要かどうかを、アクティブ化前に決定してください。
操作内容を明確にする. 提案されたビジネスオペレーションを確認し、その期待される動作に関する質問に答えてください。準備段階と構築段階に従ってください。
ライブ配信をチェック. アクティブ化されたプロジェクトのルートカタログと公開されたリファレンスを確認します。計画されたルートは、動作するエンドポイントではありません。
APIを追加する前に、連携の範囲を定義します。
別のシステムが必要とする操作を説明し、オプションの条件を確認します。APIは、合意されたビジネス取引を目的とする必要があります。
オプションのプロジェクト API に関する質問
これは、実際のオファーに可用性と価格が表示されるオプションです。アプリケーションは、これをアクティブにしなくても動作します。このプレゼンテーションは、プロジェクトの API をプロビジョニングまたは有効にしません。
これは、まだライブエンドポイントとして登録されていない、計画された操作について説明するものです。統合を開始する前に、カタログの状態と実際の公開された参照を使用してください。
プロジェクトAPIビューには、公開する領域、質問、インフラストラクチャ、および構築状態が表示されます。記載されている前提条件を解決し、結果として得られるルートカタログを確認してください。
有効になっているプロジェクトと関連する環境に属するAPIリファレンスを使用してください。計画中のルートからエンドポイントまたは認証の例を推測しないでください。
それらは、アプリケーションが使用する別のサービスについて説明しています。この統合の方向性は、プロジェクトAPIを通じて独自のアプリケーション操作を公開することとは異なります。