既定のAPIバージョン1.1への変更および旧バージョンとの互換性について

概要¶

バージョン1.3.13.0において、既定のAPIバージョンが1.0から1.1に変更となり、APIのリクエスト及びレスポンスのデータレイアウトが変更になります。また、バージョン1.3.12.0以前のバージョンに存在した不具合（APIキーを指定しないリクエストでApiVersionが正しくセットされない問題）が解消されることによって同様の変更が発生いたします。旧バージョンで開発したAPI呼び出しの互換性を維持するため、パラメータの調整が必要となります。

APIバージョン1.0から1.1の変更点¶

APIリクエストとAPIレスポンスのデータレイアウトが、以下のように変更となります。

APIバージョン1.0¶

以下の項目のデータレイアウトがフラットに表現されていました。

• 分類項目
• 数値項目
• 日付項目
• 説明項目
• チェック項目
• 添付ファイル項目

上記項目のレスポンスが、例えば分類項目の場合、ClassA～Class100までとなっていました。Class101以降のレスポンスを取得したい場合は、APIバージョン1.1を利用してください。

1
2
3
4
5
6
7
8
9

{
    "ApiVersion": 1.0,
    "Title": "API 1.0",
    "ClassA": "ClassA",
    "NumA": 123,
    "DateA": "2022/7/2",
    "DescriptionA": "DescriptionA",
    "CheckA": true
}

APIバージョン1.1¶

以下の項目のデータレイアウトが、キー・バリュー形式に変更となります。

• 分類項目
• 数値項目
• 日付項目
• 説明項目
• チェック項目
• 添付ファイル項目

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19

{
    "ApiVersion": 1.1,
    "Title": "API 1.1",
    "ClassHash": {
        "ClassA": "ClassA"
    },
    "NumHash": {
        "NumA": 123
    },
    "DateHash": {
        "DateA": "2022/7/2"
    },
    "DescriptionHash": {
        "DescriptionA": "DescriptionA"
    },
    "CheckHash": {
        "CheckA": true
    }
}

APIバージョンの指定方法¶

APIバージョンの既定値はApi.jsonのVersionパラメータで設定できます。また、APIのリクエストパラメータで明示的に指定できます。

Api.jsonのVersionパラメータで指定する¶

APIバージョンを指定しないAPI呼び出しで使用されるバージョンです。既定値は1.1です。旧バージョンの仕様に変更する場合には、1.0に変更してください。

リクエストパラメータで指定する¶

API実行時のリクエストパラメータApiVersionでAPIバージョンを指定できます。リクエストパラメータを未指定の場合は、API.jsonのVersionパラメータの値が使用されます。旧バージョンの仕様に変更する場合は、1.0を指定してください。

レコード取得APIのリクエスト¶

1
2
3
4

{
     "ApiVersion": 1.0,
     "ApiKey": "63Kfk0ds3d4S2DBsa32..."
}

$p.apiGetのリクエスト¶

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

$p.apiGet({
    id: <サイトID>,
    data: {
        "ApiVersion": 1.0,
        <その他の取得条件>
    },
    done: <任意の処理>,
    fail: <任意の処理>,
    always: <任意の処理>
});

Api.jsonのCompatibility_1_3_12パラメータ¶

Compatibility_1_3_12は、バージョン1.3.12.0以前に存在した不具合¹に該当するAPI呼び出しが存在する場合に、互換性を維持するためのパラメータです。既定値はfalseです。

• 該当のAPI呼び出しを使用している場合は、Compatibility_1_3_12パラメータをtrueに変更しApi.jsonのVersionパラメータを1.0に変更してください。
• .NET Framework版ではこの不具合は発生していません。.NET Framework版からの移行では、Compatibility_1_3_12パラメータをfalseに設定してください。

該当するAPI呼び出し¶

バージョン1.3.12.0以前では、ApiVersionを指定しているが、ApiKeyを指定していないケースにおいて、"ApiVersion": 1.1の指定が無視され1.0で動作する不具合が存在しました。

バージョン1.3.13.0以降ではこの不具合が解消されるため、APIバージョン1.1の挙動に変更となります。

{
    "ApiVersion": 1.1
    "Title": "1.0"
}

"Compatibility_1_3_12": falseの挙動¶

不具合が解消され、指定したAPIバージョンで動作します。

"Compatibility_1_3_12": trueの挙動¶

1.3.12.0 以前のバージョンと同様に ApiVersion の指定が無視されます。

関連情報¶

• テーブルの管理：項目：分類
• テーブルの管理：項目：数値
• テーブルの管理：項目：日付
• テーブルの管理：項目：説明
• テーブルの管理：項目：チェック
• テーブルの管理：項目：添付ファイル
• パラメータ設定：Api.json
• 開発者向け機能：API：テーブル操作：複数レコード取得
• $p.apiGet