ver.2サポートサイト

HOMEAPIその他仕様【ver.2.17】APIに関する仕様変更

【ver.2.17】APIに関する仕様変更

本ページは、2021年6月30日予定のver.2.17アップデートにおけるAPI仕様変更に関する内容です。

API ver.1.1の説明、API ver.1.0との違い、およびAPI ver.1.0の仕様変更について記載します。

APIをver.1.1にアップグレードする背景

従来のAPI ver.1.0は、「アプリ単位の権限」という概念が登場する前の仕様をベースに設計していましたが、現在では、アプリ単位に権限を設定できるようになったため、
一部、現行のサービス仕様との整合性が取れていないAPIがあり、使いにくい部分があることを認識しております。
その課題を解決するため、API ver.1.1を提供開始いたします。

 

・APIを利用しやすくするため、APIを設計し直しました。
・今後のアプリ数・DB数・レコード数等の増加に伴い、処理能力に影響する可能性のあるパラメータやデフォルトの挙動について見直しました。
これにより、サービス仕様に沿ったAPIに変更することで、APIの使い勝手の統一や利用しやすさなどが改善されるようになります。
なお、新機能追加に伴うAPIの利用は、API ver.1.1をご利用ください。
また、API ver.1.1提供開始後も、従来のAPI ver.1.0は引き続きご利用いただけます。
※アカウントごとに使用できるAPIバージョンが設定されているため、アカウントの利用APIバージョンをご確認の上、各APIをご利用してください。
詳細は、利用APIバージョンをご参照ください。

API ver.1.0とver.1.1の違い

API ver.1.0とver.1.1の主な違いの概要をまとめております。

1.エンドポイント

ver.1.0

操作対象ごとにエンドポイントが設定されています。

ver.1.1

アプリを除き、APIは全て

/apps/{app}

から始まります。

説明 メソッド
ver.1.0でのエンドポイント
 ver.1.1でのエンドポイント
DB一覧取得・作成 GET, POST /dbs /apps/{app}/dbs
DB取得・変更・削除 GET, PATCH, DELETE /dbs/{db} /apps/{app}/dbs/{db}
レコード一覧取得・作成 GET, POST /dbs/{db}/records /apps/{app}/dbs/{db}/records
レコード取得・変更・削除 GET, PATCH, DELETE
/dbs/{db}/records/{recordId}
 /apps/{app}/dbs/{db}/records/{recordId}
レコード検証 POST /dbs/{db}/records/verify /apps/{app}/dbs/{db}/records/verify
複数レコード登録・更新・削除 POST, PATCH, DELETE /dbs/{db}/records/bulk /apps/{app}/dbs/{db}/records/bulk
レコード一括出力依頼一覧取得・作成 GET, POST
/dbs/{db}/records/exports
 /apps/{app}/dbs/{db}/records/exports
レコード一括出力依頼取得 GET
/dbs/{db}/records/exports/{recordExportId}
 /apps/{app}/dbs/{db}/records/exports/{recordExportId}
レコード一括出力依頼キャンセル POST
/dbs/{db}/records/exports/{recordExportId}/cancel
 /apps/{app}/dbs/{db}/records/exports/{recordExportId}/cancel
レコード一括登録依頼一覧取得・作成 GET, POST
/dbs/{db}/records/batchInserts
 /apps/{app}/dbs/{db}/records/batchInserts
レコード一括登録依頼取得 GET
/dbs/{db}/records/batchInserts/{batchInsertId}
 /apps/{app}/dbs/{db}/records/batchInserts/{batchInsertId}
レコード一括登録依頼キャンセル POST
/dbs/{db}/records/batchInserts/{batchInsertId}/cancel
 /apps/{app}/dbs/{db}/records/batchInserts/{batchInsertId}/cancel
レコード一括更新依頼一覧取得・作成 GET, POST
/dbs/{db}/records/batchUpdates
 /apps/{app}/dbs/{db}/records/batchUpdates
レコード一括更新依頼取得 GET
/dbs/{db}/records/batchUpdates/{batchUpdateId}
 /apps/{app}/dbs/{db}/records/batchUpdates/{batchUpdateId}
レコード一括更新依頼キャンセル POST
/dbs/{db}/records/batchUpdates/{batchUpdateId}/cancel
 /apps/{app}/dbs/{db}/records/batchUpdates/{batchUpdateId}/cancel
レコード一括削除依頼一覧取得・作成 GET, POST
/dbs/{db}/records/batchDeletes
 /apps/{app}/dbs/{db}/records/batchDeletes
レコード一括削除依頼取得 GET
/dbs/{db}/records/batchDeletes/{batchDeleteId}
 /apps/{app}/dbs/{db}/records/batchDeletes/{batchDeleteId}
レコード一括削除依頼キャンセル POST
/dbs/{db}/records/batchDeletes/{batchDeleteId}/cancel
 /apps/{app}/dbs/{db}/records/batchDeletes/{batchDeleteId}/cancel

2.API ver.1.1で変更するパラメータやデフォルトの挙動

説明
メソッド
ver.1.1でのエンドポイント
ver.1.0からの
パラメータや挙動変更
アプリ一覧取得 GET /apps

以下をクエリパラメータから削除 enableUsage
以下をレスポンスから削除

recordUsage

fileUsage

totalDb
アプリ取得 GET /apps/{app}

以下をレスポンスから削除

recordUsage

fileUsage

totalDb
DB一覧取得 GET /apps/{app}/dbs

以下をクエリパラメータから削除

ids

apps
enableUsage

以下のパラメータをレスポンスから削除
app
recordSize
totalRecord
recordUsage
fileUsage
percentage
DB作成 POST /apps/{app}/dbs

以下をリクエストボディから削除

app
以下をレスポンスから削除

app
DB取得 GET /apps/{app}/dbs/{db} 以下のパラメータをレスポンスから削除
app
recordSize
totalRecord
recordUsage
fileUsage
percentage
DB変更 PATCH /apps/{app}/dbs/{db}

以下をレスポンスから削除

app
レコード一覧取得 GET /apps/{app}/dbs/{db}/records
クエリパラメータ「enableTotalCount」未指定時のデフォルト値を変更
true → false

API ver.1.0の仕様変更

説明
メソッド
ver.1.0での
エンドポイント
パラメータや挙動変更
アプリ一覧取得 GET /apps

以下のクエリパラメータを非推奨に変更

enableUsage
DB一覧を取得 GET /dbs

以下のクエリパラメータを非推奨に変更

enableUsage

APIリファレンスのご案内

APIの詳細は、APIリファレンスをご参照ください。

API ver.1.1リファレンス
API ver.1.0リファレンス