- info@ntechgps.in
- C-217, 2nd Floor, Sector -63, Noida - 201301. Uttar Pradesh. INDIA
Get In Touch
880-073-5004
Overview
N-Tech Open API empowers distributors and application vendors to provide tracking services to their customers by using their own GUI, app, and web clients, so they can localize their services and improve user experience.
Your App or web client should connect to your application server, rather than connect to JIMI API Server directly , use your application server connect to JIMI Server instead.
Usage
1. Contact us to apply your appKey and appSecrect, you need to provide your account.
2. According to this document to implement your application server to obtain access_token.
3. Calling other interfaces with access_token to fulfil your business logic.
Conventions
Encoding, Format & Timezone
API Work Flow
API Description
Request URL
The unique request URL is: http://open.10000track.com/route/rest
Different interfaces are identified by request parameter method.
Security
Client should get access_token first before calling the interface, which is generated by JIMI Server by calling jimi.oauth.token.get interface(method=jimi.oauth.token.get) with provided appKey and appSecrect.
appKey and access_token are required to sign request parameters when calling API. JIMI server will validate the the request parameters by checking the sign value.
Common parameterss
The parameters of each request should include Common parameterss and interface private parameters. For example, if you call the “jimi.oauth.token.get” interface, you need to provide :
7(Common parameterss) + 3(private parameters) = 10 (parameters, key/value)
| Name | Type | Required | Description | Remark | Default |
|---|---|---|---|---|---|
| method | string | Yes | API interface name | ||
| timestamp | string | Yes | Timestamp, format:yyyy-MM-dd HH:mm:ss. Plus or minus10 minutes is allowed. e.g:2012-03-25 20:00:00 | GMT(UTC) time. | |
| app_key | string | Yes | APP_KEY | from JIMI | |
| sign | string | Yes | A signature base on parameters, appKey, appSecrect. | ||
| sign_method | string | Yes | Optional,signature method. Available value: md5, support methods are: md5 | ||
| v | string | Yes | Optional, specify the API version. System default 1.0, support version: 1.0 | >md5 | >md5 |
| System default 1.0, support version: 0.9, 1.0 | 1.0: check signature | ||||
| format | string | Yes | Optional, specify response format. | json |
Signature
To protect API calling from hacked, any API calling needs to be with a signature. JIMI server will check signature based on request parameters. Illegal signature request will be rejected. Signature algorithms supported is: md5 (sign_method is a Common parameters mentioned above). Following is the algorithm of signature:
1. Sort all request parameters with parameter key in alphabetical order (including Common parameterss and method specific parameters, but NOT include sign and byte type parameter.
For example:
foo=1, bar=2, foo_bar=3, foobar=4
Result: bar=2, foo=1, foo_bar=3, foobar=4
2. Remove all equal sign and comma:
bar2foo1foo_bar3foobar4
3. Then concatenate appSecrect to the before and end of the result string and get the md5 value. E.g：
md5(<appSecrect>+bar2foo1foo_bar3foobar4+<appSecrect>), the real string should like: md5(h9lri085eachcz4sn7gwnkh6j0jt0yz4bar2foo1foo_bar3foobar4h9lri085eachcz4sn7gwnkh6j0jt0yz4)
Note that the string should be in UTF-8 encoding.
Note that the sign should be upper case string.
If the parameter value is a byte stream, it should be converted to hexadecimal. For example：hex(“helloworld”.getBytes(“utf-8”)) = “68656C6C6F776F726C64”
MD5 is the 128-bit summary algorithm and is in hexadecimal. a hexadecimal character can represent four bits, so the signature string length is 32 hexadecimal characters.
Get access token
Description
Client(distributor’s server) should stored the access_token locally, do NOT get access_token per request, instead, use the local access_token before it become invalid. N-Tech server will not allow to access if the request frequency is too high from client.
The access token can be used for about 2 hours(depend on the value for expires_in parameter), do NOT try to get token for every request.
Request URL
See the unique request URL.Method = https://n-techservices.com/
HTTP request method
POST
Request parameter
(1) Common parameters
(2) Private parameters
| Name | Type | Required | Description | Remark | Default |
|---|---|---|---|---|---|
| user_id | string | Yes | User ID | User’s account | |
| user_pwd_md5 | string | Yes | user’s password (md5) | Lowercase md5 value | |
| expires_in | number | Yes | access token expired seconds | 60-7200 |
Response
| Key | Type | Description |
|---|---|---|
| code | int | Return code: 0: return correctly Other: failure. Refer to the error code description |
| message | string | If code is not 0, there will be a corresponding error message |
| result | string | Result |
| accessToken | string | Access token, required by any other following interfaces |
| expiresIn | string | Access token expired seconds |
| account | string | User’s account |
| appKey | string | AppKey from N-Tech |
| refreshToken | string | Refresh token, which is used for updating accessToken |
| time | string | Token generated time |