SmartDrive API (1.2.0)

Download OpenAPI specification:Download

このAPIにより、SmartDriveデータのサードパーティ統合が可能になります。

Devices

IoTデバイスを参照・操作するためのエンドポイント。

List Devices

処理概要

ディストリビューターに紐づけられたデバイスリストを取得します。エンドユーザーによりアクティベーションが行われると、エンドユーザーの所属している組織がセットされます。

Authorizations:

appToken

query Parameters

cursor	string リソース一覧を取得する際の取得開始位置を示すもので、一覧の途中からデータを抽出するために利用します。ページング可能なコレクションリソースにおいて、データ量が多く、一度のAPI呼び出しで全てのデータを取得できないケースでは、レスポンスにpaging.nextというプロパティが設定されます。次回のAPI呼び出し時にその値を設定することで、残りのデータを取得することができます。未指定の場合は最初から取得します。
limit	integer [ 1 .. 100 ] Default: 50 一度に取得するリソース数(最大100)
ids	string IDフィルタ。指定するとそのIDのリソースのみが取得できます。 IDをカンマ区切りで結合した文字列。一度に最大50件まで指定可能。例） MwZLrkoAlr,2kO7DroQzP,mQkoA9opAg,eykoxz7RlE,meD7qjLXrd
organization_id	string 組織IDフィルタ。指定した組織のリソースのみが取得できます。

Responses

200

400

Bad Request

401

Unauthorized

500

Internal Server Error

get/devices

https://smartdrive-api.com/v1.2/devices

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"meta": 
{"http_status_code": 200,
"result": true
},
"paging": 
{"next": "MTAxNTExOTQ1MjAwNzI5NDE="
},
"data": 
[
{"code": "07144A",
"organization": 
{"id": "ZrMa7d5WF6cpsV0ejp29",
"name": "SmartDrive"
}
}
]
}

Device last location

処理概要

デバイスの最終位置情報(lat, lng)とそのデータがアップロードされたタイムスタンプを取得します。過去30日間に指定されたデバイスから位置情報の受信があった場合に結果を返します。期間内の位置情報がない場合、結果を得ることができませんのでご注意ください。

Authorizations:

appToken

path Parameters

device_code

required

string

対象になるデバイス

Responses

200

get/devices/{device_code}/last_location

https://smartdrive-api.com/v1.2/devices/{device_code}/last_location

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"meta": 
{"http_status_code": 200,
"result": true
},
"data": 
{"ts": "2014-06-02T23:02:34Z",
"lat": 35.658581,
"lng": 139.745433,
"speed": 6,
"h_accuracy": 10,
"v_accuracy": 30
}
}

List device location logs

処理概要

クエリパラメーターで指定された時間範囲のデバイスの位置情報データ履歴を取得します。 ts_from, ts_toフィルタを利用する場合、期間が長いと応答が遅くなります。

Authorizations:

appToken

path Parameters

device_code

required

string

対象になるデバイス

query Parameters

ts_from required	string <date-time> タイムスタンプフィルタ。指定するとその時刻以降のリソースのみが取得できます。(指定値を含む) formatはrfc3339。例) 2014-01-01T00:00:00Z
ts_to required	string <date-time> タイムスタンプフィルタ。指定するとその時刻以前のリソースのみが取得できます。(指定値を含む) formatはrfc3339。 ts_from よりも未来の日時である必要があります。 ts_from に指定する値から最大24時間まで未来の日時を指定できます。例) 2014-02-01T00:00:00Z
cursor	string リソース一覧を取得する際の取得開始位置を示すもので、一覧の途中からデータを抽出するために利用します。ページング可能なコレクションリソースにおいて、データ量が多く、一度のAPI呼び出しで全てのデータを取得できないケースでは、レスポンスにpaging.nextというプロパティが設定されます。次回のAPI呼び出し時にその値を設定することで、残りのデータを取得することができます。未指定の場合は最初から取得します。
limit	integer <int32> [ 1 .. 3600 ] Default: 300 一度に取得するリソース数(最大3600)

