Misoca API v3

Misoca の外部API v3を定義します。

Service URL (リクエスト先URL)

各種APIの詳細

Swagger API spec(JSON形式)は https://app.misoca.jp/api/v3/swagger_docにて公開しています。

共通仕様

ページング仕様

ページングはRFC5988に準拠し、必要な情報は、Linkヘッダ経由で提供されます。

例えば、 GET /api/v3/estimates で請求書一覧を取得した場合、以下のようなLinkヘッダが含まれます。

Link: <https://app.misoca.jp/v3/estimates?page=31>; rel="last", <https://app.misoca.jp/api/v3/estimates?page=2>; rel="next"

ここでは rel="next" は次のページが page=2 であることを示しています。 rel="last" は、最後のページが page=31 であることを示しています。

ページ移動

page パラメータを渡すことでページを辿ることができます。 指定しない場合、 page=1 が指定されている場合と、同様の動作をします。

GET /api/v3/estimates?page=8

アップデート・更新履歴

2017年6月21日

2016年12月1日