数位云开发者平台：室内定位api接入文档

API文档

1 概述

数位云场景识别 API v3接口用于查询用户的场景位置、标签等 POI数据，用户可以使用 Java、Golang、C#、 C++、Python 等开发语言发送请求且接收 JSON 格式数据。

1.1 接入流程

1. 在数位云菜单“我的应用”创建一个应用后，即可查看到AppID和AppKey，与数位商务同事取得联系，激活AppID和AppKey；

2. 使用AppID和AppKey接入API进行测试，提供单次和批量两种请求接口，接入步骤如下：

   1) 请求头：按格式设置请求头；

   2) 请求体：按请求参数字段和示例的格式设置请求体；

   3) 签名：按签名规则计算签名，并给签名参数 sign 字段赋值；

   4) 加密：按加解密规则对请求体加密；

   5) 发送请求：将请求头和加密后的请求体发送至接口地址即可获得加密后的响应；

   6) 解密：将加密后的响应按加解密规则解密即可获得明文场景识别结果；

   7) 接入成功标志：响应中 retCode 字段值为0或201001；

   8) 业务码：详细的retCode 说明可参考业务码说明；

   9) 同时也提供多种语言API接入SDK，可简化接入过程，详情参考SDK中的README.md。

3. 成功接入API后，数位商务同事将提供场景开始测试；

4. 测试通过后协商正式上线。

2 接口说明

2.1 场景识别单次请求接口

接口地址：https://api.jjfinder.com/v3/scene/api

通过POST方式提交数据到API需要使用测试AppID作为唯一标识，使用测试AppKey进行签名。

注意：请求接口的域名及AppID、AppKey请以商务邮件为准，正式上线时请使用生产的配置。

2.1.1接口参数说明

2.1.1.1设置请求头

在请求头中添加Authorization，值为场景识别单次请求接口 2.1.1.2 中参数内容拼接，格式如下：

t=%d;a=%s;

生成Authorization样例代码如下：

  public String authorization(){      
          return String.format("t=%d;a=%s;",timestamp, appId);  }  

添加请求头样例代码：

conn.setRequestProperty("Content-Type","application/json");
conn.setRequestProperty("Authorization",authorization);      

2.1.1.2 请求参数

定位请求必须参数：

序号	字段	数据 类型	是 否签名	含义
1	timestamp	Long	是	请求时间戳(ms)
2	appId	String	是	appId，由数位分配
3	oid	String	是	唯一标识 Android设备标识为IMEI号 iOS设备标识为IDFA
4	oidType	String	是	唯一标识符类型（数位最终值为小写保存） 1：IMEI 4：iOS设备IDFA
5	mac	String	是	mac地址/或者iOS IDFV
6	macType	String	是	3：MAC地址（默认缺省，可以不传）
7	networkMode	String	是	连网方式 0：unknown 1：WiFi 2：2G 3：3G 4：4G 5：5G
8	ssidEncode	Integer	是	ssid是否做base64加密(1加密0不加密)
9	osType	Integer	是	操作系统类型： 0：未知 1：Android 手机 2：IOS 手机 3：Android TV 4：苹果TV 5：Android 手表 6：IOS 手表 7：Android 平板 8：IOS 平板 9：车载
10	appChannel	Integer	是	流量来源的应用类型: 0：未知 1：app 2：微信小程序 3：支付宝小程序 4：百度小程序 5：头条小程序 6：快应用 7：设备操作系统集成 8：其他
11	passthrough	String	是	透传字段
12	sign	String	否	签名
13	signals	List	否	WiFi信号列表
13.1	bssid	String	否	信号bssid
13.2	rssi	Integer	否	信号强度（dBm）
13.3	ssid	String	否	信号名称
13.4	connectState	Integer	否	是否为连接信号(1连接，默认为null)
13.5	timestamp	Long	否	采集时间戳
13.6	band	Integer	否	频段（1:2.4G，2:5G）
13.7	channel	Integer	否	信道

连接基站信息：每次定位

14	baseStationList	List	否	基站信息列表，根据运营商情况填写具备的参数值
14.1	type	Integer	否	所属网络 0:未知, 1:GSM,2: CDMA,3:WCDMA ,4:LTE
14.2	mcc	Integer	否	移动国家代码 (GSM,CDMA,WCDMA,LTE)
14.3	mnc	Integer	否	移动网络号码 (GSM,CDMA,WCDMA,LTE)
14.4	lac	Integer	否	位置区域码 (GSM,WCDMA)
14.5	cid	Integer	否	UMTS小区身份(GSM,WCDMA)
14.6	tac	Integer	否	跟踪区域码 (LTE)
14.7	ci	Integer	否	小区标识(LTE)
14.8	pci	Integer	否	物理小区id (LTE)
14.9	psc	Integer	否	WCDMA主扰码(WCDMA)
14.10	sid	Integer	否	CDMA System ID (CDMA)
14.11	nid	Integer	否	Network ID (CDMA)
14.12	bid	Integer	否	Base Station ID (CDMA)
14.13	dBm	Integer	否	1毫瓦分贝数 (GSM,CDMA,WCDMA,LTE)
14.14	asuLevel	Integer	否	Asu信号单元 (GSM,CDMA,WCDMA,LTE)
14.15	level	Integer	否	信号格(GSM,CDMA,WCDMA,LTE)
14.16	timestamp	Long	否	采集时间戳
14.17	register	Integer	否	是否已注册
14.18	baseStationType	String	否	基站实例类型
14.19	earfcn	Integer	否	Android N 新增，绝对射频频道号(LTE)
14.20	bandWidth	Integer	否	小区带宽(LTE)
14.21	arfcn	Integer	否	Android N 新增，绝对射频频道号(GSM)
14.22	bsic	Integer	否	Android N 新增，基站识别码，物理小区id(GSM)
14.23	uarfcn	Integer	否	Android N 新增，绝对射频频道号(WCDMA)
14.24	rsrp	Integer	否	信号接收强度(LTE)
14.25	rsrq	Integer	否	信号接收质量(LTE)
14.26	rssnr	Integer	否	信噪比(LTE)
14.27	cqi	Integer	否	信道质量指标(LTE)
14.28	timingAdvance	Integer	否	时间提前量(GSM,LTE)
14.29	csiRsrp	Integer	否	csi信号接收强度(NR)
14.30	csiRsrq	Integer	否	csi信号接收质量(NR)
14.31	csiSinr	Integer	否	csi信噪比(NR)
14.32	ssRsrp	Integer	否	ss信号接收强度(NR)
14.33	ssRsrq	Integer	否	ss信号接收质量(NR)
14.34	ssSinr	Integer	否	ss信噪比(NR)
14.35	nci	Long	否	小区标识(NR)
14.36	nrarfcn	Integer	否	绝对射频频道号(NR)
14.37	bitErrorRate	Integer	否	误码率(GSM，WCDMA)
14.38	mCdmaDbm	Integer	否	电信2G Dbm
14.39	mCdmaEcio	Integer	否	电信2G Ec/Io)
14.40	mEvdoDbm	Integer	否	电信3G Dbm
14.41	mEvdoEcio	Integer	否	电信3G Ec/Io
14.42	mEvdoSnr	Integer	否	电信3G 信噪比

设备信息发送周期：每月首次

15	deviceInfo	Map	否	设备信息</