English概要

JIMIオープンAPIにより、販売店またはアプリケーションベンダーはAPIを呼び出したりユーザー自身のGUIクライアント、アプリ、またはWebサイトを使用したりして、お客様に追跡サービスを提供し、測位またはユーザー体験を向上させます。


アプリまたはウェブクライアントを、JIMI APIサーバーに直接接続するのではなく、アプリケーションサーバーに接続する必要があります。そして、アプリケーションサーバーを使用してJIMIサーバーに接続します。

Usage

1.appKeyとappSecrectを申し込む場合は、当社までお問い合わせください。アカウントを提供する必要があります。
2.このドキュメントに従って、アプリケーションサーバーを実装してaccess_tokenを取得します。
3.access_tokenを使用して他のインターフェースを呼び出し、ビジネスロジックを実行します。

規則

エンコーディング、フォーマットとタイムゾーン



Context-Type:デフォルトでは
デフォルトではUTC (GMT +0) 時間が使用されます。フォーマットはyyyy-MM-dd HH:mm:ssです。 
                    

一般的な応答フィールド

キー 必須かどうか 説明
コード int はい 結果コード
メッセージ string いいえ 説明

結果コードの説明

コード 説明
-1 -1 システムがビジー状態です
0 0 完了
1xxx 1001 パラメータエラー(必須パラメータの不足またはフォーマットエラー)。詳細については、インターフェースの説明を参照してください
1002 不正なユーザー/不正なデバイス(自分のアカウントやデバイスではない)
1003 繰り返し操作
1004 不正なアクセス。トークンが異常です。(トークンの失敗またはトークンが存在しない)
1005 不正なアクセス。IPアクセス回数が制限を超えています。
1006 不正なアクセス。リクエスト回数が多すぎます。
1007 不正なアクセス。リクエストメソッドエラー。
1008 不正なアクセス。受信が異常です。
12001 アカウントの作成に失敗しました
12002 デバイスの転送に失敗しました
12003 ジオフェンスの作成に失敗しました
12004 ジオフェンスの削除に失敗しました
12005 コマンドの送信に失敗しました

エラーコード:

コード 説明
アカウントの作成 213 アカウントは既に存在します
214 アカウントが存在しません
215 ユーザータイプエラー。考えられる理由:1.ユーザータイプが空です。2. ユーザータイプが存在しません。3. 現在のログインユーザーには、新しいタイプのユーザーを作成する権限がありません。
デバイスの転送 217 Tターゲットユーザーが存在しません
218 ユーザーはデバイスをサブアカウントにのみ転送・販売できます
219 不正なIMEIリスト
220 IMEIの数が制限を超えています。
ジオフェンス 41001 サポートされているジオフェンスの最大数を超えています
41002 フェンス名は既に存在します
41003 デバイスはオフラインです
41004 ジオフェンス操作に失敗しました
コマンド 225 タイムアウト
226 パラメータエラー
227 コマンドが正しく実行されていません
228 デバイスはオフラインです
229 ネットワークエラー、接続エラーなど
238 デバイスが中断されました
240 データフォーマットエラー
243 デバイスではサポートされていません
252 デバイスはビジーです

ワークフロー

API Work Flow

APIワークフロー

インターフェースタイプ メソッド 説明
アクセストークン jimi.oauth.token.get access_tokenを取得します
jimi.oauth.token.refresh access_tokenを更新します
ユーザーAPI jimi.user.child.list すべてのサブアカウントを一覧表示します
jimi.user.device.list 現在のアカウントのすべてのデバイスを一覧表示します
jimi.user.child.create サブアカウントを作成します
jimi.user.child.del サブアカウントを削除します
jimi.user.child.move サブアカウントを別のアカウントに移動します
jimi.track.device.detail 特定のIMEIのデバイス詳細情報を取得します
jimi.user.device.location.list すべてのデバイスの最新位置を取得します
Device API jimi.device.location.get 特定のIMEIの最新の位置データを取得します
jimi.device.location.URL.share マップ上の位置を表示するためのURLを取得します
jimi.user.device.expiration.update デバイスのユーザー有効期限を変更します
jimi.device.track.list IMEIに従って追跡データを取得します
jimi.device.track.mileage デバイスのマイレージレポートを取得します
jimi.open.device.update デバイスの車両情報を変更します
Jimi.device.media.URL カメラで撮影した写真または映像のURLを取得します
jimi.device.live.page.url デバイスのライブストリーミングページのURLを取得します
コマンドAPI jimi.open.instruction.list デバイスでサポートされているコマンドを取得します
jimi.open.instruction.send jimi.open.instruction.send
jimi.open.instruction.result コマンド結果を取得します
ジオフェンスAPI jimi.open.device.fence.delete デバイスのジオフェンスを削除します
jimi.open.device.fence.create デバイスのジオフェンスを作成します
LBS-API jimi.lbs.address.get Wi-Fi基地局の位置分析
Message jimi.push.device.alarm アラーム通知をプッシュします
jimi.device.alarm.list デバイスのアラームリストを取得します
Scooter API jimi.scooter.instruction.send コマンドをスクーターデバイスに送信します
jimi.scooter.device.detail スクーターのステータスやその他の詳細情報を取得します

APIの説明

リクエストURL

リクエストURLは一意であり、そのアドレスはhttp://open.10000track.com/route/restです。

各インターフェースは、リクエストパラメータメソッドによって識別されます。

セキュリティ

クライアントは、インターフェースを呼び出す前にまずaccess_tokenを取得する必要があります。インターフェースは、提供されたappKeyとappSecrectを使用してjimi.oauth.token.get interface(method=jimi.oauth.token.get)を呼び出すことで、JIMIサーバーによって生成されます。


APIを呼び出す場合、appKeyとaccess_tokenをリクエストパラメータの署名に使用する必要があります。JIMIサーバーは、署名の値をチェックすることにより、リクエストパラメータを検証します。

一般的なパラメータ

各リクエストパラメータには、一般的なパラメータとインターフェースプライベートパラメータが含まれています。たとえば、「jimi.oauth.token.get」インターフェースを呼び出す場合必要なものは:

(一般的なパラメータ)+ 3(プライベートパラメータ)= 10(パラメータ、キー/値)


名称 必須かどうか 説明 備考 デフォルト
method string はい APIインターフェース名
timestamp string Yes タイムスタンプを指します。形式は「yyyy-MM-dd HH:mm:ss」です。プラスまたはマイナス10分が許可されています。たとえば、2012-03-25 20:00:00です。 GMT(UTC)時間。
app_key string Yes APP_KEY JIMIから割り当てる
sign string はい パラメータ、appKey、appSecrectに基づく署名です。
sign_method string はい オプション、署名方法です。可能な値はmd5、サポートされている方法はmd5です。
v string はい オプション、APIバージョンを指定します。システムのデフォルト値は1.0、対応バージョンは1.0です。 >md5 >md5
システムのデフォルト値は1.0、対応バージョンは 0.9と1.0です 1.0:署名の確認
format string はい オプションで、応答フォーマットを指定します。 json

署名

ハッキングからAPI呼び出しを保護するには、API呼び出しに署名を付ける必要があります。JIMIサーバーはリクエストパラメータに基づいて署名をチェックします。不正な署名リクエストは拒否されます。サポートされている署名アルゴリズムはmd5です(sign_methodは上記の一般的なパラメーターです)。署名のアルゴリズムを次に示します。

1. すべてのリクエストパラメータ(一般的なパラメータとメソッド固有のパラメータを含みますが、符号とバイトタイプのパラメータを含みません)をパラメータキーでアルファベット順に並べ替えます。

例:

