新手指南
成为开发者
-
G7S用户,直接通过G7S账号授权登录
-
非G7S用户,进行开发者账号申请,审核通过后使用开放平台账号登录
- 开发者账号申请
在开发者账号申请页面[链接]完成相关信息填写,并提交。 - 资质认证
在我们确定了开发者的身份以后,会将审核结果发送到所申请的邮箱,如果审核通过,邮件会附上您的账号和密码。
第一次登录,及时修改密码后便可以进入操作界面。
数据申请
-
进入产品中心,在产品中心查看需要使用的接口或者相关的推送数据,点击立即申请并提交审核。然后进入控制台便可以查看到审核的状态,审核通过后AccessID和Secret也将在控制台展示。
-
您可通过AccessID和Secret获取您想要的数据,具体使用方法请详见开发指南的对应模块。
-
AccessID和Secret它们的作用是计算验证签名,请妥善保管,不要泄露。
开发指南
RestAPI
开发准备
确保已经在产品中心-Rest API下完成了所需API的申请并取得相应的AccessId/SecretKey
SDK下载及文档
为方便开发者调试和接入开放平台产品 API,这里为您介绍开发工具包,让您快速获取SDK 并开始调用。
适用范围 | 语言 | 下载 |
---|---|---|
openAPI | C#/ java / php / python | open-sdk |
下面以java的sdk举例进行联调说明:
- 首先将SDK工程导入到IDE中,用导入maven工程的方式进行即可。
-
依赖环境
- JDK版本1.8及以上
- maven版本3.3.9及以上
-
MyEclipse导入后的工程结构:
-
Intellj IDEA导入后的工程结构:
-
程序入口可参照<openapi-sdk-demo-java\src\test\java\com\chinawayltd\altair\demo>目录下的Demo.java文件:
-
配置参数说明:
//APP KEY(申请接入码后给出的AccessID)
private final static String ACCESS_ID = "02co9r";
// APP密钥(申请接入码后给出的SecretKey)
private final static String SECRET_KEY = "EZRUPGx1PY99WSYE1GO7eEoXaOAniP14";
/** API域名(服务访问的地址)
* demo环境为:demo.dsp.chinawayltd.com/altair/rest
* 生产环境为:openapi.huoyunren.com
*/
private final static String BaseURL = "demo.dsp.chinawayltd.com/altair/rest";
//请求path(openAPI文档中给出的业务接口的路径)
String path = "/v1/base/truck/history_location";
根据openAPI业务接口的请求类型的不同,如Get和Post,这个在具体的接口文档中有,其接口参数传递方式也有所区别。
- Get请求是将参数组装到map中,然后设置到request对象中,详情可参考Demo.java中的代码:
//GET请求的query
Map<String, String> querys = new HashMap<>();
querys.put("plate_num", "部A11110");
querys.put("from", "2017-11-25 00:00:00");
querys.put("to", "2017-11-30 00:00:00");
request.setQueries(querys);
- Post请求需要将请求的参数序列化成Json字符串,然后传递给业务接口。详情可参考Demo.java中的postJson方法:
public void postJson() throws Exception {
//请求path(openAPI文档中给出的业务接口的路径)
String path = "/v1/base/current/full_currents";
//Body内容(请求参数)
String body = "{\n" +
"\"carnum\": \"川A12345\",\n" +
"\"longitude\": \"104.07134\",\n" +
"\"latitude\": \"30.54013\"\n" +
"}";
System.out.println(body);
Map<String, String> headers = new Ha