Responses

200

get/devices/{device_code}/locations

https://smartdrive-api.com/v1.2/devices/{device_code}/locations

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"meta": 
{"http_status_code": 200,
"result": true
},
"paging": 
{"next": "MTAxNTExOTQ1MjAwNzI5NDE="
},
"data": 
[
{"ts": "2014-06-02T23:02:34Z",
"lat": 35.658581,
"lng": 139.745433,
"speed": 6,
"h_accuracy": 10,
"v_accuracy": 30
}
]
}

List device last locations

処理概要

デバイス群の最終位置情報(lat, lng)とそのデータがアップロードされたタイムスタンプを取得します。過去30日間に指定されたデバイスから位置情報の受信があった場合に結果を返します。期間内の位置情報がない場合、結果を得ることができませんのでご注意ください。

Authorizations:

appToken

query Parameters

device_codes

required

Array of strings

取得対象になるデバイスコードのリスト。カンマ区切り。例) 07144A,07144B 同時に100件まで指定可能。以下の場合、レスポンスにデバイスのデータは含まれません。

無効なデバイスコード
未利用なのど理由で、最終位置情報が未定義のデバイス

Responses

200

get/device_last_locations

https://smartdrive-api.com/v1.2/device_last_locations

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"meta": 
{"http_status_code": 200,
"result": true
},
"data": 
[
{"device_code": "07144A",
"last_location": 
{"ts": "2014-06-02T23:02:34Z",
"lat": 35.658581,
"lng": 139.745433,
"speed": 6,
"h_accuracy": 10,
"v_accuracy": 30
}
}
]
}

Trips

走行を参照・操作するためのエンドポイント。

List trips

処理概要

走行一覧を取得します。走行の終了時間昇順で取得されます。

Authorizations:

appToken

query Parameters

organization_id required	string 組織IDフィルタ。指定した組織のリソースのみが取得できます。
ts_from required	string <date-time> タイムスタンプフィルタ。指定するとその時刻以降のリソースのみが取得できます。(指定値を含む) formatはrfc3339。例) 2014-01-01T00:00:00Z
ts_to required	string <date-time> タイムスタンプフィルタ。指定するとその時刻以前のリソースのみが取得できます。(指定値を含む) formatはrfc3339。例) 2014-02-01T00:00:00Z
cursor	string リソース一覧を取得する際の取得開始位置を示すもので、一覧の途中からデータを抽出するために利用します。ページング可能なコレクションリソースにおいて、データ量が多く、一度のAPI呼び出しで全てのデータを取得できないケースでは、レスポンスにpaging.nextというプロパティが設定されます。次回のAPI呼び出し時にその値を設定することで、残りのデータを取得することができます。未指定の場合は最初から取得します。
limit	integer [ 1 .. 100 ] Default: 50 一度に取得するリソース数(最大100)

Responses

200

get/trips

https://smartdrive-api.com/v1.2/trips

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"meta": 
{"http_status_code": 200,
"result": true
},
"paging": 
{"next": "MTAxNTExOTQ1MjAwNzI5NDE="
},
"data": 
[
{"id": "5d08b840-6168-4229-b29b-5e593d357d9f",
"device": 
{"code": "07144A"
},
"started_at": "2016-10-06T03:52:27.345Z",
"ended_at": "2016-10-06T04:31:15.112Z",
"distance": 900
}
]
}

Fleet/Accounts

SmartDriveFleetのアカウントを参照・操作するためのエンドポイント。

List Accounts

処理概要

指定した組織のアカウント一覧を取得します。ソートは作成日時降順となります。

Authorizations:

appToken

query Parameters

