SAAS企业数据服务项目

详细内容

API互联说明

API互联说明

窗口平台接口说明

一、 接口地址

接口采用WebService技术实现,地址如下:

http://api.dlsme.cn/services/collector

二、 实施步骤

数据上报系列方法会验证报送服务器IP地址是否合法允许授权IP地址报送数据,报送数据时需在Header中提交平台下发的表明报送系统身份的token。

步骤一:报备上报服务器IP地址

通过HTTP方式上报数据的平台,需向大数据资源管理平台报备IP地址,大数据资源管理平台将配发上报数据时表明身份的token。 

上报数据时,调用

http://api.dlsme.cn/services/collector

Basic Authentication的方式提交token信息, 并指定数据格式为sourcetype:_json, 数据event如下:

curl -k http://api.dlsme.cn/services/collector -u 'bigdata:ca5b3c41-a2ed-4fff-9e8d-45d57b4a8b11'   -d '{"sourcetype": "_json", "event": {"a": "value1", "b": ["value1_1", "value1_2"]}}{"sourcetype": "_json", "event": {"a": "value2", "b": ["value2_1", "value2_2"]}}{"sourcetype": "_json", "event": {"a": "value3", "b": ["value3_1", "value3_2"]}}'

步骤二:生成JSON格式数据

将单条待上报数据生成对应JSON格式字符串,该字符串仅可包含一条数据, JSON 为一个event上传上报的图片或视频以url格式上传。

例如上报一条窗口平台数据:

{"sourcetype": "_json",

"event": {

  "id" : "20180308101010_0001",

  "action" : "add",

  "title" : "文章标题1",

  "author" : "作者1",

  "create_time" : "2018-03-14 16:00:00",

  "type" : "文章分类1",

  "phone" : "联系电话",

  "content" : "内容",

  "photo" : " http://www.test.com/img/logo.jpg ",

  "email" : "test@163.com",

  "address" : "XXXX111107-1108",

  "contacts" : "张三"}

   }

黄色背景为必填项,event中具体字段可根据实际增减。

id为源数据库中对应数据的唯一编号,字符串格式,长度不超过36个字符。

action为要进行的操作,可以是add、delete、update三个值,分别插入、删除、更新。

一次上报请求,可提交多条数据但多条数据中的id不能重复例如

{"sourcetype": "_json",

"event": {

  "id" : "20180308101010_0002",

  "action" : "add",

  "title" : "文章标题1",

  "author" : "作者1",

  "create_time" : "2018-03-14 16:00:00",

  "type" : "文章分类1",

  "phone" : "联系电话",

  "content" : "内容",

  "photo" : " http://www.test.com/img/logo.jpg ",

  "email" : "test@163.com",

  "address" : "XXXX111107-1108",

  "contacts" : "张三"}

   }{"sourcetype": "_json",

"event": {

  "id" : "20180308101010_0003",

  "action" : "add",

  "title" : "文章标题2",

  "author" : "作者2",

  "create_time" : "2018-03-14 16:00:00",

  "type" : "文章分类2",

  "phone" : "联系电话",

  "content" : "内容",

  "photo" : " http://www.test.com/img/logo.jpg ",

  "email" : "test@163.com",

  "address" : "XXXX111107-1108",

  "contacts" : "李四"}

   }

 

如果IPtoken的值不正确,或上传的数据不争取,会报以下错:

Status

Code

HTTP status

code ID

HTTP status code

Status message

0

200

OK

Success

1

403

Forbidden

Token disabled

2

401

Unauthorized

Token is required

3

401

Unauthorized

Invalid authorization

4

403

Forbidden

Invalid token

5

400

Bad Request

No data

6

400

Bad Request

Invalid data format

7

400

Bad Request

Incorrect index

8

500

Internal Error

Internal server error

9

503

Service Unavailable

Server is busy

10

400

Bad Request

Data channel is missing

11

400

Bad Request

Invalid data channel

12

400

Bad Request

Event field is required

13

400

Bad Request

Event field cannot be blank

14

400

Bad Request

ACK is disabled

15

400

Bad Request

Error in handling indexed fields

16

400

Bad Request

Query string authorization is not enabled

 

三、 联系人及联系方式

1. 技术支持:沈宏岩

2. 联系电话:15040495255

3. QQ8633351


最新评论
请先登录才能进行回复登录
×