Sunteți pe pagina 1din 66

The TripleSat Constellation Server

System API specification

Twenty First Century Aerospace Technology Co., Ltd


Contents

1. OVERVIEW......................................................................................................................................3

1.1. INTRODUCTION..................................................................................................................3
1.2. SCOPE OF APPLICATION.....................................................................................................3
1.3. INTERFACE STANDARDS.....................................................................................................3

2. API LIST..........................................................................................................................................3

2.1. REQUEST FORMAT.............................................................................................................3


2.2. PARAMETERS DEFINITION..................................................................................................4
2.3. API LIST............................................................................................................................4

3. GENERAL APIS..............................................................................................................................6

3.1. CLIENT APIS.....................................................................................................................6


3.1.1. User Authentication API..................................................................................................6
3.1.2. Change User Password API.............................................................................................9
3.2. PRODUCT APIS................................................................................................................10
3.2.1. TripleSat Catalog Retrieval API.....................................................................................10
3.2.2. TripleSat Catalog Details Retrieval API........................................................................32
3.3. BILLING APIS..................................................................................................................42
3.3.1. Archive Data Order API.................................................................................................42
3.3.2. Tasking Data Order Billing API.....................................................................................44
3.4. ORDERING API................................................................................................................45
3.4.1. Submit Archive Data Order API.....................................................................................45
3.4.2. Submit Tasking Data Order API.....................................................................................56
3.4.3. Get Order List API.........................................................................................................68
3.4.4. Get Order Details API....................................................................................................71
3.4.5. Delete Order API............................................................................................................77
3.4.6. Cancel Order API...........................................................................................................78
3.4.7. Confirm Order API.........................................................................................................79
3.4.8. Order Delivery API........................................................................................................81
3.4.9. Order Feedback API.......................................................................................................82
3.5. MISSION PLANNING API.................................................................................................84
3.5.1. Satellite Orbit Information Request API........................................................................84

4. AUTHORIZATION AND LEGAL TERMS...............................................................................86

5. APPENDIX....................................................................................................................................86

5.1. CODING TABLE................................................................................................................86


5.1.1. Return message coding...................................................................................................86
1. Overview

1.1. Introduction

This manual is an integrated document for the API of the TripleSat constellation
service system developed by the 21st century Aerospace Technology Co., Ltd. The
main users are system interface developers.

1.2. Scope of Application

This manual defines the APIs, method definitions and implementation rules provided
by the TripleSat constellation service system.

1.3.Interface standards
Comply with a unified agreement and service standards, unified use of restful
interface.

2. API list

Please contact 21st century Aerospace Technology Co., Ltd to apply APPKEY and
authorization when you get this API document. Once you receive the authorization,
you can call the API through standard format.

2.1. Request Format

https://www.21at.net/ATCenter/Service/dataSync?

Version=1.2&Action=packageSpace&Method=method&AppKey=client id&UserKey=customer

information&TimeStamp=time stamp&Req=request json string&Signature=encrypted

string&Language=language

3
2.2. Parameters definition

Request parameters

Parameter Name Field Name Compulsory? Explanation


Version The version number Yes Request version number
Action Package space of the Yes
execution mathod
Method name of the request method Yes
AppKey Client identity Yes
UserKey Customer information No {id:,ip:}Base64 encryption
Choose whether to pass according to
the situation
TimeStamp The current request token Yes can be the current time, with format of
ms.
Req Request paramters Yes The parameter json string to be passed
Signature Encrypted string Yes generated in the client side by
algorithm with parametners of Version,
Action, Method, AppKey, TimeStamp
and authorization private key
Language language No Return data language
zh=zh_CN,en=en_US

2.3. API list

Seri Interface Interface description input output


al name
No.
1 User Using username and password User name, password, Status information
Authentication (MD5 encrypted) to login to IP
API system
2 Change User Change user password. It is to Old password, new Status information
Password API be noted that the accuracy of password
the new password is checked in
the client side system
3 TripleSat Get the catalog of the TripleSat space range, shooting Data list
Catalog data. The contents include time, satellite, off-
Retrieval API satellite id, cloud coverage point angle, cloud
ratio, off-point angle, coverage ratio and so
thumbnail image and so on. on
Page and attribute sorting is

4
supported.

4 TripleSat Get detailed information of the Scene number Scene data details
catalog details requested scene data. The
retrieval API content includes sence number,
satellite id, sensor, thumbnail
image, start time, end time,
lon/lat of center point, cloud
coverage ratio, off-point angle,
sun azimuth, sun elevation and
so on
5 Archive data This interface provides price of Spatial information, Price information
order billing orders for archived data. The area, number of
API returned total price and authorized users, data
discounts will be based on the identification
spatial information, area,
number of authorized users and
scene number and so on.
6 Tasking data This interface provides price of Spatial information, Price information
order billing orders for tasking data (data area, number of
API that is not in archive). The authorized users, data
returned total price and identification, product
discounts will be based on the level, cloud coverage
spatial information, area, ratio
number of authorized users,
cloud coverage and so on.
7 Submit This interface is for submission Data identification, Status information
Archive Data of orders for archived data. The customer information,
Order API content includes data price information,
identification, customer production parameter,
information, product order information
processing parameter, price
information, order information
and so on.
8 Submit This interface is for submission Tasking information, Status information
Tasking Data of orders for tasking data. The customer information,
Order API content includes tasking price information,
parameters, customer production parameter,
information, product order information
processing parameter, price
information, order information
and so on.

5
9 Get Order List Get order list based on certain Time, status, order Order list
API criteria. The returned order list type
contains order AOI name,
order time, price information,
area information, order type,
order status and so on.
10 Get Order Get order details based on Order number Order details
Details API order number. The returned
order detail contains order
information, price information,
tracking information,
production parameters and so
on.
11 Delete Order Delete order based on order Order number Status information
API number and return the status
12 Cancel Order Cancel order based on order Order number Status information
API number and return the status
13 Confirm Order Set order status as completed Order number Status information
API based on order number and
return the status
14 Order Delivery Client request through this Order number Delivery
API interface to get the deliverable information
data from the current central
end
15 Order Feedback for delivered data Order number Status information
Feedback API
16 Get satellite Get satellite TLE No Satellite TLE
TLE API

6
3. General APIs

3.1. Client APIs

3.1.1. User Authentication API

3.1.1.1.Description

The user authentication interface shall be called to log on before the client could send request to

other interfaces.

3.1.1.2.Interface Rules

Details on interface type, input request parameters and output response result parameters are as in
list:
API name User Authentication API
Method to call Http Request
URL Version=1.2&Action=customer_v_1_1&Method=login&AppKey=100
&UserKey=&TimeStamp=10000&Req={?}
&Signature=EncryptedString&Language=language
API type Synchronous
Input request parameters User information, client information, etc.3.1.1.2.
Output response result Status of logon, successfully or failed.
Frequency of request None

3.1.1.3.Parameter Rules

3.1.1.3.1. Request Parameter List

The request parameter string shall be concatenated by user information and client information.

Pass this string to call this method.

An example is as shown below

