ベストプラクティス

JSON と XML のサポート

JSON は REST API リクエストボディとレスポンスボディのデフォルトですが、XML もサポートされています。HTTP ACCEPT ヘッダーを使用して、JSON または XML のいずれかを指定できます。XML 逐次化は SOAP API と類似しています。XML 要求は UTF-8 および UTF-16 でサポートされ、XML 応答は UTF-8 で提供されます。

日付と時刻の形式

要求と応答内の日時情報は ISO8601 形式を使用して指定します。

圧縮

REST API は、HTTP 1.1 仕様で定義された標準を使用した要求と応答の圧縮をサポートしています。圧縮は、いくつかのクライアントでは自動的にサポートされており、他のクライアントにも手動で追加できます。パフォーマンス向上のため、HTTP 1.1 圧縮をサポートできるクライアントを使用することをお勧めします。

応答は、クライアントが要求に Accept-Encoding: gzip または Accept-Encoding: deflate HTTP ヘッダーを使用していれば圧縮されます。REST API は応答を圧縮し、応答のヘッダーに Accept-Encoding: gzip または Accept-Encoding: deflate を含めます。

要求に Content-Encoding: gzip または Content-Encoding: deflate ヘッダーを指定した場合、圧縮した要求データを送信できます。REST API は、サポートされている圧縮アルゴリズムを含む Content-Encoding 要求ヘッダーが指定されていれば、受信した要求の内容を圧縮解除します。