Skip to main content

マネーフォワード クラウドのAPI共通仕様

ここではマネーフォワード クラウドのAPI（以下、本API）の共通仕様について説明します。特別な説明がない限り、この仕様に準拠するものとします。

APIの利用方法​

本APIを使用するには、OAuth 2.0に従って必要なスコープが付与されたアクセストークンが必要です。 アクセストークンを取得するには「マネーフォワード クラウドのAPIを利用するには」を参照してください。

リクエスト/レスポンス形式​

本APIは、REST形式で設計されており、HTTPメソッドを使用してリソースを取得・更新します。 リクエストとレスポンスには特別な説明がない限り、JSON形式を使用します。

ページネーション​

一覧を返すAPIでは、要素数が多くなる場合ページネーションを行います。 ページネーションには、カーソル形式とページ形式があります。どちらを使用するかはサービスによって異なります。サービスのAPIリファレンスを確認してください。

カーソル形式​

リクエスト​

リクエストパラメータでcursorとlimitを指定します。

  • cursor: 次を取得する場合そのcursor値を指定します。何も指定しない場合リストの最初から返されます。
  • limit: 一度のリクエストで取得する件数。デフォルト値、最大値などはAPIリファレンスを確認してください。

レスポンス​

配列を表すリスト（例: items）と共にpaginationが返されます。 次ページがある場合、次ページのカーソルがpagination.next_cursorに入ります。 次ページがない場合、next_cursor は null になります。

レスポンス例:

{
  items: [...],
  pagenation: {
    next_cursor: 'urcM6vV91s2E'
  }
}

ページ方式​

リクエスト​

リクエストパラメータでpageとlimitを指定します。

  • page: 次を取得する場合、次のpageを指定します。何も指定しない場合、最初から返されます。
  • limit: 一度のリクエストで取得する件数。デフォルト値、最大値などはAPIリファレンスを確認してください。

レスポンス​

配列を表すリスト（例: items）と共に、paginationが返されます。 次ページがある場合、次のページ番号がpagination.next_pageに入ります。 次ページがない場合、next_page は null になります。

レスポンス例:

{
  items: [...],
  pagenation: {
    next_page: 3
  }
}

エラーフォーマット​

エラーが起きた時、HTTPステータスコードと共に以下の形式でエラーが返されます。 実際のエラーコードは各エンドポイントのAPIリファレンスを確認してください。

{
  "errors": [
    {
      "code": "BAD_REQUEST",
      "message": "The request is invalid."
    }
  ]
}

レート制限​

同一ユーザーから一定頻度以上のアクセスを検知した場合、次のようにHTTP 429エラーが返されます。

HTTP Status Codecodemessage説明
429RATE_LIMIT_EXCEEDEDRate limit exceeded.レート制限を超えたため、リクエストはキャンセルされました。

許容されるアクセス数はエンドポイントや状況により変化します。 レート制限を超えた場合は、しばらく待ってから再度アクセスしてください。

利用規約​

本APIの利用にあたっては、「マネーフォワード クラウド」API利用規約に準拠するものとします。