2.2　API共通の仕様

各APIに共通する仕様を次に示します。なお，JP1/AOが提供しているAPIは，REST（Representational State Transfer）アーキテクチャスタイルに従います。

ここではJP1/AOに特有の仕様を記載しています。特に断り書きのない場合はHTTP1.1に準拠します。

なお，この節での「API」は，「JP1/AOが提供するAPI」を指します。また，APIを使用するポータルなどのユーザープログラムを総称して「APIクライアント」と表記します。

〈この節の構成〉

• 2.2.1　通信方式

• 2.2.2　セキュリティと認証

• 2.2.3　入出力形式

• 2.2.4　ネームスペース

• 2.2.5　リクエスト形式

• 2.2.6　レスポンス形式

• 2.2.7　サポートするメソッド

• 2.2.8　APIで管理できるドメイン名とリソース

• 2.2.9　クエリパラメータ

• 2.2.10　リクエストヘッダー

• 2.2.11　HQL規格の使用

• 2.2.12　ドメインオブジェクトの形式

• 2.2.13　レスポンスヘッダー

• 2.2.14　リソースのメンバー

• 2.2.15　JP1/AOを操作するAPIで返却されるメンバー

• 2.2.16　実行できる操作を取得するAPIで返却されるメンバー

• 2.2.17　ステータスコード

• 2.2.18　エラー情報

ページの先頭へ