organization_id required	string 組織IDフィルタ。その組織のリソースのみが取得できます。
ids	Array of strings [ 1 .. 50 ] items IDフィルタ。指定するとそのIDのリソースのみが取得できます。 IDをカンマ区切りで結合した文字列。一度に最大50件まで指定可能。例） MwZLrkoAlr,2kO7DroQzP,mQkoA9opAg,eykoxz7RlE,meD7qjLXrd
sort	string Default: "id" Enum: "id" "display_name" "created_at" "updated_at" ソートフィールド。idsを指定するときは無視されます。
direction	string Default: "desc" Enum: "asc" "desc" ソート順。
cursor	string リソース一覧を取得する際の取得開始位置を示すもので、一覧の途中からデータを抽出するために利用します。ページング可能なコレクションリソースにおいて、データ量が多く、一度のAPI呼び出しで全てのデータを取得できないケースでは、レスポンスにpaging.nextというプロパティが設定されます。次回のAPI呼び出し時にその値を設定することで、残りのデータを取得することができます。未指定の場合は最初から取得します。
limit	integer [ 1 .. 100 ] Default: 50 一度に取得するリソース数(最大100)

Responses

200

Successful operation

400

Invalid request parameters

401

Api key is not valid

403

You don't have permission to access the resource

404

Organization is not found

500

Internal server error

get/services/fleet/accounts

https://smartdrive-api.com/v1.2/services/fleet/accounts

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"meta": 
{"http_status_code": 200,
"result": true
},
"paging": 
{"next": "MTAxNTExOTQ1MjAwNzI5NDE="
},
"data": 
[
{"id": "zjd5ge0v",
"display_name": "JohnDoe",
"phone_number": "09012345678",
"created_at": "2020-07-06T04:03:27Z",
"updated_at": "2020-07-06T04:03:27Z"
}
]
}

Fleet/Vehicles

車両を参照・操作するためのエンドポイント。

Create a vehicle

処理概要

特定の組織に車両を追加します。

Authorizations:

appToken

Request Body schema: application/json

The vehicle to create.

organization required	object
name required	string [ 2 .. 20 ] characters 車両を識別するための文字列
odometer	integer <int64> Nullable オドメーターの走行距離(単位:メートル)

Responses

201

Created

400

Invalid request parameters

401

Api key is not valid

403

You don't have permission to access the resource

404

Organization is not found

500

Internal server error

post/services/fleet/vehicles

https://smartdrive-api.com/v1.2/services/fleet/vehicles

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"organization": 
{"id": "dfaoxz7RlE"
},
"name": "SuperCar",
"odometer": 45678
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"meta": 
{"http_status_code": 201,
"result": true
},
"data": 
{"id": "gB0NV05e",
"name": "SuperCar",
"odometer": 45678,
"created_at": "2020-03-16T03:13:24.706Z",
"updated_at": "2020-03-16T03:13:24.706Z"
}
}

List vehicles

処理概要

指定した組織の車両一覧を取得します。ソートは作成日時降順となります。

Authorizations:

appToken

query Parameters

organization_id required	string 組織IDフィルタ。その組織のリソースのみが取得できます。
ids	Array of strings [ 1 .. 50 ] items IDフィルタ。指定するとそのIDのリソースのみが取得できます。 IDをカンマ区切りで結合した文字列。一度に最大50件まで指定可能。例） MwZLrkoAlr,2kO7DroQzP,mQkoA9opAg,eykoxz7RlE,meD7qjLXrd
sort	string Default: "id" Enum: "id" "created_at" "updated_at" ソートフィールド。idsを指定するときは無視されます。
direction	string Default: "desc" Enum: "asc" "desc" ソート順。
cursor	string リソース一覧を取得する際の取得開始位置を示すもので、一覧の途中からデータを抽出するために利用します。ページング可能なコレクションリソースにおいて、データ量が多く、一度のAPI呼び出しで全てのデータを取得できないケースでは、レスポンスにpaging.nextというプロパティが設定されます。次回のAPI呼び出し時にその値を設定することで、残りのデータを取得することができます。未指定の場合は最初から取得します。
limit	integer [ 1 .. 100 ] Default: 50 一度に取得するリソース数(最大100)