Req={"userPwd":"DC483E80A7A0BD9EF71D8CF973673924","userName":"demo","ip":"172.

172.3.76"}

7
Parameter description:

Parameter Name Field Name Description


userName User Name
userPwd Password md5 String
ip IP Address

3.1.1.3.2. Response Result

The response result is of a type of json string. An example is as shown below

{"status":"100","data":
{"endtime":"","relationphone":"","starttime":"","fax":,"wkt":,"userid":"","usertype":"agent","lang":
"zh_cn","relationuser":"","balance":,"username":"","address":,"email":"","orgname":"","proid":"
"},"msg":null}

Parameter description:

Parameter Name Field Name Description


endtime Balance expiring time
relationphone Contact number
starttime Balance start time
fax Fax number
wkt Scope of business
userid User ID
usertype Type of user Agent customer
lang Langurage
relationuser Point of contact
balance Balance
username User name
email Email address
orgname User organization name
proid Balance ID

3.1.2. Change User Password API

3.1.2.1.Description

Change the password of the administrator account of the client. The old password must be

provided and correct.

8
3.1.2.2.Interface Rules

Details on interface type, input request parameters and output response result parameters are as in

list:

API name Change User Password API


Method to call Http Request
URL Version=1.2&Action=customer_v_1_1&Method=updatePwd&
AppKey=100&UserKey=&TimeStamp=10000&Req={?}
&Signature= EncryptedString&Language=language
API type Synchronous
Input request User ID, old password, new password
parameters
Output response Result of change, successfully or failed.
result
Frequency of None
request

3.1.2.3.Parameter Rules

3.1.2.3.1. Request Parameter List

The request parameter string shall be concatenated by user ID, the old password and the new

password. Pass this string to call this method.

An example is as shown below

Req={ oldPassword:, newPassword: }


Parameter description:

Parameter Name Field Name Description


oldPassword Old password MD5 encrypted
newPassword New password MD5 encrypted

3.1.2.3.2. Response Result

The response result is of a type of json string. An example is as shown below

{ status :100,msg:}

9
3.2. Product APIs

3.2.1. TripleSat Catalog Retrieval API

3.2.1.1.Description

Base on user input retrieval condition, the front end format the condition parameters and call the

method to retrieve data result and response to the front end.

3.2.1.2.Interface Rules

Details on interface type, input request parameters and output response result parameters are as in

list:

API name TripleSat Catalog Retrieval API


Method to call Http Request
URL Version=1.2&Action=search_v_1_1&Method=search&AppKey=100
&UserKey={?}&TimeStamp=10000&Req={?}
&Signature= EncryptedString&Language=language
API type Asynchronous
Input request Retrieval condition, client information, etc.
parameters
Output response Result of retrieval, successfully or failed, and data result
result
Frequency of request None

3.2.1.3.Parameter Rules

3.2.1.3.1. Request Parameter List

The request parameter string shall be concatenated by retrieval condition, client information, etc.

Pass this string to call this method.

An example is as shown below:

Req= {
"condition": [
{
"id": "fgeometry",

1
0
"name": "realwkt",
"val": "",
"datatype": "geometry",
"relation": "wkt"
},
{
"id": "centertime",
"name": "startDate",
"val": "2016-01-13",
"datatype": "date",
"relation": "greater_equal"
},
{
"id": "centertime",
"name": "endDate",
"val": "2016-10-13",
"datatype": "date",
"relation": "less_equal"
},
{
"id": "resolution",
"name": "startResolution",
"val": null,
"datatype": "number",
"relation": "greater_equal"
},
{
"id": "resolution",
"name": "endResolution",
"val": null,
"datatype": "number",
"relation": "less_equal"
},
{
"id": "cloudcover",
"name": "startCloudcover",
"val": null,
"datatype": "number",
"relation": "greater_equal"
},
{
"id": "cloudcover",
"name": "endCloudcover",

1
1
"val": null,
"datatype": "number",
"relation": "less_equal"
},
{
"id": "rollangle",
"name": "startRollangle",
"val": null,
"datatype": "number",
"relation": "greater_equal"
},
{
"id": "rollangle",
"name": "endRollangle",
"val": null,
"datatype": "number",
"relation": "less_equal"
},
{
"id": "satellite",
"name": "satellite",
"val": null,
"datatype": "string",
"relation": "equal"
},
{
"id": "id",
"name": "dataIds",
"val": null,
"datatype": "string",
"relation": "equal"
}
],
"orderby": [
{
"id": "centertime",
"by": "desc"
},
{
"id": "cloudcover",
"by": "asc"
},
{

1
2
"id": "rollangle",
"by": "asc"
},
{
"id": "satellite",
"by": "asc"
}
],
"page": {
"pageNo": "1",
"pageSize": "100"
}
}
Parameter description:

Parameter Name Field Name Description


realwkt Geometry information Geometry information includes
geometry information type,
name and value. Data type is
geometry, value is wkt.
Value is geometry string,
coordination system is WGS84;
dataIds Scene ID Scene IDseparated by Enter
or , max 100 IDs.
time Time period Start time and end time. Can
fill in one or leave blank.
resolution Resolution range Min and max resolutions.
cloudCover Cloudy cover range Max and min cover
rangesearch data in range.
rollangle Roll angle range Max and min roll angle
rangesearch data in range.
productType Type of product Array of types of product,
search data with the type in the
array.
satellite Satellite names Array of satellite names.
Search data with the satellite
names in the array
orderby Sorting priority Sort result by order as in the
array. Sorting by property.
desc is descending asc is
ascending

1
3
3.2.1.3.2. Response Result

The response result is of a type of json string. An example is as shown below

{
"status": "100",
"data": {
"ndateTwo": null,
"ndateOne": null,
"count": 2,
"condition": {
"satellite": [
"TripleSat Constellation-1"
],
"rollangle": {
"min": "-3.556756",
"max": "-3.556353"
},
"cloudcover": {
"min": "53.2",
"max": "54.1"
},
"centertime": {
"min": "2016-03-20 03:30:22.163043",
"max": "2016-03-20 03:30:25.473549"
}
},
"root": [
{
"id": "fgeometry",
"fieldType": "wkt",
"value": "",
"showType": "hidden"
},
{
"id": "thumbimg",
"fieldType": "image",
"value": "",
"showType": "hidden"
},
{
"id": "id",
"fieldType": "text",
"value": "",

1
4
"showType": "hidden"
},
{
"id": "satellite",
"fieldType": "text",
"value": "",
"showType": "show"
},
{
"id": "cloudcover",
"fieldType": "text",
"value": "(%)",
"showType": "show"
},
{
"id": "rollangle",
"fieldType": "text",
"value": "",
"showType": "show"
},
{
"id": "centertime",
"fieldType": "time",
"value": "(UTC+8)",
"showType": "show"
},
{
"id": "resolution",
"fieldType": "text",
"value": "",
"showType": "hidden"
},
{
"id": "transformimg",
"fieldType": "image",
"value": "",
"showType": "hidden"
},
{
"id": "browserimg",
"fieldType": "image",
"value": "",
"showType": "hidden"

1
5
},
{
"id": "centerlongitude",
"fieldType": "number",
"value": "",
"showType": "hidden"
},
{
"id": "centerlatitude",
"fieldType": "number",
"value": "",
"showType": "hidden"
},
{
"id": "toprightlatitude",
"fieldType": "text",
"value": "",
"showType": "hidden"
},
{
"id": "toprightlongitude",
"fieldType": "text",
"value": "",
"showType": "hidden"
},
{
"id": "bottomrightlatitude",
"fieldType": "text",
"value": "",
"showType": "hidden"
},
{
"id": "bottomrightlongitude",
"fieldType": "text",
"value": "",
"showType": "hidden"
},
{
"id": "bottomleftlatitude",
"fieldType": "text",
"value": "",
"showType": "hidden"
},

1
6
{
"id": "bottomleftlongitude",
"fieldType": "text",
"value": "",
"showType": "hidden"
},
{
"id": "topleftlatitude",
"fieldType": "text",
"value": "",
"showType": "hidden"
},
{
"id": "topleftlongitude",
"fieldType": "text",
"value": "",
"showType": "hidden"
}
],
"pageNo": 1,
"geomCover": {
"param": {
"cql_filter": " ",
"bbox":
"75.6826095581055,13.0503063201904,144.999923706055,56.5200004577637",
"layers": "ATCenter:ds_product_imagery",
"format": "image/png"
},
"type": "wms",
"url": "http://../geoserver/ATCenter/wms"
},
"pageSize": 100,
"exportWKT": null,
"rows": [
[
{
"id": "fgeometry",
"title": "",
"fieldType": "wkt",
"value": "",
"showType": "hidden"
},
{

1
7
"id": "thumbimg",
"title": "",
"fieldType": "image",
"value": "",
"showType": "hidden"
},
{
"id": "id",
"title": "",
"fieldType": "text",
"value": "TRIPLESAT_1_PMS_20160320033025_0002B6VI_025",
"showType": "hidden"
},
{
"id": "satellite",
"title": "",
"fieldType": "text",
"value": "TripleSat Constellation-1",
"showType": "show"
},
{
"id": "cloudcover",
"title": "(%)",
"fieldType": "text",
"value": 53.2,
"showType": "show"
},
{
"id": "rollangle",
"title": "",
"fieldType": "text",
"value": -3.556353,
"showType": "show"
},
{
"id": "centertime",
"title": "(UTC+8)",
"fieldType": "time",
"value": "2016-03-20 03:30:25",
"showType": "show"
},
{
"id": "resolution",

1
8
"title": "",
"fieldType": "text",
"value": "1,4",
"showType": "hidden"
},
{
"id": "transformimg",
"title": "",
"fieldType": "image",
"value": "",
"showType": "hidden"
},
{
"id": "browserimg",
"title": "",
"fieldType": "image",
"value": "",
"showType": "hidden"
},
{
"id": "centerlongitude",
"title": "",
"fieldType": "number",
"value": 97.989400806,
"showType": "hidden"
},
{
"id": "centerlatitude",
"title": "",
"fieldType": "number",
"value": 26.551709554,
"showType": "hidden"
},
{
"id": "toprightlatitude",
"title": "",
"fieldType": "text",
"value": 26.661113144,
"showType": "hidden"
},
{
"id": "toprightlongitude",
"title": "",

1
9
"fieldType": "text",
"value": 98.090548846,
"showType": "hidden"
},
{
"id": "bottomrightlatitude",
"title": "",
"fieldType": "text",
"value": 26.488198868,
"showType": "hidden"
},
{
"id": "bottomrightlongitude",
"title": "",
"fieldType": "text",
"value": 98.132198829,
"showType": "hidden"
},
{
"id": "bottomleftlatitude",
"title": "",
"fieldType": "text",
"value": 26.441075605,
"showType": "hidden"
},
{
"id": "bottomleftlongitude",
"title": "",
"fieldType": "text",
"value": 97.889195662,
"showType": "hidden"
},
{
"id": "topleftlatitude",
"title": "",
"fieldType": "text",
"value": 26.613960991,
"showType": "hidden"
},
{
"id": "topleftlongitude",
"title": "",
"fieldType": "text",

2
0
"value": 97.847191479,
"showType": "hidden"
},
{
"id": "rsId",
"fieldType": "text",
"value": "4608758f-73b3-4471-86ee-d7be53d2b693",
"showType": "hidden"
}
],
[
{
"id": "fgeometry",
"title": "",
"fieldType": "wkt",
"value": "",
"showType": "hidden"
},
{
"id": "thumbimg",
"title": "",
"fieldType": "image",
"value": "http://.._thumb.jpg",
"showType": "hidden"
},
{
"id": "id",
"title": "",
"fieldType": "text",
"value": "TRIPLESAT_1_PMS_20160320033022_0002B6VI_024",
"showType": "hidden"
},
{
"id": "satellite",
"title": "",
"fieldType": "text",
"value": "TripleSat Constellation-1",
"showType": "show"
},
{
"id": "cloudcover",
"title": "(%)",
"fieldType": "text",

2
1
"value": 54.1,
"showType": "show"
},
{
"id": "rollangle",
"title": "",
"fieldType": "text",
"value": -3.556756,
"showType": "show"
},
{
"id": "centertime",
"title": "(UTC+8)",
"fieldType": "time",
"value": "2016-03-20 03:30:22",
"showType": "show"
},
{
"id": "resolution",
"title": "",
"fieldType": "text",
"value": "1,4",
"showType": "hidden"
},
{
"id": "transformimg",
"title": "",
"fieldType": "image",
"value": "http://....._browser.png",
"showType": "hidden"
},
{
"id": "browserimg",
"title": "",
"fieldType": "image",
"value": "http://browser.jpg",
"showType": "hidden"
},
{
"id": "centerlongitude",
"title": "",
"fieldType": "number",
"value": 98.033045001,

2
2
"showType": "hidden"
},
{
"id": "centerlatitude",
"title": "",
"fieldType": "number",
"value": 26.371108691,
"showType": "hidden"
},
{
"id": "toprightlatitude",
"title": "",
"fieldType": "text",
"value": 26.501320688,
"showType": "hidden"
},
{
"id": "toprightlongitude",
"title": "",
"fieldType": "text",
"value": 98.129041568,
"showType": "hidden"
},
{
"id": "bottomrightlatitude",
"title": "",
"fieldType": "text",
"value": 26.286764418,
"showType": "hidden"
},
{
"id": "bottomrightlongitude",
"title": "",
"fieldType": "text",
"value": 98.180613459,
"showType": "hidden"
},
{
"id": "bottomleftlatitude",
"title": "",
"fieldType": "text",
"value": 26.239674052,
"showType": "hidden"

2
3
},
{
"id": "bottomleftlongitude",
"title": "",
"fieldType": "text",
"value": 97.938018754,
"showType": "hidden"
},
{
"id": "topleftlatitude",
"title": "",
"fieldType": "text",
"value": 26.454195227,
"showType": "hidden"
},
{
"id": "topleftlongitude",
"title": "",
"fieldType": "text",
"value": 97.8860115,
"showType": "hidden"
},
{
"id": "rsId",
"fieldType": "text",
"value": "4608758f-73b3-4471-86ee-d7be53d2b693",
"showType": "hidden"
}
]
]
},
"msg": null
}
Parameter description:

Parameter Name Field Name Description


count Number of result entries
condition Second filter condition Used to initialize second filter
conditions. The Rule is same as
the retrieval condition.
root Title information
pageNo Page number Current page number
pageSize Entries in the page
geomCover Geometry cover wms layer of geoserver

2
4
rows Data entries

3.2.2. TripleSat Catalog Details Retrieval API

3.2.2.1.Description

Based on product ID to retrieve product details.

3.2.2.2.Interface Rules

Details on interface type, input request parameters and output response result parameters are

as in list:

API name TripleSat Catalog Details Retrieval API


Method to call Http Request
URL Version=1.2&Action=search_v_1_1&Method=detail&AppKey=100
&UserKey={?}&TimeStamp=10000&Req={?}
&Signature= EncryptedString&Language=language
API type Synchronous
Input request Product ID, client information, etc.
parameters
Output response Result of retrieval, successfully or failed, and product details
result
Frequency of request None

3.2.2.3.Parameter Rules

3.2.2.3.1. Request Parameter List

The request parameter string shall be concatenated by product ID, client information, etc. Pass this

string to call this method.

An example is as shown below:

Req={
id:25257758
}
Parameter description:

Parameter Name Field Name Description

2
5
id Product ID Product ID

3.2.2.3.2. Response Result

The response result is of a type of json string. An example is as shown below:

{
"status": "100",
"data": {
"listData": [
{
"id": "thumbimg",
"title": "Thumbing",
"fieldType": "image",
"value":"http://.../TRIPLESAT_2_MS_20160319020409_000319VI_033_thumb.jpg
",
"showType": "hidden"
},
{
"id": "id",
"title": "Image ID",
"fieldType": "text",
"value": "TRIPLESAT_2_PMS_20160319020409_000319VI_033",
"showType": "hidden"
},
{
"id": "fgeometry",
"title": "Geometry",
"fieldType": "wkt",
"value": "POLYGON((115.850902273 40.274731709,116.132328059
40.327337365,116.18631968 40.155722424,115.905581057 40.103195101,115.850902273
40.274731709))",
"showType": "hidden"
},
{
"id": "satellite",
"title": "Satellite",
"fieldType": "text",
"value": "TripleSat Constellation-2",
"showType": "show"
},
{

2
6
"id": "cloudcover",
"title": "CCR(%)",
"fieldType": "text",
"value": 0,
"showType": "show"
},
{
"id": "rollangle",
"title": "OffNadir",
"fieldType": "text",
"value": 2.136545,
"showType": "show"
},
{
"id": "centertime",
"title": "Image Date",
"fieldType": "time",
"value": "2016-03-19 02:04:09",
"showType": "show"
},
{
"id": "browserimg",
"title": "Preview",
"fieldType": "image",
"value":
"http://...3/TRIPLESAT_2_MS_20160319020409_000319VI_033_browser.jpg",
"showType": "hidden"
},
{
"id": "transformimg",
"title": "",
"fieldType": "image",
"value":
"http://.../TRIPLESAT_2_MS_20160319020409_000319VI_033_browser.png",
"showType": "hidden"
},
{
"id": "rsId",
"fieldType": "text",
"value": "3f895d9d-fa3e-47f6-9a06-23af4eb98d62",
"showType": "hidden"
}
],

2
7
"metaData": [
{
"id": "Scene_ID",
"title": "Scene_ID",
"fieldType": "text",
"value": "TRIPLESAT_2_PMS_20160319020409_000319VI_033",
"showType": "show"
},
{
"id": "Satellite_Name",
"title": "Satellite_Name",
"fieldType": "text",
"value": "TripleSat Constellation-2",
"showType": "show"
},
{
"id": "Sensor_Name",
"title": "Sensor_Name",
"fieldType": "text",
"value": "PMS",
"showType": "show"
},
{
"id": "Begin_Time",
"title": "Begin_Time",
"fieldType": "time",
"value": "2016-03-19T02:04:09.947081",
"showType": "show"
},
{
"id": "End_Time",
"title": "End_Time",
"fieldType": "time",
"value": "2016-03-19T02:04:12.788638",
"showType": "show"
},
{
"id": "PAN_Resolution",
"title": "PAN_Resolution(m)",
"fieldType": "text",
"value": "1",
"showType": "hidden"
},

2
8
{
"id": "MS_Resolution",
"title": "MS_Resolution(m)",
"fieldType": "text",
"value": "4",
"showType": "hidden"
},
{
"id": "Central_Lat",
"title": "Central_Lat",
"fieldType": "text",
"value": "40.215930351",
"showType": "show"
},
{
"id": "Central_Lon",
"title": "Central_Lon",
"fieldType": "text",
"value": "116.018606365",
"showType": "show"
},
{
"id": "UL_Lat",
"title": "UL_Lat",
"fieldType": "text",
"value": "40.274731709",
"showType": "show"
},
{
"id": "UL_Lon",
"title": "UL_Lon",
"fieldType": "text",
"value": "115.850902273",
"showType": "show"
},
{
"id": "UR_Lat",
"title": "UR_Lat",
"fieldType": "text",
"value": "40.327337365",
"showType": "show"
},
{

2
9
"id": "UR_Lon",
"title": "UR_Lon",
"fieldType": "text",
"value": "116.132328059",
"showType": "show"
},
{
"id": "LL_Lat",
"title": "LL_Lat",
"fieldType": "text",
"value": "40.103195101",
"showType": "show"
},
{
"id": "LL_Lon",
"title": "LL_Lon",
"fieldType": "text",
"value": "115.905581057",
"showType": "show"
},
{
"id": "LR_Lat",
"title": "LR_Lat",
"fieldType": "text",
"value": "40.155722424",
"showType": "show"
},
{
"id": "LR_Lon",
"title": "LR_Lon",
"fieldType": "text",
"value": "116.186319680",
"showType": "show"
},
{
"id": "Cloud_Cover",
"title": "Cloud_Cover(%)",
"fieldType": "text",
"value": "0.0",
"showType": "show"
},
{
"id": "Image_Quality",

3
0
"title": "Image_Quality",
"fieldType": "text",
"value": "",
"showType": "show"
},
{
"id": "Roll_Angle",
"title": "Roll_Angle()",
"fieldType": "text",
"value": "2.136545",
"showType": "show"
},
{
"id": "Sun_Elevation",
"title": "Sun_Elevation()",
"fieldType": "text",
"value": "38.235684",
"showType": "show"
},
{
"id": "Sun_Azimuth",
"title": "Sun_Azimuth()",
"fieldType": "text",
"value": "133.045132",
"showType": "show"
},
{
"id": "Sat_Elevation",
"title": "Sat_Elevation()",
"fieldType": "text",
"value": "87.827150",
"showType": "show"
},
{
"id": "Sat_Azimuth",
"title": "Sat_Azimuth()",
"fieldType": "text",
"value": "88.592319",
"showType": "show"
}
]
},

"msg": null

3
1
}
Parameter description:

Parameter Name Field Name Description


data Responded details Details includes basic
information and geometry
information: listData
metaData

3.3. Billing APIs

3.3.1. Archive Data Order API

3.3.1.1.Description

This API is for user to check the archive data order bill. The billing information includes data

ID, data source, requested AOI, requested size and number of user licenses.

3.3.1.2.Interface Rules

Details on interface type, input request parameters and output response result parameters are as

in list:

API name Archive Data Order API


Method to call Http Request
URL Version=1.2&Action=price_v_1_2&Method=priceNormal&
AppKey=100&UserKey={?}&TimeStamp=10000&Req={?}&
Signature= EncryptedString&Language=language
API type Synchronous
Input request Order price information
parameters
Output response Json string
result
Frequency of None
request

3
2
3.3.1.3.Parameter Rules

3.3.1.3.1.1. Request Parameter List

The request parameter string shall be concatenated by order related information. Pass this

string to call this method.

An example is as shown below:

Req={"userNum":"1","area":1327578520.4088862,"wkt":"","type":"normal","data":
[{"id":"","rsId":""},{"id":"","rsId":""}]}
Parameter description:

Parameter Name Field Name Description


data Order related information
userNum Number of user licenses
area Size of user AOI
Wkt User AOI area
Type normal

3.3.1.3.1.2. Response Result

The response result is of a type of json string. An example is as shown below:

{ status :100,data: }
Parameter description:

Parameter Name Field Name Description


data Responded {"total":63744,"unit":34,"due":44621,"lang":"zh_cn"}
result

3.3.2. Tasking Data Order Billing API

3.3.2.1.Description

This API is for user to check the tasking data order bill. The billing information includes type of

task and area.

3
3
3.3.2.2.Interface Rules

Details on interface type, input request parameters and output response result parameters are as

in list:

API name Tasking Data Order Billing API


Method to call Http Request
URL Version=1.2&Action=price_v_1_2&Method=priceNeed&
AppKey=100&UserKey={?}&TimeStamp=10000&Req={?}&
Signature= EncryptedString&Language=language
API type Synchronous
Input request Order price information
parameters
Output response Json string
result
Frequency of None
request

3.3.2.3.Parameter Rules

3.3.2.3.1. Request Parameter List

The request parameter string shall be concatenated by order related information. Pass this

string to call this method.

An example is as shown below:

Req={"userNum":"1","area":,"cloudCover":"15","wkt":"","type":"normal"}
Parameter description:

Parameter Name Field Name Description


userNum Number of user licenses
wkt User AOI area
area Size of user AOI
cloudCover Cloud cover
type Type of tasking normal normal tasking
(default)

3.3.2.3.2. Response Result

The response result is of a type of json string. An example is as shown below:

3
4
{ status :100,data: }

Parameter description:

Parameter Name Field Name Description


data Responded {"total":90001620,"unit":63,"due":63001134,"lang":"zh_cn"}
result

3.4. Ordering API

3.4.1. Submit Archive Data Order API

3.4.1.1.Description

This API is for client to submit archive order requests, which includes data ID and rsID.

3.4.1.2.Interface Rules

The following table lists the details on API patterns, input request parameters and output

response parameters

API Name Archive Data Order API


Method to call Http request
URL Version=1.2&Action=order_v_1_2&Method=submitNormal&
AppKey=100&UserKey={?}&TimeStamp=10000&Req={?}&
Signature= EncryptedString&Language=language
API Type Synchronous
Input request Order related information
parametersOutput
response parameters
Output response Json string
parameters
Frequency of None
request

3
5
3.4.1.3.Parameter Rules

3.4.1.3.1. Request Parameter List

The request parameter string shall be concatenated by order related information. Pass this string to

call this method.

An example is as shown below:

{
"title": "2015 1 ",
"remark": "",
"startTime": "2016-10-10",
"endTime": "",
"wkt": "MULTIPOLYGON(((121.910596298 37.929646737,122.184384661
37.978958875,122.245882812 37.765359542,121.972865863 37.716115196,121.910596298
37.929646737)),((121.792937829 38.330519765,122.068195912 38.379962745,122.130197505
38.166417547,121.855725677 38.117044861,121.792937829 38.330519765)))",
"cloudCover": "15",

