CA SDM REST API

この記事には、以下のトピックが含まれています。
casm173
この記事には、以下のトピックが含まれています。
REST (Representational State Transfer)は、World Wide Web などの分散ハイパーメディア システム用のソフトウェア アーキテクチャです。 CA SDM REST API を使用すると、アプリケーション、統合、および Web の開発者は、タブレット コンピュータやスマートフォンなどのデバイス用の UI およびアプリケーションを構築できます。 アナリスト、従業員、顧客などのユーザは、これらのデバイス上で UI またはアプリケーションを使用できます。 たとえば、アプリケーション開発者は、アナリストがデバイスを使用してチケットを更新するための CA SDM UI を開発できます。
REST API は、インターネット上の名前またはリソースを識別する文字列である URI (Uniform Resource Identifier)を使用して、リソースにアクセスします。 CA SDM では、リソースはチケット、アセット、連絡先などのオブジェクトです。 REST API を使用するアプリケーションは、URI に対して HTTP リクエストを行い、応答を解析します。 このような識別方法を使用することで、ネットワーク上のリソースの表現と対話できるようになります。 クライアントからサーバへの各リクエストは、そのリクエストを理解するために必要なすべての情報を持っており、サーバに格納されているコンテキストを使用しません。
開発者は、REST API を直接使用して、操作したいリソースに関する HTTP リクエストをサーバに送信します。 開発者に必要なものは、HTTP クライアント ライブラリのみです。このライブラリは、ほとんどのプログラミング言語で利用可能です。 REST API はオープン スタンダードに基づいているため、任意の Java プログラミング言語を使用してこの API にアクセスできます。
REST HTTP メソッドの詳細については、「REST HTTP メソッド」を参照してください。
REST と SOAP
CA SDM は、REST および SOAP の Web サービス API を提供します。 REST API は UI クライアントを対象としており、SOAP API はプログラムを対象としています。 REST サービスは、リソースに関係するサービスです(オブジェクトの操作、オブジェクト状態の変更、動詞ではなく名詞の使用)。 SOAP サービスは、サービスを対象としています(メソッドのコール、動詞の使用、アクションの実行)。
REST には、SOAP と比べて以下の利点があります。
  • REST は軽量、HTTP ベース、ステートレスである(スケーラビリティが高い)。
  • REST はクライアント ブックマークおよびキャッシュをサポートしている。
  • REST はデータ コントラクトが緩い。
  • REST は、WEB 2.0 や AJAX などのフロントエンド技術による利用が簡単。
  • REST は、XML および JSON データ形式をサポートしている。
  • REST はパフォーマンスの向上をもたらす。
REST セキュリティ
セキュリティでは、共有秘密鍵を使用するカスタム アプローチを含む、複数の認証メカニズムが使用されます。
CA SDM は、以下のセキュリティ認証スキームをサポートしています。
  • REST Web サービス秘密鍵認証(ログインに SSL および HMAC を使用)
  • REST ベーシック認証(クリアテキストのユーザ名/パスワード)
  • REST BOPSID 認証(CA SDM の BOPSID を検証)
  • 外部(CA EEM)アーチファクト認証(CA EEM アーチファクト トークン)
CA SDM 秘密鍵認証
CA SDM 秘密鍵認証は、以下を検証するプロセスです。
  • リクエスト送信者のアイデンティティ。
  • 送信者が登録済みのユーザかどうか。
秘密鍵認証では、各リクエストにリクエスト送信者のアイデンティティに関する情報が含まれている必要があります。 また、リクエストには CA SDM がユーザの真正性を検証するために使用できる追加情報も必要です。 リクエストがこの検証テストに合格すると、そのリクエストは真性であることが確認されます。 アクセス キー リクエストの認証中に、CA SDM 秘密鍵認証は以下を行います。
  1. クライアントにアクセス キーを割り当てます。 アクセス キーは、リクエストを行うクライアントを識別し、キー値として CA SDM セッション ID を使用します。 アクセス キーはリクエスト パラメータとして送信されるため、秘密ではありません。 CA SDM にリクエストを送信するすべての人がリクエスト パラメータを使用できるため、秘密鍵が必要になります。
  2. 秘密鍵を割り当てます。 秘密鍵は、ログイン中に CA SDM によって動的に生成される 40 文字の英数字です。 この秘密鍵は、データベースに格納される前に暗号化されます。
  3. クライアントが提供する情報(秘密鍵を使用したリクエスト シグネチャ)を使用して、クライアントを識別し、リクエストが正当であることを確認します。 この追加情報により、ユーザの偽装が防止され、CA SDM とリクエストの送信者のみが知る共有秘密を保有していることが示されます。