Responses

200

400

Invalid request parameters

401

Api key is not valid

403

You don't have permission to access the resource

404

Organization is not found

500

Internal server error

get/services/fleet/vehicles

https://smartdrive-api.com/v1.2/services/fleet/vehicles

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"meta": 
{"http_status_code": 200,
"result": true
},
"paging": 
{"next": "MTAxNTExOTQ1MjAwNzI5NDE="
},
"data": 
[
{"id": "gB0NV05e",
"name": "SuperCar",
"odometer": 45678,
"created_at": "2020-07-06T04:03:27Z",
"updated_at": "2020-07-06T04:03:27Z"
}
]
}

Update vehicle properties

処理概要

車両のプロパティを更新します。

Authorizations:

appToken

path Parameters

vehicle_id

required

string

対象になる車両ID

Request Body schema: application/json

The vehicle to update.

name	string [ 2 .. 20 ] characters Nullable 車両を識別するための文字列
odometer	integer <int64> Nullable オドメーターの走行距離(単位:メートル)

Responses

200

400

Invalid request parameters

401

Api key is not valid

403

You don't have permission to access the resource

404

Location is not found

500

Internal server error

patch/services/fleet/vehicles/{vehicle_id}

https://smartdrive-api.com/v1.2/services/fleet/vehicles/{vehicle_id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"name": "SuperCar",
"odometer": 45678
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"meta": 
{"http_status_code": 200,
"result": true
},
"data": 
{"id": "gB0NV05e",
"name": "SuperCar",
"odometer": 45678,
"created_at": "2020-07-06T04:03:27Z",
"updated_at": "2020-07-06T04:03:27Z"
}
}

Delete a vehicle

処理概要

車両を削除します。

Authorizations:

appToken

path Parameters

vehicle_id

required

string

対象になる車両ID

Responses

200

400

Invalid request parameters

401

Api key is not valid

403

You don't have permission to access the resource

404

Vehicle is not found

500

Internal server error

delete/services/fleet/vehicles/{vehicle_id}

https://smartdrive-api.com/v1.2/services/fleet/vehicles/{vehicle_id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"meta": 
{"http_status_code": 200,
"result": true
}
}

Fleet/Locations

地点を参照・操作するためのエンドポイント。

Register location

処理概要

ロケーションを登録します。

Authorizations:

appToken

Request Body schema: application/json

登録するロケーションデータ。

name required	string [ 1 .. 256 ] characters ロケーションの名前
organization required	object
coordinates required	object
radius required	number coordinatesをセンターとしたときのロケーションの範囲(メートル)
address	string 住所文字列

Responses

201

Created

400

Invalid request parameters

401

Api key is not valid

403

You don't have permission to access the resource

404

Organization is not found

500

Internal server error

post/services/fleet/locations

https://smartdrive-api.com/v1.2/services/fleet/locations

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"name": "東京タワー",
"organization": 
{"id": "ZrMa7d5WF6cpsV0ejp29"
},
"address": "東京都港区芝公園４丁目２−８",
"coordinates": 
{"lat": 35.658581,
"lng": 139.745433
},
"radius": 100
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"meta": 
{"http_status_code": 200,
"result": true
},
"data": 
{"id": "sV2Wcp9FZrMa7d56p0ej",
"name": "東京タワー",
"address": "東京都港区芝公園４丁目２−８",
"coordinates": 
{"lat": 35.658581,
"lng": 139.745433
},
"radius": 100,
"created_at": "2020-07-06T04:03:27Z",
"updated_at": "2020-07-06T04:03:27Z"
}
}

List locations

処理概要

ロケーション一覧を取得します。ソートは作成日時降順となります。

Authorizations:

appToken

query Parameters