"startAngle": "-25",
"endAngle": "25",
"needType": "normal",
"partialDelivery": "No",
"area": 1200732005.2504692,
"data": [
{
"id": "TRIPLESAT_2_PMS_20160322014529_000332VI_006",
"rsId": "4608758f-73b3-4471-86ee-d7be53d2b693"
},
{
"id": "TRIPLESAT_2_PMS_20160322014536_000332VI_008",
"rsId": "4608758f-73b3-4471-86ee-d7be53d2b693"
}
],
"infos": [
{
"id": "areaDesc",
"title": "",
"value": "2015 1 ",
"hidValue": "2015 1 ",
"showType": "show",
"fieldType": "text"
},

3
6
{
"id": "remark",
"title": "",
"value": "",
"hidValue": "",
"showType": "show",
"fieldType": "text"
},
{
"id": "partialDelivery",
"title": "",
"value": "No",
"hidValue": "No",
"showType": "show",
"fieldType": "text"
},
{
"id": "aoiArea",
"title": "",
"value": "1201km",
"hidValue": "1201km",
"showType": "show",
"fieldType": "text"
},
{
"id": "scale",
"title": "",
"value": "0.01%",
"hidValue": "0.01%",
"showType": "show",
"fieldType": "text"
},
{
"id": "productname",
"title": "",
"value": "L1",
"hidValue": "L1A",
"showType": "show",
"fieldType": "text"
},
{
"id": "productOption",
"title": "",

3
7
"value": "Bundle(Panchromatic and multispectral)",
"hidValue": "Bundle",
"showType": "show",
"fieldType": "text"
},
{
"id": "bitDepth",
"title": "",
"value": "10-bit",
"hidValue": "10-bit",
"showType": "show",
"fieldType": "text"
},
{
"id": "fileFormat",
"title": "",
"value": "GeoTiff",
"hidValue": "GeoTiff",
"showType": "show",
"fieldType": "text"
},
{
"id": "resolution",
"title": "",
"value": "0.8m",
"hidValue": "0.8",
"showType": "show",
"fieldType": "text"
},
{
"id": "mosaic",
"title": "",
"value": "No",
"hidValue": "No",
"showType": "show",
"fieldType": "text"
},
{
"id": "dra",
"title": "",
"value": "Off",
"hidValue": "Off",
"showType": "show",

3
8
"fieldType": "text"
},
{
"id": "resamplingKernel",
"title": "",
"value": "4*4 CC",
"hidValue": "4*4 CC",
"showType": "show",
"fieldType": "text"
},
{
"id": "tilling",
"title": "",
"value": "No",
"hidValue": "No",
"showType": "show",
"fieldType": "text"
},
{
"id": "projection",
"title": "",
"value": "UTM",
"hidValue": "UTM",
"showType": "show",
"fieldType": "text"
},
{
"id": "dataum",
"title": "",
"value": "WGS84",
"hidValue": "WGS84",
"showType": "show",
"fieldType": "text"
},
{
"id": "deliveryType",
"title": "",
"value": "FTP pull",
"hidValue": "ftp",
"showType": "show",
"fieldType": "text"
},
{

3
9
"id": "licenseType",
"title": "",
"value": "Single User",
"hidValue": "1",
"showType": "show",
"fieldType": "text"
},
{
"id": "productType",
"title": "",
"value": "AOI based",
"hidValue": "AOI based",
"showType": "show",
"fieldType": "text"
},
{
"id": "verticalMarket",
"title": "",
"value": "",
"hidValue": "",
"showType": "show",
"fieldType": "text"
},
{
"id": "promotionCode",
"title": "",
"value": "",
"hidValue": "",
"showType": "show",
"fieldType": "text"
}
],
"delivery": {
"orgname": "",
"address": "",
"user": "54414252",
"phone": "54414252",
"email": "quzf_box@21at.com",
"fax": "",
"deliveryType": "0"
},
"deliveryUser": {
"orgname": "",

4
0
"relationuser": "54414252",
"relationphone": "54414252",
"address": "",
"email": "quzf_box@21at.com",
"fax": ""
},
"price": {
"total": 57648,
"finalPrice": 40354,
"rebate": 17294,
"unit": 34,
"balance": "",
"proid": ""
}
}
Parameter Description:

Parameter Field Name Description


Name
title Order title Order title
data Order related information Order details
price Order pricing information Total: Total price
finalPrice: Final payment
rebate: Discount
info Order descriptive information Save as blank
delivery Order delivery information DeliveryType: Delivery type, 0
indicates via online FTP. 1 indicates
mail delivery service/ courier.

3.4.1.3.2. Response Result

The response result is of a type of json string. An example is as shown below:

{ status :100,data: {
"orderarea": 2140758602.3872855,
"orderstate": "0",
"remark": "",
"totalprice": 102768,
"processstate": "orderSubmit",
"userid": "360eb799-85f7-44d2-bf49-dc5bd72764c8",
"ordertype": "archive",
"principalid": "87054fd6-d729-4d64-be25-169e07a18db3",

4
1
"rebateprice": 20554,
"id": "d00591df-d56d-45e5-962e-cb2e7d5b05d4",
"finalprice": 82214,
"balance": null,
"addtime": "2016-10-25 18:07:13.436",
"unitprice": 48,
"creatorid": "360eb799-85f7-44d2-bf49-dc5bd72764c8",
"submittime": "2016-10-25 18:07:13.426",
"isdel": "0",
"pricetype": "0",
"ordertitle": "test",
"ordercode": "20161025003001",
"ordersource": "Website"
} }
Parameter Description:

Parameter Name Field Name Description


data Responded result {
"orderarea": ,
"orderstate": ,
"remark": ,
"totalprice": ,
"processstate": ,
"userid": ,
"ordertype":,
"principalid": ,
"rebateprice": ,

"id": ,

"finalprice": ,
"balance":,
"addtime": ,
"unitprice": ,
"creatorid": id,
"submittime": ,
"isdel": ,
"pricetype": ,
"ordertitle": ,
"ordercode": ,
"ordersource":
}

4
2
3.4.2. Submit Tasking Data Order API

3.4.2.1.Description

This API is for client to submit task requests which formed by id, title, value and type

parameters.

3.4.2.2.Interface Rules

The following table lists the details on API types, input request parameters and output response

parameters:

API Name Tasking API


Method to call Http request
URL Version=1.2&Action=order_v_1_2&Method=submitN
eed&
AppKey=100&UserKey={?}&TimeStamp=10000&R
eq={?}
& Signature= EncryptedString&Language=language
API Type Synchronous
Input request parameters Tasking data related information
Output response parameters Json string
Frequency of request None

3.4.2.3.Parameter Rules

3.4.2.3.1. Request Parameter List

The request parameter string shall be concatenated by order related information. Pass this string to
call this method.
An example is as shown below:

Req= {
"title": "test",
"remark": "",
"startTime": "2016-10-26",
"endTime": "2016-10-31",
"wkt": "POLYGON((116.47567749026 40.292816162109,116.47567749026
40.248870849609,116.5058898926 40.248870849609,116.5058898926
40.292816162109,116.47567749026 40.292816162109))",