foo=1, bar=2, foo_bar=3, foobar=4
結果: bar=2, foo=1, foo_bar=3, foobar=4

2. すべての等号とコンマを削除します。:

bar2foo1foo_bar3foobar4

3. appSecrectを結果文字列の前後に連結し、md5値を取得します。例:

md5(<appSecrect>+bar2foo1foo_bar3foobar4+<appSecrect>), the real string should like: md5(h9lri085eachcz4sn7gwnkh6j0jt0yz4bar2foo1foo_bar3foobar4h9lri085eachcz4sn7gwnkh6j0jt0yz4)

文字列はUTF-8エンコーディングを使用する必要があります。
符号は大文字の文字列を使用する必要があります。

パラメータ値がバイトストリームの場合、16進数に変換する必要があります。たとえば、hex(“helloworld”.getBytes(“utf-8”)) = “68656C6C6F776F726C64”です。


MD5は128ビットの要約アルゴリズムで、16進数です。16進文字は4ビットを表すことができるため、署名文字列の長さは32桁の16進文字です。

JAVAの例:

public static String signTopRequest(Map <String, String> params, >String seccode, String> signMethod) throws IOException {
    // 1:パラメータキーを並べ替える
    String[] keys = params.keySet().toArray(new String[0]);
    Arrays.sort(keys);
 
    // 2:: すべてのパラメータ名とパラメータ値をまとめる
    StringBuilder query = new StringBuilder();
    if (Constants.SIGN_METHOD_MD5.equals(signMethod)) {
        query.append(seccode);
    }
    for (String key : keys) {
        String value = params.get(key);
        if (StringUtils.areNotEmpty(key, value)) {
            query.append(key).append(value);
        }
    }
 
    // 3: MD5/HMACを使用して暗号化する
    byte[] bytes;
    if (Constants.SIGN_METHOD_HMAC.equals(signMethod)) {
        bytes = encryptHMAC(query.toString(), seccode);
    } else {
        query.append(seccode);
        bytes = encryptMD5(query.toString());
    }
 
   // 4: 2進数を大文字の16進数に変換する
    return byte2hex(bytes);
}
 
public static byte[] encryptHMAC(String data, String seccode) throws IOException {
    byte[] bytes = null;
    try {
        seccodeKey seccodeKey = new seccodeKeySpec(seccode.getBytes(Constants.CHARSET_UTF8), "HmacMD5");
        Mac mac = Mac.getInstance(seccodeKey.getAlgorithm());
        mac.init(seccodeKey);
        bytes = mac.doFinal(data.getBytes(Constants.CHARSET_UTF8));
    } catch (GeneralSecurityException gse) {
        throw new IOException(gse.toString());
    }
    return bytes;
}
 
public static byte[] encryptMD5(String data) throws IOException {
    return encryptMD5(data.getBytes(Constants.CHARSET_UTF8));
}
 
public static String byte2hex(byte[] bytes) {
    StringBuilder sign = new StringBuilder();
    for (int i = 0; i < bytes.length; i++) {
        String hex = Integer.toHexString(bytes[i] & 0xFF);
        if (hex.length() == 1) {
            sign.append("0");
        }
        sign.append(hex.toUpperCase());
    }
    return sign.toString();
}
                            

アクセストークンの取得

説明

クライアント(販売店のサーバー)はaccess_tokenをローカルに保存する必要があります。リクエストごとにaccess_tokenを取得する代わりに、ローカルのaccess_tokenを無効になる前に使用してください。クライアントからのリクエスト回数が多すぎた場合、JIMIサーバーはアクセスを許可しなくなります。


アクセストークンは約2時間(expires_inパラメータの値によって異なる)使用できます。すべてのリクエストでトークンを取得しようとしないでください。

リクエストURL

一意のリクエストURLを参照してください。Method = jimi.oauth.token.get

HTTPリクエストメソッド

POST

リクエストパラメータ

(1) 一般的なパラメータ
    

(2) 個人パラメータ
    

名称 必須かどうか 説明 備考 デフォルト
user_id string はい ユーザーID ユーザーのアカウント
user_pwd_md5 string はい ユーザーのパスワード(md5) 小文字のmd5値
expires_in number はい アクセストークンの有効期限(秒) 60-7200

レスポンス

キー 説明
code int リターンコード
0: 正常終了
その他:異常終了 エラーコードの説明を参照してください
message string コードが0でない場合、対応するエラーメッセージが表示されます
result string 結果
accessToken string アクセストークン。以下に示す他のインターフェースに必要とされます。
expiresIn string アクセストークンの有効期限(秒)
account string ユーザーのアカウント
appKey string JIMIのAppKey
refreshToken string リフレッシュトークン。accessTokenの更新に使用されます。
time string トークンの生成時間

正常終了の例:

{
  "code": 0,
  "message": "success",
  "result": {
    "appKey": "8FB345B8693CCD003CC2DAB61EC8791D",
    "account": "jimitest",
    "accessToken": "7da3330ec28e3996b6ef4a7e3390ba71",
"expiresIn": 60
"refreshToken": "7da3330ec28e3996b6ef4a7e3390ba71",
	"time": "2017-06-15 10:00:00"

  }
}                  

異常終了の例:

{"code":xxx,"message":"Incorrect user name or password"}

Postmanデモ:


user_id :TrackSolidアカウント
user_pwd_md5:md5(TrackSolidアカウントのパスワード)
Sign:md5(等号、コンマ、およびSignフィールドを除く、アルファベット順のパラメーター)
「Sign」は32文字の大文字の文字列である必要があります。

例:

<app_secrect>app_key9FB345B8693CCD0054E44ADF99139409expires_in7200formatjsonmethodjimi.oauth.token.getsign_methodmd5timestamp2017-09-28 01:55:00user_id<account>user_pwd_md5<password_md5>v1.0<app_secrect>

アクセストークンの更新

説明

このインターフェースは、アクセストークンが無効になる前に手動でトークンを更新するために使用されます。

リクエストURL

一意のリクエストURLを参照してください。Method = jimi.oauth.token.refresh

HTTPリクエストメソッド

POST

リクエストパラメータ

(1) 一般的なパラメータ

(2) 個人パラメータ


パラメータ 必須かどうか 説明 備考 デフォルト
access_token string はい アクセストークン
refresh_token string はい アクセストークン発行時に取得したリフレッシュトークン
expires_in number はい アクセストークンの有効期限(秒) 60-7200

レスポンス

キー 説明
code int リターンコード: :
0: 正常終了
その他:異常終了 エラーコードの説明を参照してください
message string コードが0でない場合、対応するエラーメッセージが されます
結果 string Result
accessToken string アクセストークン。次のインターフェースのアクセスに必要とされます。
expiresIn string アクセストークンの有効期限(秒)
account string リクエストされたアカウント
appKey string JIMIから
refreshToken string アクセストークンを更新するためのリフレッシュトークン
time string トークンの生成時間

正常終了の例:

{
  "code": 0,
  "message": "success",
  "result": {
    "appKey": "8FB345B8693CCD003CC2DAB61EC8791D",
    "account": "jimitest",
    "accessToken": "7da3330ec28e3996b6ef4a7e3390ba71",
    "expiresIn": 60,
	"refreshToken": "7da3330ec28e3996b6ef4a7e3390ba71",
	"time": "2017-06-15 10:00:00"
  }
}
                    

異常終了の例:

{"code":xxx,"message":"Illegal request,token is invalid"}

すべてのサブアカウントの一覧表示

説明

指定したアカウントのすべてのサブアカウントを一覧表示します。

リクエストURL

一意のリクエストURLを参照してください。Method = jimi.user.child.list

HTTPリクエストメソッド

POST

リクエストパラメータ

(1) 一般的なパラメータ

