概念: Adaptive Planning REST API
基本的な REST API アプローチ
Adaptive Planning API には、以下の 3 つの一般分野があります。
- メタデータの取得および操作
- Data retrieval.
- データの作成と更新
クライアントは、Adaptive Planning のメイン Web サービス エンドポイントに HTTP POST リクエストを送信することにより、API コールを呼び出します。エンドポイントには、使用している API のバージョンを示すバージョン番号が含まれます。Adaptive Planning API の現在のバージョンは v40 です。インスタンスが米国以外の地域の認証を使用している場合、認証 URL と API エンドポイントは地域によって異なります。参照 参考: 地域認証 URL。
https://api.adaptiveplanning.com/api/v40
API バージョンは通常、新しい Adaptive Planning 製品リリースに応じて更新されますが、すべての製品リリースが新しい API バージョンになるわけではありません。後続の API バージョンのリリースから少なくとも 1 年は現バージョンをサポートすることになります。
API の変更の履歴については、 を参照してください。 リリース別の API の変更。
HTTP POST リクエストには、XML ドキュメントに POST データが含まれています。この XML ドキュメントには、すべての API メソッド呼び出しに存在する標準セクションと、各 API メソッド呼び出しに固有のセクションが含まれます。Adaptive Planning サーバーが API メソッド呼び出しを処理し、結果を別の XML ドキュメントとして返します。リクエストと同様、応答 XML ドキュメントには、各 API メソッドで同じセクションと、各 API メソッドに固有のセクションが含まれます。
すべてのデータ取得には検索が使用されます。呼び出し元は多数の要素と一致する条件を指定し、サーバーはその条件に一致するメタデータのエンティティまたはデータのリストを返します。データの作成と更新では、データの一括アップロードを使用し、データの一括アップロードを POST ディメンションで送信します。
セキュリティ
ユーザーは呼び出しごとに認証される必要があります。これにより、不正者が Web サービス セッションをハイハイする可能性を排除できます。
HTTPS Web プロトコルを使用する必要があるため、すべての API リクエストは暗号化されます。ユーザーの認証情報は、Web サービス リクエスト本文の一部として Adaptive Planning に送信されます。これは、ユーザーがコンピュータを使って Web サービス リクエストを生成する前に、Web 層によってユーザーのログイン ID とパスワードを暗号化し、ターゲット サーバーでそれらを受信したときにのみ暗号化解除することを意味しています。
API リクエストでユーザーを認証しても、そのユーザーに対して永続的なセッションは作成されません。 Web サービスの呼び出しごとに、ユーザーを個別に認証する必要があります。
権限およびデータ アクセスの制御
ユーザーが Web サービスにアクセスするために特別な権限は必要ありません。ただし、Web サービス リクエストを行うユーザーには、リクエストされたアクションを実行するために必要な権限が付与されている必要があります。例: ユーザーが importStandardData Web サービス メソッドを呼び出すには、"インポート機能"
権限が必要です。
また、Web サービスのメソッドによって、各呼び出しの出力が、リクエストを行ったユーザーに表示されるデータ セットに制限されます。例: exportData Web サービス メソッドは、返されるデータを、呼び出し元のユーザーが承認する組織上のデータに制限します。