データSDK

DIMO データSDKは、API経由で車両データにアクセスするために使用されます。TypeScript、Python、C#でご利用いただけます。

当社のSDKはすべてオープンソースです。詳細はこちらをご覧ください。

• TypeScript/NodeJS Data SDK: Github | npm

• Python Data SDK: Github | PyPI

• C# Data SDK: Github | NuGET

前提条件

• DIMO開発者コンソールにサインインまたはサインアップしてください。

• API キーを生成して保存し、選択したリダイレクト URI を少なくとも 1 つ追加します。

開発者ライセンスを使用する前に必要な要件

データSDKの使用

1

SDKをインストールする

TypeScript/NodeJS

npm install @dimo-network/data-sdk

# Or install with yarn
yarn add @dimo-network/data-sdk

npm: @dimo-network/data-sdknpm

npm 上の TypeScript データ SDK

Python

pip install dimo-python-sdk

dimo-python-sdkPyPI

The Python Data SDK on PyPI

C#

# Windows users:
Install-Package Dimo.Client

# Mac/ Linux users:
dotnet add package Dimo.Client

Dimo.Client 1.0.5nuget

The .NET Data SDK on NuGET

2

SDKのインポートと初期化

TypeScript/NodeJS

SDK をインポートします。

# ES Modules: 
import { DIMO } from '@dimo-network/data-sdk';

# Or Common JS
const { DIMO } = require('@dimo-network/data-sdk/dist/index.cjs';

ご希望の環境に応じてSDKを起動してください。現在は とProductionの両方のDev環境をサポートしていますが、Production現時点では を使用することをお勧めします。

const dimo = new DIMO('Production');

# or

const dimo = new DIMO('Dev');

Python

Import the SDK:

from dimo import DIMO 

Initiate the SDK depending on the environment of your interest. We currently support both Production and Dev environments, but recommend using Production at this time.

dimo = DIMO("Production")

# Or:

dimo = DIMO("Dev")

C#

Without Dependency Injection:

using Dimo.Client;

var dimoClient = new DimoClientBuilder().AddAllServices().Build();

With Dependency Injection:

using Dimo.Client;

services.AddDimoClient(options =>
{
    options.Environment = DimoEnvironment.Production;
});

3

認証関数呼び出しを実行する

開発者コンソールアプリケーション（ステップ1）の認証情報を使用して、開発者JWTと、特権車両アクセスを共有している車両トークンIDの車両JWTを取得します。これらについては、認証に関するページをご覧ください。

値は、コンソールで追加したdomain構成済みの のいずれかになります。redirectUri

値はあなたが生成したprivate_keyものですAPI Key。

開発者JWTを取得する

TypeScript/NodeJS

const developerJwt = await dimo.auth.getToken({
  client_id: '<client_id>',
  domain: '<redirect_uri>',
  private_key: '<api_key>',
});

// The TS/JS data SDK references the "access_token" and formats it 
// in the format you need in later steps

Python

auth_header = dimo.auth.get_token(
    client_id = '<client_id>',
    domain = '<redirect_uri>',
    private_key = '<api_key>'
)

# Store the Developer JWT from the auth_header dictionary
dev_jwt = auth_header["access_token"]

C#

var auth = await dimoClient.AuthenticationService.GetTokenAsync(
    clientId: "<your client id>",
    domain: "<your domain>",
    privateKey: "<your private key>",
    address: "<your address>" // This value is the same as clientId
);

Console.WriteLine(auth.AccessToken);

車両のJWTを取得する

TypeScript/NodeJS

const vehicleJwt = await dimo.tokenexchange.getVehicleJwt({
  ...developerJwt,
  tokenId: <vehicle_token_id>
});

Python

# Call to get a Vehicle JWT
get_vehicle_jwt = dimo.token_exchange.exchange(
    developer_jwt = dev_jwt, 
    token_id=<token_id> 
)

# Store the Vehicle JWT from the get_vehicle_jwt response
vehicle_jwt = get_vehicle_jwt['token']

C#

var vehicleTokenId = 123456; // The token id of the vehicle
var vehicleJwt = await dimoClient.TokenExchangeService.GetPrivilegeTokenAsync(
    accessToken: auth.AccessToken,
    tokenId: vehicleTokenId,
    privileges: [ 
        PrivilegeSharing.AllTimeNoLocationData,
        PrivilegeSharing.Commands, 
        PrivilegeSharing.CurrentLocation, 
        PrivilegeSharing.AllTimeLocation 
    ]); // The privileges you want to get for the vehicle

車両JWTの詳細については、トークン交換を参照してください↗

4

最初のAPI呼び出しを実行する

車両JWTで認証が完了したら、最初のAPI呼び出しを実行する準備が整います。ターミナルに以下のログを記録してみてください。

TypeScript/NodeJS

const latestSignals = await dimo.telemetry.query({
  ...vehicleJwt,
  query: `
    query GetSignalsLatest {
      signalsLatest(tokenId: <insert_token_id>) {
        powertrainTransmissionTravelledDistance {
          timestamp
          value
        }
        powertrainType {
          timestamp
          value
        }
        lastSeen
      }
    }
  `
});

console.log(latestSignals)

Python

  latest_signals = dimo.telemetry.query(
  vehicle_jwt= vehicle_jwt,
  query= """
    query GetSignalsLatest {
      signalsLatest(tokenId: <insert_token_id>) {
        powertrainTransmissionTravelledDistance {
          timestamp
          value
        }
        powertrainType {
          timestamp
          value
        }
        lastSeen
      }
    }
  """
);

print(latest_signals)

C#

var query = @"
  query GetSignalsLatest {
      signalsLatest(tokenId: <insert_token_id>) {
        powertrainTransmissionTravelledDistance {
          timestamp
          value
        }
        powertrainType {
          timestamp
          value
        }
        lastSeen
      }
    }
";

// Variables are optional
var variables = new
{
    VariableName = "VariableValue"
};

var result = await dimoClient.TelemetryService.ExecuteQueryAsync<TResponse>(query, variables, vehicleJwt.Token);

Console.WriteLine(result);

5

成功しました！🎉

これで、SDK を使用してアプリをカスタマイズする準備が整いました。