(2) 個人パラメータ


パラメータ 必須かどうか 備考 説明
access_token string はい JIMIサーバーに安全にアクセスするためのアクセストークン。
target string はい - The specified account for inquired. 照会対象となる指定アカウント。

レスポンス

キー 説明
code int リターンコード:
0:正常終了
その他:異常終了 エラーコードの説明を参照してください
message string コードが0でない場合、対応するエラーメッセージが表示されます
結果: string 結果:

結果:

キー 説明
account string ログインアカウント
name string 名称
type int アカウントタイプ
3:アプリユーザー
8:販売店
9:元のユーザー
10:元の販売店
11:営業
displayFlag int 利用可能かどうか(1:利用可能 0:利用不可)
address string 位置
birth string 生年月日
companyName string 会社名
email string メールアドレス
phone string 電話番号
language string 言語(zh、en)
sex int 性別。0:男性 1:女性
enabledFlag int フラグ。1:利用可能 0:利用不可
remark string 備考

正常終了の例:

{
  "code": 0,
  "message": "success",
  "result": [
    {
      "account": "123123",
      "name": "test",
      "type": 8,
      "displayFlag": 1,
      "address": null,
      "birth": "2017-04-22 00:00:00",
      "companyName": "",
      "email": "",
      "phone": "",
      "language": "zh",
      "sex": 0,
      "enabledFlag": 1,
      "remark": null
    }
  ]
}
                    

異常終了の例:

{"code":xxx,"message":"The account does not exist"}

サブアカウントの作成

説明

指定アカウントのサブアカウントを作成します。

リクエストURL

一意のリクエストURLを参照してください。Method = jimi.user.child.create

HTTPリクエストメソッド

POST

リクエストパラメータ

(1) 一般的なパラメータ

(2) 個人パラメータ


パラメータ 必須かどうか 備考 説明
access_token string はい JIMIサーバーに安全にアクセスするためのアクセストークン。
super_account string いいえ - 指定された親アカウント。指定されていない場合は、APIアカウントを使用します。
account_id string はい - アカウントID。長さは3〜30文字です。a~Z、0~9と「_@.」などの特殊文字を使用できます。
nick_name string はい - ニックネームまたは顧客名
account_type int はい - 1-販売店 2-エンドユーザー 3-営業
password string はい - md5形式のパスワード。
telephone string いいえ -
Email string はい - パスワードを忘れた場合、ユーザーはパスワードを取得できます。
contact_person string いいえ -
company_name string いいえ -
permissions string はい - ウェブログイン
アプリログイン
コマンドの送信
動作モードの設定
ウェブでの編集
アプリでの編集
6桁の数字は権限の有効化/無効化を表します。

レスポンス

キー 説明
code int リターンコード:
0:正常終了
その他:異常終了 エラーコードの説明を参照してください
message string コードが0でない場合、対応するエラーメッセージが表示されます
result string 結果

正常終了の例::

{
  "code": 0,
  "message": "Vehicle information modification successful",
  "result": null
}
                    

異常終了の例:

{"code":xxx,"message":"The account does not exist"}

サブアカウントの削除

説明

指定されたアカウントのサブアカウントを削除します。

リクエストURL

一意のリクエストURLを参照してください。Method = jimi.user.child.del

HTTPリクエストメソッド

POST

リクエストパラメータ

(1) 一般的なパラメータ

(2) 個人パラメータ


パラメータ 必須かどうか 備考 説明
access_token string はい JIMIサーバーに安全にアクセスするためのアクセストークン。
super_account string いいえ - 指定された親アカウント。指定されていない場合は、APIアカウントを使用します。
account_id string はい - アカウントID。長さは3〜30文字です。a~Z、0~9と「_@.」などの特殊文字を使用できます。

レスポンス

キー 説明
code int リターンコード:
0:正常終了
その他:異常終了 エラーコードの説明を参照してください
message string コードが0でない場合、対応するエラーメッセージが表示されます
result string 結果

正常終了の例:

{
  "code": 0,
  "message": "Vehicle information modification successful",
  "result": null
}
                    

異常終了の例:

{"code":xxx,"message":"no permissions"}

アカウントの移動

説明

あるサブアカウントから別のサブアカウントにアカウントを移動します。

リクエストURL

一意のリクエストURLを参照してください。Method = jimi.user.child.move

HTTPリクエストメソッド

POST

リクエストパラメータ

(1) 一般的なパラメータ

(2) 個人パラメータ


パラメータ 必須かどうか 備考 説明
access_token string はい - JIMIサーバーに安全にアクセスするためのアクセストークン。
account string はい - アカウントが移動されます。
target_account string はい - 移動対象とするターゲットアカウント。

レスポンス

キー 説明
code int リターンコード:
0:正常終了
その他:異常終了 エラーコードの説明を参照してください
message string コードが0でない場合、対応するエラーメッセージが表示されます
result string 結果

正常終了の例:

{
  "code": 0,
  "message": "Vehicle information modification successful",
  "result": null
}
                    

異常終了の例:

{"code":xxx,"message":"no permissions"}

サブアカウントのすべてのデバイスの一覧表示

説明

指定したアカウントのすべてのデバイスを照会します。

リクエストURL

一意のリクエストURLを参照してください。Method = jimi.user.device.list

HTTPリクエストメソッド

POST

リクエストパラメータ

(1) 一般的なパラメータ

(2) 個人パラメータ


パラメータ 必須かどうか 説明 Description
access_token string はい JIMIサーバーに安全にアクセスするためのアクセストークン。
target string はい - 照会対象となる指定アカウント。

レスポンス

キー 説明
code int リターンコード:
0:正常終了
その他:異常終了 エラーコードの説明を参照してください
message string コードが0でない場合、対応するエラーメッセージが表示されます
result string 返されたデータ
imei string デバイスIMEI
deviceName string デバイス名
mcType string デバイスモデル
mcTypeUseScope string 自動車、電気自動車、個人、ペット、飛行機とその他
sim string SIMカード番号
expiration string プラットフォームの有効期限
activationTime string 有効化時刻
reMark string 備考
vehicleName string 車両名
vehicleIcon string 車両のアイコン
vehicleNumber string ナンバープレート
vehicleModels string ブランド
carFrame string VIN
driverName string ドライバーの名前
driverPhone string ドライバーの電話番号
enabledFlag int 利用可能かどうか(1:利用可能 0:利用不可)
engineNumber string エンジン番号

正常終了の例:

{
  "code": 0,
  "message": "success",
  "result": [
    {
      "imei": "868120145233604",
      "deviceName": "868120145233604",
      "mcType": "GT300L",
      "mcTypeUseScope": "personal",
      "sim": "415451",
      "expiration": "2037-04-01 23:59:59",
      "activationTime": "2017-04-01 11:02:20",
      "reMark": "test",
      "vehicleName": null,
      "vehicleIcon": "bus",
      "vehicleNumber": "粤B3604",
      "vehicleModels": null,
      "carFrame": "2235",
      "driverName": "driver",
      "driverPhone": "13825036579",
      "enabledFlag": 1,
      "engineNumber": "8565674"
    }
  ]
}
             

異常終了の例:

{"code":xxx,"message":"Account queried doesn’t exist"}

デバイスの詳細情報の取得

説明

特定のIMEIのデバイス詳細情報を取得します。

リクエストURL

一意のリクエストURLを参照してください。Method = jimi.track.device.detail

HTTPリクエストメソッド

POST

リクエストパラメータ

(1) 一般的なパラメータ

(2) 個人パラメータ


パラメータ 必須かどうか 備考 説明
access_token string はい JIMIサーバーに安全にアクセスするためのアクセストークン。
IMEI string はい - 照会対象となる指定IMEI。