organization_id required	string 組織IDフィルタ。指定した組織のリソースのみが取得できます。
ids	Array of strings [ 1 .. 50 ] items IDフィルタ。指定するとそのIDのリソースのみが取得できます。 IDをカンマ区切りで結合した文字列。一度に最大50件まで指定可能。 idsを指定するとcoordinates パラメーターは無視されます。 example: MwZLrkoAlr,2kO7DroQzP,mQkoA9opAg,eykoxz7RlE,meD7qjLXrd
coordinates	Array of numbers 2 items 検索で絞り込む際の中心位置。 latitude,longitudeを`,`で区切って指定する。 coordinatesを指定するとids パラメーターは無視されます。 coordinatesを指定するとradiusパラメーターが必要になります。検索結果は、coordinatesから近い順にソートされて返されます。 example: 130.234,32.98
radius	number > 0 Default: 500 検索で絞り込む際の中心位置からの検索範囲(単位:メートル)
sort	string Default: "id" Enum: "id" "created_at" "updated_at" ソートフィールド。idsを指定するときは無視されます。
direction	string Default: "desc" Enum: "asc" "desc" ソート順。
cursor	string リソース一覧を取得する際の取得開始位置を示すもので、一覧の途中からデータを抽出するために利用します。ページング可能なコレクションリソースにおいて、データ量が多く、一度のAPI呼び出しで全てのデータを取得できないケースでは、レスポンスにpaging.nextというプロパティが設定されます。次回のAPI呼び出し時にその値を設定することで、残りのデータを取得することができます。未指定の場合は最初から取得します。
limit	integer [ 1 .. 100 ] Default: 50 一度に取得するリソース数(最大100)

Responses

200

400

Invalid request parameters

401

Api key is not valid

403

You don't have permission to access the resource

404

Organization is not found

500

Internal server error

get/services/fleet/locations

https://smartdrive-api.com/v1.2/services/fleet/locations

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"meta": 
{"http_status_code": 200,
"result": true
},
"paging": 
{"next": "MTAxNTExOTQ1MjAwNzI5NDE="
},
"data": 
[
{"id": "sV2Wcp9FZrMa7d56p0ej",
"name": "東京タワー",
"address": "東京都港区芝公園４丁目２−８",
"coordinates": 
{"lat": 35.658581,
"lng": 139.745433
},
"radius": 100,
"created_at": "2020-07-06T04:03:27Z",
"updated_at": "2020-07-06T04:03:27Z"
}
]
}

Update location

処理概要

ロケーションのプロパティを更新します。

Authorizations:

appToken

path Parameters

location_id

required

string

対象になるロケーション

Request Body schema: application/json

更新するロケーションのプロパティ。すべてオプショナルです。

name	string [ 1 .. 256 ] characters Nullable ロケーションの名前
address	string Nullable 住所文字列
coordinates	object Nullable
radius	number > 0 Nullable coordinatesをセンターとしたときのロケーションの範囲(メートル)

Responses

200

400

Invalid request parameters

401

Api key is not valid

403

You don't have permission to access the resource

404

Location is not found

500

Internal server error

patch/services/fleet/locations/{location_id}

https://smartdrive-api.com/v1.2/services/fleet/locations/{location_id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"name": "東京タワー",
"address": "東京都港区芝公園４丁目２−８",
"coordinates": 
{"lat": 35.658581,
"lng": 139.745433
},
"radius": 100
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"meta": 
{"http_status_code": 200,
"result": true
},
"data": 
{"id": "sV2Wcp9FZrMa7d56p0ej",
"name": "東京タワー",
"address": "東京都港区芝公園４丁目２−８",
"coordinates": 
{"lat": 35.658581,
"lng": 139.745433
},
"radius": 100,
"created_at": "2020-07-06T04:03:28Z",
"updated_at": "2020-07-06T04:03:28Z"
}
}

Remove a location

処理概要

