ファインアセット
概要
ファインアセットWebAPIの仕様について説明します。
APIのURIやパラメータ等についてはファインアセットWebAPIリファレンスをご確認ください。
APIエンドポイント
https://api.fineasset.jp/
認証
ファインアセットWebAPIを利用するには、アクセストークンによる認証が必要です。
各WebAPIでは、リクエストヘッダーに設定されたアクセストークンを使用して認証を行います。
Authorization: Bearer ACCESS_TOKEN
アクセストークン

アクセストークンを取得するには、事前にWeb画面からAPI連携キーを発行する必要があります。
※API連携キーの発行については「ファインアセットWebAPIの利用方法について」をご確認ください

API連携キーを発行後、「アクセストークン発行API」を実行することでアクセストークンを取得できます。
※詳細はAPIリファレンスをご確認ください。

アクセストークンの有効期限は「28800秒（8時間）」です。
有効期限が切れた場合は「アクセストークン発行API」を実行することで再取得することが出来ます。
※有効期限内であっても再取得可能です

データフォーマット
レスポンス（データの受信）はJSON形式となります。
※リクエスト（データの送信）については各APIのリファレンスを参照ください
Content-Type: application/json
リクエスト制限
リクエスト回数
アクセストークン毎にリクエスト制限があります。
発行したアクセストークン毎に1時間に1000回まで、1秒間に5回までリクエストできます。
リクエストサイズ
リクエストサイズに制限があります。
HTTPヘッダーの「Content-Length」の値を基に判定し、1回のリクエストにつき15MBまで送信できます。
Content-Lengthが設定されていない場合はエラーレスポンスを返却します。
エラーレスポンス
APIリクエストでエラーが発生した場合、以下のエラーレスポンスを返します。
{
  status: 400
  error:"bad_request"
  message: "パラメータが不正です"
}

バリデーションエラーが発生した場合、以下のエラーレスポンスを返します。
{
  status: 422
  error:"unprocessable_entity"
  message: "バリデーションエラー"
  validation: [{
    asset_item_code: "item_001",
    message: "値を入力してください"
  }]
}
status type 原因
400 bad_request リクエストパラメータの内容が不正
401 unauthorized API連携キーまたはアクセストークンが無効
403 forbidden リソースへのアクセス権限なし
413 payload_too_large リクエスト制限の上限サイズを超えた
422 unprocessable_entity APIの処理中にエラー発生（messageにエラー原因を返します）
429 too_many_requests リクエスト制限の上限回数を超えた
500 service_unavailable システム内部で予期せぬエラーが発生した
※HTTPステータスコードが404及び503の場合、エラーレスポンス(JSON形式)は返却しません
© 2021 Chuo System Corporation