レスポンス

キー 説明
code int リターンコード:
0:正常終了
その他:異常終了 エラーコードの説明を参照してください
message string コードが0でない場合、対応するエラーメッセージが表示されます
result string 返されたデータ
imei string デバイスIMEI
deviceName string デバイス名
mcType string デバイスモデル
mcTypeUseScope string 自動車、電気自動車、個人、ペット、飛行機とその他
sim string SIMカード番号
expiration string プラットフォームの有効期限
user_expiration string ユーザーの有効期限。形式:アカウント1,2019-01-01|アカウント2,2019-02-02
activationTime string 有効化時刻
reMark string 備考
vehicleName string 車両名
vehicleIcon string 車両のアイコン
vehicleNumber string ナンバープレート
vehicleModels string 車のモデル
carFrame string VIN
driverName string ドライバーの名前
driverPhone string ドライバーの電話番号
enabledFlag int 利用可能かどうか(1:利用可能 0:利用不可)
engineNumber string エンジン番号
iccid string
importTime string
imsi string
licensePlatNo string
VIN string
vehicleBrand string
fuel_100km string 100kmあたりの燃料消費量。
status string 0-無効 1-有効

正常終了の例:

{
  "code": 0,
  "message": "success",
  "result":
    {
      "imei": "868120145233604",
      "deviceName": "868120145233604",
      "mcType": "GT300L",
      "mcTypeUseScope": "personal",
      "sim": "415451",
      "expiration": "2037-04-01 23:59:59",
      "activationTime": "2017-04-01 11:02:20",
      "reMark": "test",
      "vehicleName": null,
      "vehicleIcon": "bus",
      "vehicleNumber": "粤B3604",
      "vehicleModels": null,
      "carFrame": "2235",
      "driverName": "driver",
      "driverPhone": "13825036579",
      "enabledFlag": 1,
      "engineNumber": "8565674",
 "iccid": "xxxxxxx",
 "imsi": "xxxx",
 "importTime": "2017-04-01 11:02:20",
 "licensePlatNo": "8565674",
 "VIN": "xxxxxxx",
 "vehicleBrand": "xxxx",
 "fuel_100km": "9",
 "status": "8565674"
    }
}                 

異常終了の例:

{"code":xxx,"message":"Account queried doesn’t exist"}

アカウントを介したデバイスの位置の取得

説明

アカウントのすべてのデバイスの最新の位置情報を取得します。

リクエストURL

一意のリクエストURLを参照してください。Method = jimi.user.device.location.list

HTTPリクエストメソッド

POST

リクエストパラメータ

(1) 一般的なパラメータ

(2) 個人パラメータ


パラメータ 必須かどうか 備考 説明
access_token string Yes JIMIサーバーに安全にアクセスするためのアクセストークン。
target string Yes - 照会対象となるアカウントを指定します。
map_type string No - map_type=GOOGLEの場合、Googleにより位置を校正しました。
map_type=nullの場合、原点の緯度と経度を返します。

レスポンス

キー 説明
code int ターンコード:
0:正常終了
その他:異常終了 エラーコードの説明を参照してください
message string コードが0でない場合、対応するエラーメッセージが表示されます
result string 返されたデータ
imei string デバイスIMEI
deviceName string デバイス名
icon string 車両のアイコン
status string デバイスのステータス。0:オフライン 1:オンライン
Lat double 経度(デバイスの有効期限が切れている場合、値は0です)
Lng double 緯度(デバイスの有効期限が切れている場合、値は0です)
expireFlag string 期限切れかどうか。1-期限切れ 0-有効期限が切れていない
activationFlag string 有効かどうか。1-有効 0-無効
posType string GPS, LBS, WIFI,BEACON
locDesc string 位置情報
gpsTime string GPS測位時間
hbTime string ハートビート時間
Speed string 速度(km/h)
accStatus string ACC。0-オフ 1-オン
electQuantity string デバイスのバッテリー(0~100)、一部のモデルはサポートされていません
powerValue string 外部電圧(0~100)、一部のモデルはサポートされていません

正常終了の例:

{
  "code": 0,
  "message": "success",
  "result": [
    {
      "imei": "868120145233604",
      "deviceName": "868120145233604",
      "icon": "bus",
      "status": "0",
      "posType": "GPS",
      "lat": 22.577282,
      "lng": 113.916604,
      "hbTime": "2017-04-26 09:14:50",
      "accStatus": "0",
      "speed": "0",
      "gpsTime": "2017-04-26 09:17:46",
      "activationFlag": "1",
      "expireFlag": "1",
      "electQuantity": "60",
      "locDesc": null
      "powerValue": null
    }
  ]
}
                    

異常終了の例:

{"code":xxx,"message":"The account does not exist"}

デバイスの位置情報の取得

説明

つまたは複数のデバイスの最新の位置情報を取得します。

リクエストURL

一意のリクエストURLを参照してください。Method = jimi.device.location.get

HTTPリクエストメソッド

POST

リクエストパラメータ

(1) 一般的なパラメータ

(2) 個人パラメータ


パラメータ 必須かどうか 備考 説明
access_token string Yes アクセストークン:JIMIサーバーに安全にアクセスするために使用されます。
imei string Yes - デバイスIMEI。imeiはコンマで区切ります。デバイスが多すぎた場合は、POSTをお勧めします(最大100 のIMEI)。
map_type string No - map_type=GOOGLEの場合、Googleキャリブレーションにより調整します。map_type=nullの場合、原点の緯度と経度を返します。

レスポンス

キー 説明
code int リターンコード:
0:正常終了 その他:異常終了 エラーコードの説明を参照してください
message string コードが0でない場合、対応するエラーメッセージが表示されます
result string 返されたデータ

結果リスト:

キー 説明
IMEI string デバイスIMEI
deviceName string デバイス名
Icon string 車両のアイコン
status string デバイスのステータス。0:オフライン 1:オンライン
Lat double 経度(デバイスの有効期限が切れている場合、値は0です)
Lng double 緯度(デバイスの有効期限が切れている場合、値は0です)
expireFlag string 1-期限切れ 0-有効期限が切れていない
activationFlag string 1-有効 0-無効
posType string GPS, LBS, WIFI, BEACON
locDesc string 位置情報
gpsTime string GPS測位時間
hbTime string ハートビート時間
speed string 速度(km/h)
accStatus string ACC。0-オフ 1-オン
electQuantity string バッテリー(0~100)、一部のデバイスモデルはサポートされていません
powerValue string 外部電圧(0~100)、一部のデバイスモデルはサポートされていません
distance string デバイスからの距離。

正常終了の例:

{
  "code": 0,
  "message": "success",
  "result": [
    {
      "imei": "868120145233604",
      "deviceName": "868120145233604",
      "icon": "bus",
      "status": "0",
      "posType": "GPS",
      "lat": 22.577282,
      "lng": 113.916604,
      "hbTime": "2017-04-26 09:14:50",
      "accStatus": "0",
      "speed": "0",
      "gpsTime": "2017-04-26 09:17:46",
      "activationFlag": "1",
      "expireFlag": "1",
      "electQuantity": "60",
      "locDesc": null
      "powerValue": null
    }
  ]
}
                    

異常終了の例:

{"code":xxx,"message":"Illegal device"}

共有位置のURLの取得/h2>

説明

地図に表示されているデバイスの位置のURLを取得します。

リクエストURL

一意のリクエストURLを参照してください。Method = jimi.device.location.URL.share

HTTPリクエストメソッド

POST

リクエストパラメータ

(1) 一般的なパラメータ

(2) 個人パラメータ


