Device Definitions (デバイス定義) API

開発者ノート

2024年現在、デバイス定義の信頼できる情報源は、分散型クラウドデータベースであるTablelandに保存されています。デバイス定義の詳細は、Identity APIから取得できるようになりました（一般的なクエリを参照）。このAPIには、開発ニーズに対応するヘルパー関数が追加されました。

ベース URL

Production

https://device-definitions-api.dimo.zone

---

VINデコード

VINデコードリクエストを送信する

POST {baseUrl}/device-definitions/decode-vin

車両識別番号のデコード要求を送信し、VIN に対応するデバイス定義 ID を返します。

application/json生のボディパラメータに使用します。

リクエスト本文

名前	タイプ	説明
countryCode*	String	3 文字のISO 3166-1 alpha-3国コード。 例： "countryCode": "JPN"
vin*	String	車両識別番号。 例： "vin": "1HGCM66886A015965"

ヘッダー

名前	タイプ	説明
Authorization*	String	認証ステップからの開発者 JWT 。

200: Success

{ deviceDefinitionId: 'lexus_nx_2021', newTransactionHash: '' }

404: Not Found

500: Internal Server Error

VINデコード: データSDK関数呼び出し

TypeScript

await dimo.devicedefinitions.decodeVin({
    developerJwt, 
    countryCode, 
    vin
});

Python

dimo.device_definitions.decode_vin(dev_jwt, country_code, vin)

C#

dimoClient.DeviceDefinitionsService.DecodeVinAsync(
    access_token,
    countryCode,
    vin
);

---

デバイス定義の検索

検索フィルターでデバイス定義を取得する

GET {baseUrl}/device-definitions/search

検索フィルターによってデバイス定義のリストを取得します。

クエリパラメータ

名前	タイプ	説明
query*	String	クエリフィルタ（例Lexus gx 2023）
makeSlug	String	車両のメーカー（例audi：lexus、など）
modelSlug	String	車両のモデル（例Tacoma：Accord、など）
year	Number	車両の年式（例2024）
page	Number	ページ番号（ページ番号、デフォルトは 1 ページ目）
pageSize	Number	ページサイズ（1ページに表示する項目を指定する）

200: Success

{
  "deviceDefinitions": [
    {
      "id": "lexus_gx_2023",
      "legacy_ksuid": "2ZvYP0pSbQoXPh2WUdQPeA6g4dM",
      "name": "2023 Lexus GX",
      "make": "Lexus",
      "model": "GX",
      "year": 2023,
      "imageUrl": ""
    },
    {
      "id": "lexus_gx-460_2023",
      "legacy_ksuid": "2CMmZpP6YjaKQlQnGDSAzQ4PJEG",
      "name": "2023 Lexus GX 460",
      "make": "Lexus",
      "model": "GX 460",
      "year": 2023,
      "imageUrl": ""
    }
  ],
  "facets": {
    "makes": [
      {
        "name": "Lexus",
        "count": 2
      }
    ],
    "models": [
      {
        "name": "GX",
        "count": 1
      },
      {
        "name": "GX 460",
        "count": 1
      }
    ],
    "years": [
      {
        "name": "2023",
        "count": 2
      }
    ]
  },
  "pagination": {
    "page": 1,
    "pageSize": 20,
    "totalItems": 2,
    "totalPages": 1
  }
}

500: Internal Server Error

検索によるデバイス定義: データ SDK 関数呼び出し

TypeScript

await dimo.DeviceDefinitions.search({
    query, 
    makeSlug, 
    modelSlug, 
    year, 
    page, 
    pageSize
});

Python

dimo.device_definitions.search(query, make_slug, model_slug, year, page, page_size)

C#

dimoClient.DeviceDefinitionsService.SearchAsync(
    query,
    makeSlug,
    modelSlug,
    year,
    page,
    pageSize
);