4
3
"cloudCover": "15",
"startAngle": "-25",
"endAngle": "25",
"needType": "normal",
"partialDelivery": "No",
"area": 12539468.675575256,
"data": [ ],
"infos": [
{
"id": "areaDesc",
"title": "Area of Interest (AOI)",
"value": "test",
"hidValue": "test",
"showType": "show",
"fieldType": "text"
},
{
"id": "remark",
"title": "Remark",
"value": "",
"hidValue": "",
"showType": "show",
"fieldType": "text"
},
{
"id": "needType",
"title": "Type Of Order",
"value": "Standard Tasking",
"hidValue": "normal",
"showType": "show",
"fieldType": "text"
},
{
"id": "cloudCover",
"title": "Maximum Cloud Cover(%)",
"value": "15",
"hidValue": "15",
"showType": "show",
"fieldType": "text"
},
{
"id": "partialDelivery",
"title": "Partial delivery",

4
4
"value": "No",
"hidValue": "No",
"showType": "show",
"fieldType": "text"
},
{
"id": "startTime",
"title": "Eearliest Acceptable Date(UTC+8)",
"value": "2016-10-26",
"hidValue": "2016-10-26",
"showType": "show",
"fieldType": "text"
},
{
"id": "endTime",
"title": "Latest Acceptable Date(UTC+8)",
"value": "2016-10-31",
"hidValue": "2016-10-31",
"showType": "show",
"fieldType": "text"
},
{
"id": "angleStart",
"title": "Minimum Off-Nadir Range",
"value": "-25",
"hidValue": "-25",
"showType": "show",
"fieldType": "text"
},
{
"id": "angleEnd",
"title": "Maximum Off-Nadir Range",
"value": "25",
"hidValue": "25",
"showType": "show",
"fieldType": "text"
},
{
"id": "aoiArea",
"title": "Area Of AOI",
"value": "13km",
"hidValue": "13km",
"showType": "show",

4
5
"fieldType": "text"
},
{
"id": "productname",
"title": "Product Name",
"value": "L1",
"hidValue": "L1A",
"showType": "show",
"fieldType": "text"
},
{
"id": "productOption",
"title": "Product Option",
"value": "Bundle(Panchromatic and multispectral)",
"hidValue": "Bundle",
"showType": "show",
"fieldType": "text"
},
{
"id": "bitDepth",
"title": "Bit Depth",
"value": "10-bit",
"hidValue": "10-bit",
"showType": "show",
"fieldType": "text"
},
{
"id": "fileFormat",
"title": "File Format",
"value": "GeoTiff",
"hidValue": "GeoTiff",
"showType": "show",
"fieldType": "text"
},
{
"id": "resolution",
"title": "Ground Sample Distance(Resolution)",
"value": "0.8m",
"hidValue": "0.8",
"showType": "show",
"fieldType": "text"
},
{

4
6
"id": "mosaic",
"title": "Mosaic",
"value": "No",
"hidValue": "No",
"showType": "show",
"fieldType": "text"
},
{
"id": "dra",
"title": "DRA(Contrast Enhancement)",
"value": "Off",
"hidValue": "Off",
"showType": "show",
"fieldType": "text"
},
{
"id": "resamplingKernel",
"title": "Resampling Kernel",
"value": "4*4 CC",
"hidValue": "4*4 CC",
"showType": "show",
"fieldType": "text"
},
{
"id": "tilling",
"title": "Tiling",
"value": "No",
"hidValue": "No",
"showType": "show",
"fieldType": "text"
},
{
"id": "projection",
"title": "Projection",
"value": "UTM",
"hidValue": "UTM",
"showType": "show",
"fieldType": "text"
},
{
"id": "dataum",
"title": "Datum",
"value": "WGS84",

4
7
"hidValue": "WGS84",
"showType": "show",
"fieldType": "text"
},
{
"id": "deliveryType",
"title": "Delivery Media",
"value": "FTP pull",
"hidValue": "ftp",
"showType": "show",
"fieldType": "text"
},
{
"id": "licenseType",
"title": "License Type",
"value": "Single User",
"hidValue": "1",
"showType": "show",
"fieldType": "text"
},
{
"id": "productType",
"title": "Frame",
"value": "AOI based",
"hidValue": "AOI based",
"showType": "show",
"fieldType": "text"
},
{
"id": "verticalMarket",
"title": "Vertical Market",
"value": "Agricultrue",
"hidValue": "Agricultrue",
"showType": "show",
"fieldType": "text"
},
{
"id": "promotionCode",
"title": "Promotional Code(if applicable)",
"value": "",
"hidValue": "",
"showType": "show",
"fieldType": "text"

4
8
}
],
"delivery": {
"orgname": "",
"address": "",
"user": "test",
"phone": "test",
"email": "demo@21at.com",
"fax": "",
"deliveryType": "0"
},
"deliveryUser": {
"orgname": "",
"relationuser": "test",
"relationphone": "test",
"address": "",
"email": "demo@21at.com",
"fax": ""
},
"price": {
"total": 9000,
"finalPrice": 7200,
"rebate": 1800,
"unit": 90,
"balance": null,
"proid": "1"
}
}
Parameter description:

Parameter Name Field Name Description


title Order title
remark Remark
startTime Start time YYYYMMDDhhmmss
endTime End time YYYYMMDDhhmmss
cloudCover Cloud cover Maximum cloud cover
startAngle Minimum roll angle Minimum roll angle
endAngle Maximum roll angle Maximum roll angle
wkt Geometry information Wkt string
needType Type of requirement normal: normal tasking, priorpriority tasking
partialDelivery Batch delivery?
area Area Total area of order/ AOI
infos Order production information Defined by id, title, value, hidValue,
fieldType and showType

4
9
showType Display type Show and hidden
fieldType Field type Text, image and wkt

3.4.2.3.2. Response Result

The response result is of a type of json string. An example is as shown below:

{ status :100,data: {"orderarea":"2140758602.3872855", "orderstate":"0", "remark":"",


"totalprice":"102768", "processstate":"orderSubmit", "userid":"360eb799-85f7-44d2-bf49-
dc5bd72764c8", "ordertype":"require", "principalid":"87054fd6-d729-4d64-be25-169e07a18db3",
"rebateprice":"20554", "id":"d00591df-d56d-45e5-962e-cb2e7d5b05d4", "finalprice":"82214",
"balance":null, "addtime":"2016-10-25 18:07:13.436", "unitprice":"48", "creatorid":"360eb799-
85f7-44d2-bf49-dc5bd72764c8", "submittime":"2016-10-25 18:07:13.426", "isdel":"0",
"pricetype":"0", "ordertitle":"test", "ordercode":"20161025003001", "ordersource":"Website}}
Parameter Description:

Parameter Name Field Name Description


data Responded result {
"orderarea": ,
"orderstate": ,
"remark": ,
"totalprice": ,
"processstate": ,
"userid": ,
"ordertype":,
"principalid": ,
"rebateprice": ,
"id": ,
"finalprice": ,
"balance":,
"addtime": ,
"unitprice": ,
"creatorid": id,
"submittime": ,
"isdel": ,
"pricetype": ,
"ordertitle": ,
"ordercode": ,
"ordersource":
}

5
0
3.4.3. Get Order List API

3.4.3.1.Description

This API is for client to retrieve list of orders with User ID.

3.4.3.2.Interface Rules

The following table lists the details on API types, input request parameters and output response

parameters:

API Name Get Order List API


Method to call Http request
URL Version=1.2&Action= order_v_1_2&Method= query&
AppKey=100&UserKey={?}&TimeStamp=10000&Req={?}
& Signature= EncryptedString&Language=language
API Type Synchronous
Input request parameters order related information
Output response parameters Json string
Frequency of request None

3.4.3.3.Parameter Rules

3.4.3.3.1. Request Parameter List

The request parameter string shall be concatenated by order related information. Pass this

string to call this method.

An example is as shown below:

Req={pageNo:1,pageSize:10,data:{startDate:,endDate:,orderState:,

orderType:,orderCode:}}
Parameter description:

Parameter Name Field Name Description


pageNo Page number Cannot be blank
pageSize Paging parameter Cannot be blank
startDate Start time
endDate End time
orderState Order status

5
1
orderType Order type Archive (normal) or Tasking
(require)
orderCode Order number

3.4.3.3.2. Response Result

The response result is of a type of json string. An example is as shown below:

{ status :100,data:{}}
Parameter Description:

Param Field Name Description

eter

Name
data Return json {pageNo:1,pageSize:10, count:100,
data root:[
{"id":"thumbimg","fieldType":"image","value":"
","showType":"show"},
{"id":"satellite","fieldType":"image","value":"
","showType":"show"},
{"id":"sensor","fieldType":"image","value":"
","showType":"show"},
{"id":"centertime","fieldType":"image","value":"
","showType":"show"},
{"id":"cloudcover","fieldType":"image","value":"
","showType":"show"},
{"id":"resolution","fieldType":"image","value":"
","showType":"show"},
{"id":"geometry","fieldType":"image","value":"
","showType":"hidden"},
],
rows:[
[
{id:ordercode,value:
A2014082300001,showType:show,fieldType:text},
{id:submittime,value:2014-3-6 20:20:20,
showType:show,fieldType:text},
{id:ordertype,value:, showType:show,fieldType:text},
{id:statename,value:, showType:show,fieldType:text},
{id:dataimg,value:img , showType:show,fieldType:img},
{id:id,value: id, type: hidden,fieldType:text},
{id:orderstate,value:, type:hidden,fieldType:text}
],

5
2
[
{id:ordercode,value: A2014082300001,
showType:show,fieldType:text},
{id:submittime,value:2014-3-6 20:20:20,
showType:show,fieldType:text},
{id: ordertype,value:, showType:show,fieldType:text},
{id: statename,value:, showType:show,fieldType:text},
{id:dataimg,value:img , showType:show,fieldType:img},
{id:id,value: id, type: hidden,fieldType:text},
{id:orderstate,value:, type: hidden,fieldType:text}
]
]

3.4.4. Get Order Details API

3.4.4.1.Description

This API is for client to check for detailed information of an order. Input request parameter

includes Order ID.

3.4.4.2.Interface Rules

The following table lists the details on API types, input request parameters and output response

parameters:

API Name Gei Order Details API


Method to call Http request
URL Version=1.2&Action= order_v_1_2&Method= detail&
AppKey=100&UserKey={?}&TimeStamp=10000&Req={?
}&Signature= EncryptedString&Language=language
API Type Synchronous
Input request parameters order related information
Output response parameters Json string
Frequency of request None

5
3
3.4.4.3.Parameter Rules

3.4.4.3.1. Request Parameter List

The request parameter string shall be concatenated by order related information. Pass this

string to call this method.

An example is as shown below:

Req={id:}
Parameter Description:

Parameter Name Field Name Description


id Order ID

3.4.4.3.2. Response Result

The response result is of a type of json string. An example is as shown below:

{ status :100,data:{orderInfo:,infos:,datas:, priceInfo: ,tracks:

,process:}}
Parameter Description:

Parameter Field Name Description

Name
orderInfo Current order information [{id:,title:,value:,
fieldType:,showType:},{id:,title:,value:,
fieldType:,showType:}]
priceInfo Pricing information [{id,title,value }]
infos Order related information, [{id:,title:,value:, fieldType:},
{id:,title:,value:}]
formed by id, title, value,
The data get by client side will only be displayed when
type infos is not empty.
datas Order data related {
information root:[
{"id":"thumbimg","fieldType":"image","value":"
","showType":"show"},
{"id":"satellite","fieldType":"image","value":"
","showType":"show"},
{"id":"sensor","fieldType":"image","value":"
","showType":"show"},
{"id":"centertime","fieldType":"image","value":"

5
4
","showType":"show"},
{"id":"cloudcover","fieldType":"image","value":"
","showType":"show"},
{"id":"resolution","fieldType":"image","value":"
","showType":"show"},
{"id":"geometry","fieldType":"image","value":"
","showType":"hidden"},
],
rows:[
[
{id:simpleimg,value:A2014082300001,showType:"sh
ow",fieldType:"text"},
{id:type,value:,
showType:"show",fieldType:"text"},
{id:describe,value: [
{id:viewid,title:,value:,
showType:"show",fieldType:"text"},
{id:addTime,title:,value:,
showType:"show",fieldType:"text"}
],type:json},
{id: stateName,value:,
showType:"show",fieldType:"text"},
{id: id,value:,
showType:"hidden",fieldType:"text"},
{id: rsId,value:ro_file,
showType:"hidden",fieldType:"text"},
{id: state,value:0,
showType:"hidden",fieldType:"text"},
{id: url,value:,
showType:"hidden",fieldType:"text"},
{id:geomtry,value:,
showType:"hidden",fieldType:"geomtry"}
],
[
{id:simpleimg,value:A2014082300001,
showType:"show",fieldType:"image"},
{id:type,value:,
showType:"show",fieldType:"text"},
{id:describe,value: [
{id:viewid,title:,value:,
showType:"show",fieldType:"text"},
{id:addTime,title:,
showType:"show",fieldType:"text"}

5
5
],type:array},
{id: stateName,value:,
showType:"show",fieldType:"text"},
{id: id,value:,
showType:"hidden",fieldType:"text"},
{id: rsId,value:ro_file,
showType:"hidden",fieldType:"text"},
{id: state,value:0,
showType:"hidden",fieldType:"text"},
{id: url,value:,
showType:"hidden",fieldType:"text"},
{id:geomtry,value:,
showType:"hidden",fieldType:"geomtry"}
]
]}
datas
0:()
1:()
2:()
3:()
4()
tracks Order tracking and status tracks:[
{title: ,timestamp:2014-2-3
12:12:12,pass:true},
{title:,timestamp:2014,pass:true},
{title:, timestamp:2014,pass:true}
{title:, timestamp:,pass: false}
{title:, timestamp:,pass: false}
{title:, timestamp:,pass:false}
]

tracks:[
{title:,timestamp:2014-2-3
12:12:12,pass:true},
{title:,timestamp:2014,pass:true},
{title:, timestamp: 2014,pass: true}
]

tracks:[
{title:,timestamp:2014-2-3
12:12:12,pass:true},
{title:, timestamp: 2014,pass: true}
]

5
6
process Order verification process process:[
{title:, timestamp:2014,user:
information
},
{title:,
timestamp:2014,user:}
]
message Message message:[
{title:, timestamp:2014,user:},
{title:, timestamp:2014,user:}
]
affix "affix": [
{
"id": "f2d735d7-3e2e-4c6e-b3f1-0ed9253558c6",
"name": ".jpg",
"type": "constra",
"url": "http://.../ATCenter/affix/downloadFile?
id=f2d735d7-3e2e-4c6e-b3f1-0ed9253558c6"
}
]
ArrayContains contract and mission planning scheme
type:constra (means contract
attachment)taskPlan(means mission planning scheme
attachment)
next "next": [

"id": "contraConfirm",
"text": "",
"next": "payComplete",
"name": ""
}
]
Array, the next step can be performed, name support
internationalization, this operation will be displayed in
the interface. When the user clicks, id and next need to
be passed to perform the next step

3.4.5. Delete Order API

3.4.5.1.Description

This API is for client to delete an order. Input request parameter includes Order ID and return

5
7
json strings. Client can only delete cancelled orders or accomplished orders.

3.4.5.2.Interface Rules

The following table lists the details on API types, input request parameters and output response

parameters:

API Name Delete Order API


Method to call Http request
URL Version=1.2&Action=order_v_1_1&Method=
delete&AppKey=100
&UserKey={?}&TimeStamp=10000&Req={?}
& Signature= EncryptedString&Language=language
API Type Synchronous
Input request parameters Order ID
Output response parameters Json string
Frequency of request Noned

3.4.5.3.Parameter Rules

3.4.5.3.1.1. Request Parameter List

The request parameter string shall be concatenated by order related information. Pass this

string to call this method.

An example is as shown below:

Req={ id:}
Parameter Description:

Parameter Name Field Name Description


id Order ID

3.4.5.3.1.2. Response Result

The response result is of a type of json string. An example is as shown below:

{ status :100}

5
8
3.4.6. Cancel Order API

3.4.6.1.Description

This API is for client to make cancellation of order. Input request parameter includes Order ID

and return json strings. Client can only cancel unapproved order.

3.4.6.2.Interface Rules

The following table lists the details on API types, input request parameters and output response

parameters:

API Name Cancel Order API


Method to call Http request
URL Version=1.2&Action=order_v_1_1&Method=cancel&
AppKey=100
&UserKey={?}&TimeStamp=10000&Req={?}
& Signature= EncryptedString&Language=language
API Type Synchronous
Input request parameters Order ID
Output response parameters Json string
Frequency of request None

3.4.6.3.Parameter Rules

3.4.6.3.1.1. Request Parameter List

The request parameter string shall be concatenated by order related information. Pass this

string to call this method.

An example is as shown below:

Req={ id:}
Parameter Description:

Parameter Name Field Name Description


id Order ID

3.4.6.3.1.2. Response Result

The response result is of a type of json string. An example is as shown below:

5
9
{ status :100}

3.4.7. Confirm Order API

3.4.7.1.Description

This API is for client to confirm the completion of an order. Input request parameter includes

Order ID and return json strings.

3.4.7.2.Interface Rules

The following table lists the details on API types, input request parameters and output response

parameters:

API Name Confirm Order API


Method to call Http request
URL Version=1.2&Action=order_v_1_1&Method=done&Ap

pKey=100&UserKey={?}&TimeStamp=10000&Req={

?}&Signature=EncryptedString&Language=language
API Type Synchronous
Input request parameters Order ID
Output response parameters Json string
Frequency of request None

3.4.7.3.Parameter Rules

3.4.7.3.1. Request Parameter List

The request parameter string shall be concatenated by order related information. Pass this

string to call this method.

An example is as shown below:

Req={id:}
Parameter Description:

Parameter Name Field Name Description


id Order ID

6
0
3.4.7.3.2. Response Result

The response result is of a type of json string. An example is as shown below:

{ status :100}

3.4.8. Order Delivery API

3.4.8.1.Description

This API is for user to request for order delivery. Input request includes User ID and return json

strings.

Client request through this interface to get the deliverable data from the current central end.

3.4.8.2.Interface Rules

The following table lists the details on API types, input request parameters and output response

parameters:

API Name Order Delivery API


Method to call Http request
URL Version=1.2&Action=order_v_1_1&Method=queryDelivery
&AppKey=100&UserKey={?}&TimeStamp=10000&Req={?
}& Signature= EncryptedString&Language=language
API Type Synchronous
Input request parameters User ID
Output response parameters Json string
Frequency of request None

3.4.8.3.Parameter Rules

3.4.8.3.1. Request Parameter List

The request parameter string shall be concatenated by order related information. Pass this string to
call this method.
An example is as shown below:

Req={ id:,datas:}
Parameter Description:

6
1
Parameter Name Field Name Description
id Order ID Unfilled, check for the deliverable data
Filled, request for order delivery
datas Order related information Use with Order ID [{dataId: }]

3.4.8.3.2. Response Result

The response result is of a type of json string. An example is as shown below:

{ status :100,data:{order:{},datas:{}}}
Parameter Description:

Parameter Name Field Name Description


order Current order {id:, ordercode: order number,
information submittime:, ordertype: order type,
state:order status}
datas Return json data [{ dataId:,url:, dataType:,fileSize:},
{ dataId:,url:, dataType:,fileSize:}]

3.4.9. Order Feedback API

3.4.9.1.Description

The following table lists the details on API types, input request parameters and output response
parameters:

3.4.9.2.Interface Rules

The following table lists the details on API patterns, input request parameters and output

response parameters:

API Name Order Feedback API


Method to call Http request
URL Version=1.2&Action=order_v_1_1&Method=delivery
Feedback&AppKey=100&UserKey={?}&TimeStamp
=10000&Req={?}&Signature=EncryptedString&Lang
uage=language
API Type Synchronous
Input request parameters Order ID, Data ID, Delivery Status

6
2
Output response parameters Json String
Frequency of request None

3.4.9.3.Parameter Rules

3.4.9.3.1. Request Parameter List

The request parameter string shall be concatenated by order related information. Pass this

string to call this method.

An example is as shown below:

Req={id:"order id",datas:[{dataId:"data id",state:"execution result, 0 indicates success 1

indicates failure",msg:"reason of failure"}}


Parameter Description:

Parameter Name Field Name Description


id Order ID Order ID
datas Data delivery related [{dataId:,state: delivery status,
information msg:}, {dataId:,state: delivery
status, msg:}]
Delivery status 0 indicates successful
delivery. 1 indicates failed delivery

3.4.9.3.2. Response Result

The response result is of a type of json string. An example is shown below:

{ status :100}

3.5. Mission Planning API

3.5.1. Satellite Orbit Information Request API

3.5.1.1.Description

This API is for user to request the satellite orbit information..

6
3
3.5.1.2.Interface Rules

Details on interface type, input request parameters and output response result parameters are as

in list:

API name Satellite Orbit Information Request API


Method to call Http Request
URL Version=1.2&Action=mission&Method=satelliteOrbitInfo&
AppKey=100&UserKey={?}&TimeStamp=10000&Req={?}
& Signature= EncryptedString&Language=language
API type Synchronous
Input request None
parameters
Output response Json string
result
Frequency of request None

3.5.1.3.Parameter Rules

3.5.1.3.1. Request Parameter List

An example is as shown below:

Req={}
Parameter description:

Parameter Name Field Name Description

3.5.1.3.2. Response Result

The response result is of a type of json string. An example is shown below:

{ status :100,data:{}}
Parameter description:

Parameter Field Name Description


Name
data Responded json string {

"msg": null,
"data": [
{
"sen_color": "rgba(29,237,91,0.7)",
"sat_group": null,

6
4
"sat_name": "",
"sen_resolution": "1",
"sen_stabletime": 60,
"sat_owner": "21AT",
"sen_margin": 0.1,
"sen_nightworktime": 600,
"sen_name": "CCD",
"sat_worktime": 60,
"sat_tle": "1 40715U 58056A 16243.02808723 .
00000000 00000-0 +23311-4 0 330
2 40715 98.0679 134.5640 0015956 353.9083 6.1208
14.73699098 61312
",
"sat_date": "2016-07-19 14:49:35",
"sen_tilttime": 0,
"sen_scenelength": 3.31,
"sat_id": "DMC3-FM1",
"sen_id": "f787affb-ceec-cf93-8c2e-9f7cfc29b667",
"sen_type": "+",
"sen_tilt": 45,
"sen_closetime": 0,
"sat_img": "images/satellites/satellite_7.png",
"sat_color": "rgba(55,99,212,0.7)",
"sen_opentime": 0,
"sen_dayworktime": 900,
"sat_datatransferspeed": 400,
"sen_width": 23600
}
],
"status": "100"
}

6
5
4. Authorization and legal terms

5. Appendix

5.1. Coding table

5.1.1. Return message coding

parameters Parameter field name Description


status Return execution status 100 //succeed
200 //failed
300 // Server exception, please contact the
administrator
301 // Parameter error, please check parameter
integrity
302 //wrong version number
303 //illegal execution syntax and parameters
304 //illegal user
305 // Illegal signature information
msg Return the result of execution For example: user name or password error,
operation success and operation failure

6
6

S-ar putea să vă placă și