パラメータ 必須かどうか 備考 説明
access_token string Yes アクセストークン:JIMIサーバーに安全にアクセスするために使用されます。
imei string Yes - デバイスIMEI

レスポンス

キー 説明
code int リターンコード:
0:正常終了
その他:異常終了 エラーコードの説明を参照してください
message string コードが0でない場合、対応するエラーメッセージが表示されます
result string 返されたデータには、URL情報が含まれています。

正常終了の例:

{
  "code": 0,
  "message": "success",
  "result":
    {
      "URL": "data.16180track.com/api/share?ver=2&method=trackDevice_abr&deviceinfo=7ae7c62385f2067f164002db315854a969a40e3888021cb01dc8f2183ca08dbbd8581f6bb86df4c2e3e1b887cb67c21039b4c0ced18fdf8dd08e0460c5edd13ad87e16dca9702ce6",
    }
}
                    

異常終了の例:

{"code":xxx,"message":"Illegal device"}

デバイスのユーザー有効期限の更新

説明

リクエストURL

一意のリクエストURLを参照してください。Method = jimi.user.device.expiration.update

HTTPリクエストメソッド

POST

リクエストパラメータ

(1) 一般的なパラメータ

(2) 個人パラメータ


パラメータ 必須かどうか 備考 説明
access_token string はい アクセストークン:JIMIサーバーに安全にアクセスするために使用されます。
imei_list string はい - 1つまたは複数のデバイスIMEI。
new_expiration string はい - デバイスの新しいユーザー有効期限。

レスポンス

キー 説明
code int リターンコード:
0:正常終了
その他:異常終了 エラーコードの説明を参照してください
message string コードが0でない場合、対応するエラーメッセージが表示されます
result string 返されたデータには、URL情報が含まれています。

正常終了の例:

{
  "code": 0,
  "message": "success",
  "result": [
    {
      "imei": "868120145233604",
      "update_result": "0",
      "update_msg": "update success"
},
{
      "imei": "868120145233605",
      "update_result": "1",
      "update_msg": "update failed, reason:xxxxxx"
    }

  ]
}
                    

異常終了の例:

{"code":xxx,"message":"Illegal device"}

デバイスの走行距離データの取得

説明

指定した時間範囲のデバイスの走行距離データを取得します。

リクエストURL

一意のリクエストURLを参照してください。Method = jimi.device.track.mileage

HTTPリクエストメソッド

POST

(1) 一般的なパラメータ

(2) 個人パラメータ



リクエストパラメータ

パラメータ 必須かどうか 備考 説明
access_token string はい - アクセストークン:正当なクライアントを識別するために使用されます。
imeis string はい - デバイスIMEI。コンマで区切ります。
形式:yyyy-MM-dd HH:mm:ss
begin_time number はい - 開始時間
形式:yyyy-MM-dd HH:mm:ss
end_time number はい - 終了時間
形式: yyyy-MM-dd HH:mm:ss
現在の時刻より前である必要があります
start_row number No - 結果セットの行番号。
page_size number No - 1ページに記録します。

レスポンス:

キー 説明
code int リターンコード:
0:正常終了
その他:異常終了 エラーコードの説明を参照してください
message string コードが0でない場合、対応するエラーメッセージが表示されます
result string 返されたデータ
imei string デバイスIMEI
startTime string 開始時間
endTime string 終了時間
startLat string 出発地の緯度。
startLng string 出発地の経度。
endLat string 目的地の緯度。
endLng string 目的地の経度。
runTimeSecond int 出発地から目的地までの経過時間(秒)。
distance Double 出発地から目的地までの距離(メートル)。
avgSpeed Double 平均速度

例:

{
  "code": 0,
  "message": "success",
  "result": [
{
 "imei": “3505831983422342”,
 "startTime": "2017-04-26 00:00:58",
 "endTime": "2017-04-26 00:03:58",
      "startLat": 22.577144898887813,
      "startLng": 113.91674845964586,
      "endLat": 22.677144898887813,
      "endLng": 113.92674845964586,
  
      "elapsed": 2130,
      "distance": 25000,
      "avgSpeed": 90
    }
  ]
}
              

デバイスの追跡データの取得

説明

3か月以内に、2日以内のデバイス追跡データを取得します。

リクエストURL

一意のリクエストURLを参照してください。Method = jimi.device.track.list

リクエストパラメータ

(1) 一般的なパラメータ

(2) 個人パラメータ


HTTPリクエストメソッド

POST

リクエストパラメータ

パラメータ 必須かどうか 備考 説明
access_token string Yes - アクセストークン:正当なクライアントを識別するために使用されます。
imei string Yes - 説明
begin_time number Yes - 開始時間
Format: yyyy-MM-dd HH:mm:ss
end_time number Yes - 終了時間
Format: yyyy-MM-dd HH:mm:ss
end_time should be earlier than current time
map_type string No - map_type=GOOGLEの場合、Googleキャリブレーションにより調整します。
map_type=nullの場合、原点の緯度と経度を返します。

レスポンス::

キー 説明
code int リターンコード:
0:正常終了
その他:異常終了 エラーコードの説明を参照してください
message string コードが0でない場合、対応するエラーメッセージが表示されます
result string 返されたデータ
lng double 経度
lat double 緯度
gpsTime string GPS測位時間。形式:yyyy-MM-dd HH: mm: ss
direction string 方向。極座標は真北から開始します。
gpsSpeed string GPS速度
posType string 1-GPS 2-LBS 3-WIFI
satellite string GPSアンテナ信号強度

正常終了の例:

{
  "code": 0,
  "message": "success",
  "result": [
    {
      "lat": 22.577144898887813,
      "lng": 113.91674845964586,
      "gpsTime": "2017-04-26 00:00:58",
      "direction": 0,
      "gpsSpeed": -1,
      "posType": 3
    },
    {
      "lat": 22.57708,
      "lng": 113.916631,
      "gpsTime": "2017-04-26 00:01:30",
      "direction": 184,
      "gpsSpeed": 0,
      "posType": 1
    }
  ]
}
                 

異常終了の例:

                    {"code":xxx,"message":"IMEI does not exist{353419031939627}"}
                    {" code ":xxx,"message":"The device has expired{353419031939627}"}
                    

IMEIによる車両情報の更新

説明

IMEIによる車両情報の更新

リクエストURL

一意のリクエストURLを参照してください。Method = jimi.open.device.update

HTTPリクエストメソッド

POST

リクエストパラメータ

(1) 一般的なパラメータ

(2) 個人パラメータ


パラメータ 必須かどうか 備考 説明
access_token string はい - アクセストークン:正当なクライアントを識別するために使用されます。
imei string はい - デバイスIMEI
device_name string いいえ - デバイス名
vehicle_name string いいえ - 車両名
vehicle icon string いいえ - 車両のアイコン
vehicle plate number string いいえ - ナンバープレート
vehicle_models string いいえ - ブランド
driver_name string いいえ - ドライバーの名前
driver_phone string いいえ - ドライバーの電話番号
device_status string いいえ - 0:無効 1:有効
デバイスを有効/無効にします。

レスポンス:

キー 説明
code int リターンコード:
0:正常終了
その他:異常終了 エラーコードの説明を参照してください
message string コードが0でない場合、対応するエラーメッセージが表示されます
result string 返されるデータは複数行になる場合があります。

正常終了の例:

{
  "code": 0,
  "message": "Vehicle information modification successful",
  "result": null
}
Wrong return example:
{"code":xxx,"message":"imei doesn’t exists"}

                 

車両のアイコン:

アイコンキー 説明
automobile 自動車
bus バス
per
mtc オートバイ
truck
taxi
plane
schoolBus
excavator
ship
tricycle
policeMtc 警察のオートバイ
tractor
policeCar
cow
other

