Web接口示例文檔

1、埋點API接口文檔V1.1 【埋點API】接口文檔版本(V1.0)2016年11月16目 錄1. 版本信息12. 文檔說明12.1 功能概述12.2 閱讀對象12.3 業(yè)務(wù)術(shù)語12.5接口地址13. 安全規(guī)范23.1 簽名機制23.2 簽名方式23.3 加解密機制23.4 加解密方式24.埋點接口24.1.基本埋點信息提交24.1.1業(yè)務(wù)功能24.1.1接口地址24.1.2 輸入?yún)?shù)列表24.1.3 返回參數(shù)列表34.2 拓展埋點信息提交44.1.1業(yè)務(wù)功能44.1.1接口地址54.1.2 輸入?yún)?shù)列表54.1.3 返回參數(shù)列表51. 版本信息編號文檔版本編寫/修訂章節(jié)修改內(nèi)容修訂人修訂日期1

2、V1.0創(chuàng)建文檔全文2016/11/72. 文檔說明2.1 功能概述為收集提供埋點，以便把客戶端收集的埋點信息存入后臺。2.2 閱讀對象本文檔面向具有開發(fā)能力，需要參與埋點的開發(fā)和管理人員。2.3 業(yè)務(wù)術(shù)語埋點：用來監(jiān)控用戶點擊的每一步，記錄這些信息。2.5接口地址接口基本地址： mobileApiBaseUrl：http:/*聯(lián)調(diào)地址: mobileApiBaseUrl：http:/*3. 安全規(guī)范3.1 簽名機制 簽名使用md5加密，簽名通過則可以調(diào)用接口進行埋點數(shù)據(jù)提交。3.2 簽名方式Sign:name+”鹽值” ,MD5 加密 32為 不夠長度 前面補0。Server使用鹽值：lba

3、_point_apply鹽值可變，變動會通知3.3 加解密機制3.4 加解密方式4.埋點接口4.1.基本埋點信息提交4.1.1業(yè)務(wù)功能基本埋點信息提交時調(diào)用4.1.1接口地址接口地址：mobileApiBaseUrlburiedPoint/*訪問方式： post4.1.2 輸入?yún)?shù)列表字段名中文名類型示例描述是否必填mobile手機號String(支持手機校驗)是sign簽名String32位md5加密是clientType客戶端類型Integer1.app；2.h5；3.server簽名認證區(qū)別處理使用,這里的客戶端是指提交埋點數(shù)據(jù)的端。是sex性別Integer10 未知，1 男，2 女n

4、ame姓名String（64）mobileModel手機型號String（64）resolutionWidth分辨率寬Integer（7位整數(shù)）此2參數(shù)要傳必須一起傳，resolutionHeight分辨率高Integer(7位整數(shù))operatingSystem操作系統(tǒng)String(128)idCode識別碼String(128)applicationVersion應(yīng)用版本String(64)browser瀏覽器String(64)extranetIp外網(wǎng)IPString39支持ipv4和ipv6是downNetworkType下載網(wǎng)絡(luò)類型String(64)brows

5、eNetworkType訪問網(wǎng)絡(luò)類型String(64)operateTime操作時間String2016-11-07 01:10:01日期和小時之間只有且只有一個空格，也可以不滿足只要jdk解析獲得準(zhǔn)確的年月日時分秒即可是longitude經(jīng)度Double9999以內(nèi)正負數(shù)，10位以內(nèi)小數(shù)要傳一起傳latitude緯度Double9999以內(nèi)正負數(shù)，10位以內(nèi)小數(shù)address地理位置String(255)tokenTokenString（128）shanyinremark備注StringrequestCheck傳參檢驗Integer開發(fā)調(diào)試使用1.返回參數(shù)校驗結(jié)果。聯(lián)調(diào)時使用否suppor

6、tedParams支持接收的參數(shù)Integer開發(fā)調(diào)試使用1.返回支持的參數(shù)列表。聯(lián)調(diào)時使用否參數(shù)說明：參數(shù)requestCheck和supportedParams在聯(lián)調(diào)時使用，里面設(shè)置開關(guān)，進入生成后關(guān)閉開關(guān)失效，有問題必要時開啟開關(guān)，驗證問題。4.1.3 返回參數(shù)列表字段名數(shù)據(jù)類型示例描述statusInteger0返回狀態(tài)，0表示成功messageString成功返回消息說明checkResultMap檢驗結(jié)果，如果傳requestCheck=1，則返回，便于聯(lián)調(diào)參數(shù)說明： 這里主要說明checkResult,按照如下規(guī)則返回 "ownRequestProperties&quo

7、t;: "propertyName": "mobile", "propertyChName": "手機號碼", "propertyValue": "13976", "requestPropertyCheckState": "參數(shù)名大小寫錯誤，傳遞為:moBile,系統(tǒng)要求：mobile;參數(shù)值：不滿足手機格式要求" , "propertyName": "extranetIp", "pro

8、pertyChName": "外網(wǎng)Ip", "propertyValue": "13976", "requestPropertyCheckState": "參數(shù)值：不滿足ip格式要求" ownRequestProperties為請求端實際所傳的參數(shù)列表，通過這個結(jié)果可以快速檢查使用接口過程中可能出現(xiàn)的問題，免去過量的溝通成本。設(shè)定是只要requestPropertyCheckState為ok,就算所傳參數(shù)通過。參數(shù)一旦通過，接口將正常保存信息。當(dāng)通過這個接口仍然無法解決問題時，再進入人

9、工溝通解決。 目前聯(lián)調(diào)信息主要是ownRrequestProperties做輔助，有其他返回信息必要再另行通知。4.1.4 相關(guān)數(shù)據(jù)庫表CREATE TABLE basic_point ( id bigint(20) NOT NULL AUTO_INCREMENT COMMENT '標(biāo)識', mobile varchar(18) DEFAULT NULL COMMENT '手機', client_type int(3) DEFAULT NULL COMMENT '客戶端類型', sex int(3) DEFAULT NULL COMMENT &#

10、39;性別', name varchar(64) DEFAULT NULL COMMENT '姓名', mobile_model varchar(64) DEFAULT NULL COMMENT '手機型號', resolution_width int(8) DEFAULT NULL COMMENT '分辨率寬', resolution_height int(8) DEFAULT NULL COMMENT '分辨率高', operating_system varchar(128) DEFAULT NULL COMMENT

11、'操作系統(tǒng)', id_code varchar(128) DEFAULT NULL COMMENT '識別碼', application_version varchar(64) DEFAULT NULL COMMENT '應(yīng)用版本', browser varchar(64) DEFAULT NULL COMMENT '瀏覽器', extranet_ip varchar(255) DEFAULT NULL COMMENT '外網(wǎng)Ip', down_network_type varchar(64) DEFAULT NU

12、LL COMMENT '下載網(wǎng)絡(luò)類型', browse_network_type varchar(64) DEFAULT NULL COMMENT '訪問網(wǎng)絡(luò)類型', operate_time datetime DEFAULT NULL COMMENT '操作時間', longitude decimal(10,6) DEFAULT NULL COMMENT '經(jīng)度', latitude decimal(10,6) DEFAULT NULL COMMENT '緯度', address varchar(255) DEF

13、AULT NULL COMMENT '地理位置', token varchar(128) DEFAULT NULL COMMENT 'token', created_at datetime NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '創(chuàng)建時間', PRIMARY KEY (id) ENGINE=InnoDB AUTO_INCREMENT=2 DEFAULT CHARSET=utf8 COMMENT='基本埋點信息表'4.2 拓展埋點信息提交4.2.1業(yè)務(wù)功能拓展埋點信息提交調(diào)用4.2.2

14、接口地址接口地址：mobileApiBaseUrl/buriedPoint/*訪問方式： post4.2.3 輸入?yún)?shù)列表字段名中文名類型示例描述是否必填mobile手機號String(手機校驗)是sign簽名String32位md5加密是clientType客戶端類型Integer1.app,2.h5,3.service簽名認證區(qū)別處理使用,這里的客戶端是指提交埋點數(shù)據(jù)的端。是pageId頁面IDString（128）pageRemark頁面中文名StringpageUrl頁面URLString(1000)firstActivation首次激活String(64)eventId事件IDStr

15、ing(64)eventRemark事件中文名StringpreviousPage上一頁面String(1000)currentPage當(dāng)前頁面String(1000)label標(biāo)簽String(64)parameter參數(shù)String(1000)stayId停留IDString(64)stayTimes停留時間Integer(20)19位以內(nèi)正整數(shù)秒數(shù)operateTime操作時間String2016-11-07 01:10:01日期和小時之間只有且只有一個空格，也可以不滿足只要jdk解析獲得準(zhǔn)確的年月日時分秒即可是viewportViewportString(255)cursorcurso

16、rString(64)actionactionString(64)remark備注StringrequestCheck傳參檢驗Integer1.返回參數(shù)校驗結(jié)果。否supportedParams支持接收的參數(shù)Integer1.返回支持的參數(shù)列表。否參數(shù)說明：參數(shù)requestCheck和supportedParams在聯(lián)調(diào)時使用，里面設(shè)置開關(guān)，進入生成后關(guān)閉開關(guān)失效，有問題必要時開啟開關(guān)，驗證問題。4.2.4 返回參數(shù)列表字段名中文名類型示例statusInteger0返回狀態(tài)，0表示成功messageString成功返回消息說明checkResultMap檢驗結(jié)果，如果傳requestChe

17、ck=1，則返回，便于聯(lián)調(diào) 參數(shù)說明： checkResult和埋點基本信息接口的結(jié)果值checkResult相同4.2.5相關(guān)數(shù)據(jù)庫表CREATE TABLE expand_point ( id bigint(20) NOT NULL AUTO_INCREMENT COMMENT '標(biāo)識', mobile varchar(18) NOT NULL COMMENT '手機', client_type int(3) DEFAULT NULL COMMENT '客戶端類型', page_id varchar(128) DEFAULT NULL COM

18、MENT '頁面ID', page_url varchar(1000) DEFAULT NULL COMMENT '頁面URL', first_activation varchar(64) DEFAULT NULL COMMENT '首次激活', event_id varchar(64) DEFAULT NULL COMMENT '事件ID', previous_page varchar(1000) DEFAULT NULL COMMENT '上一頁面', current_page varchar(1000) DE

19、FAULT NULL COMMENT '當(dāng)前頁面', page_label varchar(64) DEFAULT NULL COMMENT '標(biāo)簽', parameter varchar(1000) DEFAULT NULL COMMENT '參數(shù)', stay_id varchar(64) DEFAULT NULL COMMENT '停留ID', stay_times bigint(20) DEFAULT NULL COMMENT '停留時間', viewport varchar(255) DEFAULT NU

20、LL COMMENT 'viewport', page_cursor varchar(64) DEFAULT NULL COMMENT 'cursor', action varchar(64) DEFAULT NULL COMMENT 'action', created_at datetime NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '創(chuàng)建時間', PRIMARY KEY (id) ENGINE=InnoDB AUTO_INCREMENT=2 DEFAULT CHARSET=utf8

21、COMMENT='拓展埋點信息表'4.3基本埋點信息批量提交4.3.1業(yè)務(wù)功能基本埋點信息提交時調(diào)用4.3.1接口地址接口地址：mobileApiBaseUrlburiedPoint/ *訪問方式： post4.3.2 輸入?yún)?shù)列表字段名中文名類型示例描述是否必填mobile手機號String(支持手機校驗)是sign簽名String32位md5加密是clientType客戶端類型Integer1.app；2.h5；3.server簽名認證區(qū)別處理使用,這里的客戶端是指提交埋點數(shù)據(jù)的端。是basicPointListJson基本埋點信息數(shù)組對象是對象屬性sex性別Integer

22、10 未知，1 男，2 女name姓名String（64）mobileModel手機型號String（64）resolutionWidth分辨率寬Integer（7位整數(shù)）此2參數(shù)要傳必須一起傳，resolutionHeight分辨率高Integer(7位整數(shù))operatingSystem操作系統(tǒng)String(128)idCode識別碼String(128)applicationVersion應(yīng)用版本String(64)browser瀏覽器String(64)extranetIp外網(wǎng)IPString39支持ipv4和ipv6是downNetworkType下載網(wǎng)絡(luò)類型S

23、tring(64)browseNetworkType訪問網(wǎng)絡(luò)類型String(64)operateTime操作時間String2016-11-07 01:10:01日期和小時之間只有且只有一個空格，也可以不滿足只要jdk解析獲得準(zhǔn)確的年月日時分秒即可是longitude經(jīng)度Double9999以內(nèi)正負數(shù)，10位以內(nèi)小數(shù)要傳一起傳latitude緯度Double9999以內(nèi)正負數(shù)，10位以內(nèi)小數(shù)address地理位置String(255)tokenTokenString（128）shanyinremark備注String4.3.3 返回參數(shù)列表字段名數(shù)據(jù)類型示例描述statusInteger0返

24、回狀態(tài)，0表示成功messageString成功返回消息說明4.3.4 相關(guān)數(shù)據(jù)庫表basic_point4.4 拓展埋點信息批量提交4.4.1業(yè)務(wù)功能拓展埋點信息提交調(diào)用4.4.2接口地址接口地址：mobileApiBaseUrl/buriedPoint/*訪問方式： post4.4.3 輸入?yún)?shù)列表字段名中文名類型示例描述是否必填mobile手機號String(手機校驗)是sign簽名String32位md5加密是clientType客戶端類型Integer1.app,2.h5,3.service簽名認證區(qū)別處理使用,這里的客戶端是指提交埋點數(shù)據(jù)的端。是expandPointListJson拓展數(shù)組