ロケーションを削除します。

Authorizations:

appToken

path Parameters

location_id

required

string

対象になるロケーション

Responses

200

400

Invalid request parameters

401

Api key is not valid

403

You don't have permission to access the resource

404

Location is not found

500

Internal server error

delete/services/fleet/locations/{location_id}

https://smartdrive-api.com/v1.2/services/fleet/locations/{location_id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"meta": 
{"http_status_code": 200,
"result": true
}
}

Fleet/Trips

走行を参照・操作するためのエンドポイント。

List trips

処理概要

走行一覧を取得します。走行の終了時間昇順で取得されます。

Authorizations:

appToken

query Parameters

organization_id required	string 組織IDフィルタ。指定した組織のリソースのみが取得できます。
ts_from required	string <date-time> タイムスタンプフィルタ。指定するとその時刻以降のリソースのみが取得できます。(指定値を含む) formatはrfc3339。例) 2014-01-01T00:00:00Z
ts_to required	string <date-time> タイムスタンプフィルタ。指定するとその時刻以前のリソースのみが取得できます。(指定値を含む) formatはrfc3339。例) 2014-02-01T00:00:00Z
ids	Array of strings <uuid> [ 1 .. 50 ] items 走行IDフィルタ。指定した走行IDのリソースのみが取得できます。 IDをカンマ区切りで結合した文字列。一度に最大50件まで指定可能。 idsを指定した場合は、ts_from, ts_to パラメーターは無視されます。 example: fasdf,sadfasd,sadfsd
sort	string Default: "ended_at" Enum: "started_at" "ended_at" "updated_at" ソートフィールド。idsを指定するときは無視されます。
direction	string Default: "desc" Enum: "asc" "desc" ソート順。
cursor	string リソース一覧を取得する際の取得開始位置を示すもので、一覧の途中からデータを抽出するために利用します。ページング可能なコレクションリソースにおいて、データ量が多く、一度のAPI呼び出しで全てのデータを取得できないケースでは、レスポンスにpaging.nextというプロパティが設定されます。次回のAPI呼び出し時にその値を設定することで、残りのデータを取得することができます。未指定の場合は最初から取得します。
limit	integer [ 1 .. 100 ] Default: 50 一度に取得するリソース数(最大100)

Responses

200

400

Invalid request parameters

401

Api key is not valid

403

You don't have permission to access the resource

404

Organization is not found

500

Internal server error

get/services/fleet/trips

https://smartdrive-api.com/v1.2/services/fleet/trips

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"meta": 
{"http_status_code": 200,
"result": true
},
"paging": 
{"next": "MTAxNTExOTQ1MjAwNzI5NDE="
},
"data": 
[
{"id": "5d08b840-6168-4229-b29b-5e593d357d9f",
"context": 
{"device": 
{"code": "string"
},
"account": 
{"id": "zjd5ge0v",
"display_name": "JohnDoe"
},
"vehicle": 
{"id": "gB0NV05e",
"name": "SuperCar"
}
},
"started_at": "2016-10-06T03:52:27.345Z",
"ended_at": "2016-10-06T04:31:15.112Z",
"distance": 900,
"start_point": 
{"timestamp": "2016-10-06T04:31:15.112Z",
"latitude": 35.658581,
"longitude": 139.745433
},
"end_point": 
{"timestamp": "2016-10-06T04:31:15.112Z",
"latitude": 35.658581,
"longitude": 139.745433
},
"gforce_distribution_diagnosis": 
{"score": 98,
"acceleration_score": 100,
"deceleration_score": 93,
"steering_left_score": 100,
"steering_right_score": 100,
"hard_acceleration_count": 0,
"hard_deceleration_count": 24,
"hard_steering_left_count": 0,
"hard_steering_right_count": 0
},
"created_at": "2020-07-06T04:03:28Z",
"updated_at": "2020-07-06T04:03:28Z"
}
]
}