デバイスの写真またはビデオのURLの取得

説明

カメラで撮影したデバイスの写真またはビデオのURLを取得します。

リクエストURL

一意のリクエストURLを参照してください。Method = jimi.device.media.URL

HTTPリクエストメソッド

POST

リクエストパラメータ

(1) 一般的なパラメータ

(2) 個人パラメータ


パラメータ 備考 説明
access_token string はい - アクセストークン:正当なクライアントを識別するために使用されます。
imei string はい - デバイスIMEI
camera string はい - 1:前面カメラ 2:内側カメラ
media_type string はい - 1:写真 2:ビデオ
start_time date No - 作成された写真またはビデオの開始時間。
end_time date No - 作成された写真またはビデオの終了時間。
token string No - 写真またはビデオにアクセスできるかどうかを検証するために使用されるトークン。
page_no int No - ゼロのインデックス。デフォルト値は0です。
page_size int No - デフォルト値は10行です。

レスポンス:

キー 説明
code int リターンコード:
0:正常終了
その他:異常終了 エラーコードの説明を参照してください
message string コードが0でない場合、対応するエラーメッセージが表示されます
result string 返されたデータ
thumb_URL string ビデオまたは写真のサムネイルのURL。
file_URL string ビデオまたは写真のURL。
mime_type string ビデオまたは写真のMIMEタイプ
create_time date ビデオまたは写真の作成時間。
media_type string 1:写真 2:ビデオ
camera string 0:前面カメラ 1:内側カメラ
file_size int 写真またはビデオのファイルサイズ。

正常終了の例:

{
  "code": 0,
  "message": "Operation successful",
  "result": 
[
{
      "thumb_URL": “Q9GLAFFqfCrYF6YfQAcON4w4Ezs=/lhWse7ie3wtFrjuQZ22dLAk5CSaR”,
      "file_URL": “357730090345670_3949477_2019_04_29_12_32_38_01”,
      "mime_type": "video/mp4",
      "create_time": 2019-04-29 10:32:43,
      "media_type": 2,
      "camera": 1,
      "file_size": 9949087
},
{
      "thumb_URL": “Q9GLAFFqfCrYF6YfQAcON4w4Ezs=/FhCrZEIy3518sR_ylOlqDg7w3Ju-”,
      "file_URL": “351609080120911_3949476_2019_04_29_18_32_12”,
      "mime_type": "video/3gpp",
      "create_time": 2019-04-29 10:32:42,
      "media_type": 2,
      "camera": 1,
      "file_size": 2411318
}

]
  

}
                 

異常終了の例:

{"code":xxx,"message":"imei doesn’t exists"}

デバイスのライブスチーミングページのURLの取得

説明

デバイスのライブストリーミングページのURLと最後の位置情報を取得します。

リクエストURL

一意のリクエストURLを参照してください。Method = jimi.device.live.page.url

HTTPリクエストメソッド

POST

リクエストパラメータ

(1) 一般的なパラメータ

(2) 個人パラメータ


パラメータ 必須かどうか 備考 説明
access_token string はい - アクセストークン:正当なクライアントを識別するために使用されます。
imei string はい - デバイスIMEI
V string いいえ - v=2の場合、トークンパラメータを提供する必要があります。Jimiサーバーはこのトークンを使用してURLを検証します。
token string いいえ - ライブ映像にアクセスできるかどうかを検証するために使用されるトークン。

レスポンス:

キー 説明
code int リターンコード:
0:正常終了
その他:異常終了 エラーコードの説明を参照してください
message string コードが0でない場合、対応するエラーメッセージが表示されます
result string 返されたデータ
lng double 経度
lat double 経度
gpsTime string GPS測位時間。形式:yyyy-MM-dd HH: mm: ss
direction string 方向。極座標は真北から開始します。
gpsSpeed string GPS速度
posType string 1-GPS, 2-LBS, 3-WIFI
satellite string GPSアンテナ信号強度
VIN string VIN
plateNo string ナンバープレート
UrlCamera string ライブストリーミングページのURL

正常終了の例:

{
  "code": 0,
  "message": "Vehicle information modification successful",
  "result": 
    {
      "lat": 22.577144898887813,
      "lng": 113.91674845964586,
      "gpsTime": "2017-04-26 00:00:58",
      "direction": 0,
      "gpsSpeed": -1,
      "posType": 3,
    	  "satellite": 11,
      "VIN":  "V12345",
      "plateNo":"ABC-12345",
      "UrlCamera": "https://www.domain.com/device/video/35408343202342345",
    }
  

}
                 

異常終了の例:

{"code":xxx,"message":"imei doesn’t exists"}

Wi-Fi、基地局の位置分析

説明

アカウントのデバイス総数で割り当てます(10回/日/デバイス、すべてのサブアカウントを含む)

リクエストURL

リクエストURLMethod = jimi.lbs.address.get

HTTPリクエストメソッド

POST

リクエストパラメータ

(1) 一般的なパラメータ

(2) 個人パラメータ


パラメータ 必須かどうか 備考 説明
access_token string Yes - アクセストークン:正当なクライアントを識別するために使用されます。
imei number Yes - デバイスIMEI
lbs number No - (WIFI/ LBS:少なくとも1つ)LBS情報グループ(mcc、mnc、lac、cell、rssi)、最大値は7です。各グループには5つありますが、nullにしてはならず、順番に並べ替えられます。MCC、中国:460
MNC
LAC情報、2312 23222
CELLコード:23222
RSSIセマフォ:70
wifi string No - (wifi/LBS:少なくとも1つ)
mac1,rssi1| mac2,rssi2
Macアドレス、間にコロンは必要ありません
Rssi信号強度

レスポンス:

キー 説明
code int リターンコード:
0:正常終了
その他:異常終了 エラーコードの説明を参照してください
message string コードが0でない場合、対応するエラーメッセージが表示されます
result string 返されたデータ
lng string 経度
lat string 緯度
accuracy string 精度。値が大きいほど良いです。
direction string 方向。極座標は真北から開始します。

正常終了の例:

{
"code": 0,
"message": "success",
"result": {
  "lat": 40.65615416521587,
  "lng": 109.89894039833524,
  "accuracy": 0
}
}
                 

異常終了の例:

{"code":xxx,"message":"illegal device"}

IMEIのジオフェンスの作成

説明

IMEIのジオフェンスの作成

リクエストURL

一意のリクエストURLを参照してください。Method = jimi.open.device.fence.create

HTTPリクエストメソッド

POST

リクエストパラメータ

(1) 一般的なパラメータ

(2) 個人パラメータ


パラメータ 必須かどうか 備考 説明
access_token string はい - アクセストークン:正当なサードパーティーを識別するために使用されます
imei string はい - デバイスIMEI
fence_name string はい - ジオフェンスの名前
alarm_type string はい - アラームの種類(入る/出る/出入り)
report_mode string はい - アラームレポートモード。0:GPRS 1:SMS+GPRS
alarm_switch string はい - フェンスアラームスイッチ(オン/オフ)
lng string はい - 経度
lat string はい - 緯度
radius string はい - フェンス半径(1〜9999、単位:100メートル)
zoom_level string はい - ズームレベル(3~19)
map_type string はい - マップ(GOOGLE)

レスポンス:

キー 説明
code int リターンコード:
0:正常終了
その他:異常終了 エラーコードの説明を参照してください
message string コードが0でない場合、対応するエラーメッセージが表示されます
result string 返されたデータ. Fence serial number returned if succeed.

正常終了の例:


{
"code": 0,
"message": "Successfully create geo-fence.",
"result": "5"
}
Wrong return example:
{
"code": 41003,
"message": "Device is not online, geo-fence creation failed ",
"result": null
}
                 

