1. API

本API ではJSON 形式のOData を、データアクセス用にデフォルトのREST プロトコルとして使います。OData（Atom）、SOAP、HTML、およびCSV を含む他のWeb サービスフォーマットもサポートされています。

リソース

リソースは、一般的にアイテムの集合であるエンドポイントです。リソースには次のHTTP メソッドを使ってアクセスすることができます。:

Actions

アクションは、リソースに対するオペレーションセットを拡張する場合やサーバーで関連のないアクションを実行する場合に使用します。

一般的なサーバーレスポンス

200 OK	リクエストはエラーなしでサーバーにより処理されました。
201 Created	リクエストは成功し、指定されたリソースがサーバーによって作成されました。
204 No Content	リクエストされたリソースがnull 値もしくは、サービスにreturn=minimal preference が適用される場合、リクエストはこのステータスを返します。
400 Bad Request	リクエストは受付できないか、必要なパラメータを満たしていません。
401 Unauthorized	このユーザーは認証されていないか、このリソースへのアクセスが承認されていません。
403 Forbidden	このリソースへのアクセスが拒否されました。
404 Not Found	このレスポンスはリソースが存在しないことを示します。
405 Method Not Allowed	指定されたHTTP メソッドはこのリソースでは許可されていません。
501 Not Implemented	サーバーは、リクエストを充足する機能をサポートしていません。

認証

認証トークンは、ユーザーがAPI に認証をするためのユニークな識別子です。認証トークンを使用するには、管理者としてログインして、［ユーザー管理］をクリックしてください。このセクションでは、ユーザーの権限および認証トークンの管理が可能です。API のアクセスを特定のIP アドレスに限定することもできます。

API を呼び出すために、認証トークンをさまざまな方法で指定できます。

追加フォーマット

すべてのAPI リソースおよびアクションがサポートするデフォルトのJSON OData フォーマットに加えて、すべてのAPI において次のWeb サービスフォーマットがサポートされています。［インプット］カラムは、特定のフォーマットをリクエストするときに必要な追加のインプットを説明します。

フォーマット	インプット	説明
OData (Atom)	$format=Atom	OData の代替XML アイテムエンコード。
JSONP	$callback=MyCallback	ブラウザスクリプトでの利用のためにアウトプットはJSONP フォーマットに変換されます。
HTML	@HTML	アウトプットはベーシックHTML テーブルとしてフォーマットされます。
CSV	@CSV	スプレッドシートへのローディングではアウトプットはカンマ区切りの値に変換されます。
TSV	@TSV	スプレッドシートへのローディングではアウトプットはタブ区切りの値に変換されます。