デバイスのジオフェンスの削除

説明

デバイスのジオフェンスの削除

リクエストURL

一意のリクエストURLを参照してください。Method = jimi.open.device.fence.delete

HTTPリクエストメソッド

POST

リクエストパラメータ

(1) 一般的なパラメータ

(2) 個人パラメータ


パラメータ 必須かどうか 備考 説明
access_token string はい - アクセストークン:正当なサードパーティーを識別するために使用されます
imei string はい - デバイスIMEI
instruct_no string はい - ジオフェンスコマンドのシリアル番号

レスポンス:

キー 説明
code int リターンコード:
0:正常終了
その他:異常終了 エラーコードの説明を参照してください
message string コードが0でない場合、対応するエラーメッセージが表示されます
result string 返されたデータ

正常終了の例:

{
"code": 0,
"message": "delete the geo-fence successfully",
"result": null
}
                 

異常終了の例:

{
"code": 41003,
"message": "The device is not online and geo-fence can’t be deleted",
"result": null
}
                

デバイス対応のコマンドリストの取得

説明

デバイスでサポートされているコマンドリストを取得します

リクエストURL

一意のリクエストURLを参照してください。Method = jimi.open.instruction.list

HTTPリクエストメソッド

POST

リクエストパラメータ

(1) 一般的なパラメータ

(2) 個人パラメータ


パラメータ 必須かどうか 備考 説明
access_token string Yes - アクセストークン:正当なサードパーティーを識別するために使用されます
imei string Yes - デバイスIMEI

レスポンス:

キー 説明
code int リターンコード:
0:正常終了
その他:異常終了 エラーコードの説明を参照してください
message string コードが0でない場合、対応するエラーメッセージが表示されます
result string 結果
id string コマンドコード
orderName string コマンド名
orderContent string コマンドテンプレート
orderExplain string コマンドの説明
orderMsg string プロンプト
isOffLine string オフラインコマンドをサポートするかどうか。0:いいえ 1:はい

正常終了の例:

{
"code": 0,
"message": "success",
"result": [
  {
    "id": 81,
    "orderName": "SOS setting",
    "orderContent": "SOS,A,{0},{1},{2}#",
    "orderExplain": "SOS is used for receive alerts and SOS alerts. SOS number should have 3-20 numbers.",
    "orderMsg": "",
    "isOffLine": "1"
  }
  ...
]
}
                 

異常終了の例:

{"code":xxx,"message":"Illegal device"}

コマンドのデバイスへの送信

説明

コマンドをデバイスに送信します。

リクエストURL

リクエストURLMethod = jimi.open.instruction.send

HTTPリクエストメソッド

POST

リクエストパラメータ

(1) 一般的なパラメータ

(2) 個人パラメータ


パラメータ 必須かどうか 備考 説明
access_token string Yes - アクセストークン:正当なサードパーティーを識別するために使用されます
imei string Yes - デバイスIMEI
inst_param_json string Yes - コマンドメッセージのjson文字列

inst_param_jsonの説明:

パラメータ 必須かどうか 備考 説明
inst_id string はい - コマンドコード
inst_template string はい - コマンドテンプレート
params array はい - コマンドparams文字列の配列
is_cover boolean NO false 既存のオフラインコマンドをカバーするかどうか。true:カバーする false:カバーしない

例:

{"inst_id": "113","inst_template":"RELAY,1#","params":[],"is_cover":"true"}
{"inst_id": "114","inst_template":"RELAY,0#","params":[],"is_cover":"true"}
                 

ユーザー定義コマンド:

{"inst_id": "96","inst_template":"{0}","params":["STATUS#"],"is_cover":"true"}

レスポンス:

キー 説明
code int リターンコード:
0:正常終了
その他:異常終了 エラーコードの説明を参照してください
message string コードが0でない場合、対応するエラーメッセージが表示されます
result string 結果

正常終了の例:

{
  "code": 0,
  "message": "command is successfully sent.",
  "result": null
}

                 

異常終了の例:

{
  "code": 12005,
  "message": "Fail to send command. Result code:226",
  "result": null
}

               

コマンドの実行結果の取得

説明

コマンドの送信結果を取得します。

リクエストURL

一意のリクエストURLを参照してください。Method = jimi.open.instruction.result

HTTPリクエストメソッド

POST

リクエストパラメータ

(1) 一般的なパラメータ

(2) 個人パラメータ


パラメータ 必須かどうか 備考 説明
access_token string はい - アクセストークン:正当なサードパーティーを識別するために使用されます
imei string はい - デバイスIMEI

レスポンス:

レスポンス: 説明
code int リターンコード:
0:正常終了
その他:異常終了 エラーコードの説明を参照してください
message string コードが0でない場合、対応するエラーメッセージが表示されます
result string 返されたデータ
codeId string コマンドコード
code string コマンド送信
content string デバイスから返信された内容
isExecute string コマンドステータス。0:実行に失敗しました 1:実行に成功しました 3:送信待ち 4:キャンセルしました
isOffLine string 時間。形式:yyyy-MM-dd HH:mm:ss
sender string 送信元
receiveDevice string 受信したIMEI
isOffLine string 0:オンライン 1:オフライン
idsource string コマンドの説明

正常終了の例:

{
  "code": 0,
  "message": "success",
  "result": [
    {
      "codeId": "99",
      "code": "status#",
      "content": "Parameter error",
      "isExecute": "4",
      "sendTime": "2017-06-19 11:46:00",
      "sender": "jimitest",
      "receiveDevice": "868120111111117",
      "isOffLine": "1",
      "idsource": "User-defined command"
    }
  ]
}
                 

異常終了の例:

{"code":xxx,"message":"Illegal device"}

通知の受信

説明

サードパーティのプラットフォームは、通知を受信するためのURLアドレスを提供する必要があります(JIMIに連絡してURLを手動で提供してください)。JIMIサーバーは、このURLを使用してHTTPリクエストを送信することで、通知をプッシュします。

メッセージサービスリスト

メッセージの種類 説明
jimi.push.device.alarm Alarm data

リクエスト内容

キー 説明
msgType string メッセージの種類。メッセージサービスリストに該当します。 list
data string メッセージの内容。msgTypeに該当します。

メッセージの内容(jimi.push.device.alarm)

プッシュアラームは以下の通りです。


キー
Type string デバイスIMEI
deviceName string 文字列
alarmType string アラームタイプ
alarmName string アラームの名前
lat string 緯度
lng string 経度
alarmTime string アラーム時間。形式: (yyyy-MM-dd HH: mm: ss)

例:

Parameter1:
Key = msgType
Value = jimi.push.device.alarm

Parameter2:
Key = data
Value =  {
    "imei": "868120145233604",
    "deviceName": "868120145233604",
    "alarmType": "2",
    "alarmName": "Power off alarm",
    "lat": 40.65615416521587,
    "lng": 109.89894039833524,
    "alarmTime": "2017-05-08 12:00:00"
  }
                 

デバイスアラームリストの取得

説明

デバイスアラームリストを取得します。
検索条件の期間は1か月以内である必要があります。
最大1000行を返します。

リクエストURL

一意のリクエストURLを参照してください。Method = jimi.device.alarm.list

HTTPリクエストメソッド

POST

リクエストパラメータ

(1) 一般的なパラメータ

(2) 個人パラメータ


パラメータ 必須かどうか 備考 説明
access_token string はい - アクセストークン:正当なサードパーティーを識別するために使用されます
imei string はい - デバイスIMEI
alertTypeId string いいえ - alertTypeIdを指定しない場合、すべてのアラートタイプが返されます。
begin_time date いいえ - begin_timeとend_timeを指定しない場合、過去1か月において最新の50件のアラートが返されます。
end_time date いいえ -

レスポンス:

キー 説明
code int リターンコード:
0:正常終了
その他:異常終了 エラーコードの説明を参照してください
message string コードが0でない場合、対応するエラーメッセージが表示されます
result string 返されたデータ
DeviceName Device Name コマンドコード
IMEI string IMEI
model string デバイスモデル
account string アカウント
account string アカウント
account string アラートの種類
alertTime string アラート時間
positioningTime string アラート特定の時間
lng double 経度
lat double 緯度

正常終了の例:

{
  "code": 0,
  "message": "success",
  "result": [
    {
      "deviceName": "ABC-34352",
      "IMEI": "343503422910345",
      "model": "GT06N",
      "account": "test1234",
      "alertTypeId": "1002",
      "alertType": "ACC On",
      "alertTime": "2019-03-14 14:02:03",
      "positioningTime": "2019-03-14 14:02:03",
      "lat": 22.577144898887813,
      "lng": 113.91674845964586
    }
  ]
}
                 

異常終了の例:

{"code":xxx,"message":"Illegal device"}

コマンドの送信(スクーターデバイス)

説明

コマンドをスクーターデバイスに送信します。

リクエストURL

一意のリクエストURLを参照してください。Method = jimi.scooter.instruction.send

HTTPリクエストメソッド

POST

リクエストパラメータ

(1) 一般的なパラメータ

(2) 個人パラメータ


パラメータ 必須かどうか 備考 説明
access_token string はい - アクセストークン:正当なサードパーティーを識別するために使用されます
imei string はい - デバイスIMEI
cmd_code string はい - コマンドをデバイスに送信します。例:
スクーターを有効にするには、cmd_codeを ENABLE#に設定します。スクーターをロックするには、cmd_codeをLOCK#に設定します。注意:「#」が必要です。

レスポンス:

キー 説明
code int リターンコード:
100:操作に成功しました
200:無効なパラメータ
300:デバイスはオフラインです
301:未登録のデバイス
400:ネットワーク利用不可
600:HTTPリクエストがタイムアウトしました
message string コマンド出力の送信の説明。/td>

成功例:

{
  "code": 100,
  "message": "Success"
}
                 

失敗例:

{
  "code": 200,
  "message": "Invalid parameter"
}
               

スクーターの詳細情報の取得

説明

デバイスの詳細情報とステータスを取得します。

リクエストURL

一意のリクエストURLを参照してください。Method = jimi.scooter.device.detail

HTTPリクエストメソッド

POST

リクエストパラメータ

(1) 一般的なパラメータ

(2) 個人パラメータ


パラメータ 必須かどうか 備考 説明
access_token string はい - アクセストークン:正当なサードパーティーを識別するために使用されます
imei string はい - スクーターのIMEI。複数のスクーターがある場合は、コンマで区切ります。たとえば、「350583223422451,350583223422452」です。

レスポンス:

キー 説明
code int リターンコード:
0:正常終了
その他:異常終了 エラーコードの説明を参照してください
message string コードが0でない場合、対応するエラーメッセージが表示されます
result string 返されたデータ(json)

結果リスト:

キー 説明
deviceImei string IoTモジュールのIMEI
realtimeStatus json DLCC DLCC状態
0-オフ
1-オン
brake ブレーキ状態
0-オフ
1-オン
settingBrakeLight ブレーキライト状態の設定
0-オフ
1-オン
settingFrontLight フロントライト状態の設定
0-オフ
1-オン
realFrontLight realFrontLightフロントライトの状態
0-オフ
1 - ON
realBrakeLight ブレーキライト状態の設定
0-オフ
1-オン
charge 充電状態
0-オフ
1-オン
acceleratorStatus 0-オフ
1-オン
motoStatus 0-オフ
1-オン
workingMode 運転モード。
0-故障モード
1-ロックモード
2-有効化モード
3-充電モード
4-メンテナンスモード
realtimeData json batteryLevel バッテリー残量。たとえば、バッテリー残量が50%の場合、batteryLevelの値は50です。
current 出力電流
speed 速度(ホール)
voltage バッテリー電圧
batteryCycle バッテリーサイクル
totalOdometer 総走行距離
currentOdometer 現在の旅の走行距離(無効前)。
batteryTemperature °C
remainingMileage 残りの走行距離
scooterProperties json ECUVersion ECUバージョン
batteryCapacity バッテリー容量
batteryVoltage スクーター定格電圧
firmwareVersion ファームウェアのバージョン
scooterVersion スクーターのバージョン
speedLimit スクーターの最高速度
IoT 0-OK 1-エラー
scooterError json
accelerator 0-OK 1-エラー
battery 0-OK 1-エラー
brakeHandlebar 0-OK 1-エラー
controller 0-OK 1-エラー
dashboard 0-OK 1-エラー
voltage 0-OK 1-エラー
Motor 0-OK 1-エラー
IoTModule json gpsStatus 0-GPS利用不可
1-GPS測位
course 測位の方向
satellite 衛星番号
gpsSpeed 速度
gpsTime 測位時間
positioningType GPS
LBS WIFI
Latitude 緯度
gsmSignal 0-信号なし
1-非常に弱い
2-弱い
3-強い
4-非常に強い
mCC mCC
mNC mNC
BluetoothMac 文字列
iccid 文字列
imsi 文字列
batteryVoltage バッテリーの電圧

正常終了の例:

{
  "code": 0,
  "msg": "Operation success.",
  "result": 
    {
      "deviceImei": "860425040472944",
      "scooterError": {
        "IoT": 0,
        "accelerator": 0,
        "battery": 0,
        "brakeHandlebar": 0,
        "controller": 0,
        "dashboard": 0,
        "motor": 0,
        "voltage": 0
      },
      "scooterProperties": {
        "ECUVersion": "0.1",
        "batteryCapacity": 22834,
        "batteryVoltage": 36,
        "bluetoothVersion": "2.1",
        "firmwareVersion": "c.0",
        "scooterVersion": "3.0",
        "speedLimit": 50
      },
      "realtimeData": {
        "totalOdometer": 14592,
        "batteryCycle": 512,
        "batteryLevel": 56,
        "batteryTemperature": 23,
        "current": 614.39,
        "currentOdometer": 217.6,
        "remainingMileage": 69.2,
        "speed": 99.86,
        "voltage": 460.94
      },
      "realtimeStatus": {
        "DLCC": 0,
        "DLCCStatus": 0,
        "acceleratorStatus": 0,
        "brake": 0,
        "settingBrakeLight": 1,
        "charge": 0,
        "settingFrontLight": 0,
        "realFrontLight": 0,
        "motoStatus": 0,
        "realBrakeLight": 0,
        "workingMode": 0
      },
      "drivingSetting": {
        "DLCC": 0,
        "drivingMode": 2,
        "lightMode": 0,
        "quickStart": 1,
        "speedLimit": 30,
        "speedUnit": 0
      },
      "IoTModule": {
        "imsi": "0460045394000271",
        "iccid": "89860433231880390271",
        "BluetoothMac": "000000000000",
        "satellite": 11,
        "course": 0,
        "gpsMode": 0,
        "gpsSpeed": 0,
        "gpsTime": "2019-05-09 18:41:12",
        "lAC": 0,
        "latitude": 22.577137,
        "longitude": 113.916756,
        "mCC": 0,
        "mNC": 0,
        "positioningType": "GPS",
        "gsmSignal": 4,
        "gpsStatus": 0,
        "batteryVoltage": 4.15
      }
    }
}
                 

正常終了の例:

{"code":xxx,"message":"Illegal device"}