彩印開放平臺(tái)需求v2

1、彩印開放概述1.彩印開放向第提供了對(duì)彩印用戶的彩印信息進(jìn)行查詢、修改等功能接口，以便第業(yè)務(wù)功能可以與彩印業(yè)務(wù)功能進(jìn)行融合。彩印開放接口主要有 API 接口及網(wǎng)頁組件兩種方式，其中 API 接口主要提供第服務(wù)端以及客戶端應(yīng)用；網(wǎng)頁組件主要提供WEB使用。2. Oauth 登錄彩印門戶開放 api 采納的 OAuth2.0 標(biāo)準(zhǔn)協(xié)議來完成用戶驗(yàn)證與。想了解OAuth2.0 的技術(shù)說明可參看(英文) ()彩印門戶支持 OAuth2.0 中 Authentication Code 方式，又稱 Web Server Flow，適用于所有有 Server 端配合的應(yīng)用和無 Server 端應(yīng)用。按此方式獲

2、取 Acs Token。下面介紹 OAuth2.0 來完成驗(yàn)證與。2.1. 流程彩印門戶登錄 OAuth2.0 的處理流程主要包括以下 3 個(gè)步驟：2.1.1. 獲取 Authorization Code；在彩印門戶 web/wap登錄界面，輸入用戶名，/隨機(jī)碼，登錄成功后;用戶點(diǎn)擊確認(rèn)后，返回給第碼 Authorization Code；2.1.2. 通過 Authorization Code 獲取 Acs Token第應(yīng)用需要保存這個(gè) Token 供后續(xù)使用，Acs Token 過期時(shí)間默認(rèn)為 2 年2.1.3. 根據(jù)用戶s_token 調(diào)用 OpenAPI，來請(qǐng)求或修改ac的資源（例如用

3、戶彩印設(shè)置信息，設(shè)置用戶通用彩印 等信息）。具體接口請(qǐng)見第 3 章節(jié)2.2. 流程圖其驗(yàn)證流程示意圖如下對(duì)于應(yīng)用而言，需要進(jìn)行兩步：1. 獲取 Authorization Code；2. 通過 Authorization Code 獲取 Acs Token2.3. 登錄獲取 Acs_token 詳解2.3.1. Step1：獲取 Authorization Code請(qǐng)求地址將您的請(qǐng)求發(fā)送到：請(qǐng)求參數(shù)示例：EADDDDOADCQTEV&redirect_uri=htt &portalType=1/&response_type=code處理邏輯（1）界面：參數(shù)是否必須含義response_type

4、必須類型，此值固定為：codecnt_id必須彩印系統(tǒng)分配給第接入的應(yīng)用 ap。redirect_uri必須成功后的回調(diào)地址，這里為第的地址portalType可選默認(rèn)值為 0，表示 web 門戶接入，返回 web 登錄授權(quán)頁面如果為 wap 門戶接入，請(qǐng)傳入數(shù)字 1，返回 wap2.0登錄頁面（2）如果用戶成功Authorization Code。，則會(huì)跳轉(zhuǎn)到指定的回調(diào)地址，并在 redirect_uri 地址后帶上如：htt.hk/?code=mYG7QD第，可通過獲取回調(diào)地址中的參數(shù) code，獲取碼的值，以便進(jìn)行下一步操作（4）取消或異常時(shí)響應(yīng)：htt.hk/?error=acs_de

5、nied&error_description=User%20denied%20authorization%20of%20the%20authorization%20code.2.3.2. Step2：通過 Authorization Code 獲取 Acs Token請(qǐng)求地址HTTP 請(qǐng)求方式T響應(yīng) content-typeapplication/json請(qǐng)求參數(shù)成功返回結(jié)果JSON示例參數(shù)是否必須含義grant_type必須類型，此值固定為：authorization_codecnt_id必須彩印系統(tǒng)分配給第接入的應(yīng)用 t_secret必須彩印系統(tǒng)分配給第的應(yīng)用 appkey。co

6、de必須上一步返回的 authorization code。如果用戶成功登錄并，則會(huì)跳轉(zhuǎn)到指定的回調(diào)地址，并在 URL 中帶上 Authorization Code。例如，回調(diào)地址為 htt.hk/，則跳轉(zhuǎn)到：htt.hk/?code=mYG7QD 而code 值就為 mYG7QDD注意此 code 會(huì)在幾分鐘后過期。redirect_uri必須與上面一步中傳入的redirect_uri 保持一致。關(guān)于錯(cuò)誤返回值與錯(cuò)誤代碼，參見 異常碼與錯(cuò)誤碼說明字段說明（新增）3.3.1. 功能說明功能主要是為了支持用戶更方便、更安全的實(shí)現(xiàn)對(duì)第的，以便更容易引入第內(nèi)容。返回值字段字段類型字段說明acs_to

7、kenstringtoken 值expires_inotoken 失效時(shí)間，為：分鐘，默認(rèn)為 2 年acs_token: be845a3d-1093-4c27-930e-b5d82cf27e76, expires_in: 259199,3.2. 流程說明2）請(qǐng)求參數(shù)3）返回結(jié)果4. 開放接口4.1. OpenAPI 接口OpenAPI 接口主要提供第及客戶端應(yīng)用對(duì)彩印用戶的彩印業(yè)務(wù)內(nèi)容進(jìn)行相關(guān)操作，服務(wù)應(yīng)用接口調(diào)用均基于 OAuth2.0 鑒權(quán)模式。OpenAPI 接口接口說明open/getMobileNumber獲取用戶號(hào)碼。open/getCyInfo查詢用戶當(dāng)前設(shè)置的彩印內(nèi)容。open

8、/setCyInfo修改用戶當(dāng)前的彩印內(nèi)容設(shè)置，只能修改為單條彩印內(nèi)容。open/setSpellyCy把內(nèi)容設(shè)置為個(gè)人專屬彩印。open/AddMyCy把內(nèi)容加入個(gè)人彩印中。open/invite邀請(qǐng)好友開通彩印。返回值字段字段類型字段說明acs_tokenstringtoken 值expires_inotoken 失效時(shí)間，為：分鐘，默認(rèn)為 2 年字段類型及范圍說明請(qǐng)求來源，第應(yīng)用申請(qǐng)的appkeysourtringancodestring由彩印分配給第的機(jī)構(gòu)碼mobileNumstring需要查詢機(jī)號(hào)碼HTTP 請(qǐng)求方式GET是否需要是4.1.1. open/getMobileNumbe

9、r1）接口描述2）請(qǐng)求參數(shù)3）返回結(jié)果4.1.2. open/getCyInfo1）接口描述2）請(qǐng)求參數(shù)字段類型及范圍說明請(qǐng)求來源，第應(yīng)用申請(qǐng)的appkeysourtringbearer_tokenstring用戶登錄后，用碼獲取的Acs_token 值功能說明獲取用戶當(dāng)前設(shè)置的彩印內(nèi)容，包括單條彩印內(nèi)容及彩印盒兩種方式URL待定支持格式JSONHTTP 請(qǐng)求方式GET是否需要是返回值字段字段類型字段說明mobileNumstring彩印用戶號(hào)碼字段類型及范圍說明請(qǐng)求來源，第應(yīng)用申請(qǐng)的appkeysourtringbearer_tokenstring用戶登錄后，用碼獲取的Acs_token 值

10、功能說明獲取用戶號(hào)碼URL待定支持格式JSONHTTP 請(qǐng)求方式GET是否需要是3）返回結(jié)果signPacakage彩印盒對(duì)象字段說明：4.1.3. open/setCyInfo1）接口描述2）請(qǐng)求參數(shù)字段類型及范圍說明請(qǐng)求來源，第應(yīng)用申請(qǐng)的appkeysourtring功能說明修改用戶當(dāng)前的彩印內(nèi)容設(shè)置，只能修改為單條彩印內(nèi)容，如果用戶當(dāng)前為彩印盒，同時(shí)也會(huì)修改為單條彩印內(nèi)容方式。URL待定支持格式JSONHTTP 請(qǐng)求方式GET是否需要是返回值字段字段類型字段說明idstring彩印盒 idnamestring彩印盒名稱descstring信息categoryIDstring彩印盒所屬分類

11、 idgroupDescstring分類描述groupNamestring分類名稱signs數(shù)組彩印列表effectiveTimestring生效時(shí)間failureTimestring失效時(shí)間susstring彩印盒狀態(tài) 0 失效，1 正常susNamestring狀態(tài)描述返回值字段字段類型字段說明signContentstring當(dāng)前用戶通用彩印內(nèi)容，與 signPackage 兩個(gè)屬性中，必有一個(gè)為空signPacakageobject彩印盒詳情cyUsertrue 表示，用戶為彩印業(yè)務(wù)用戶false 表示，用戶已經(jīng)注銷彩印業(yè)務(wù)/尚未開通彩印3）返回結(jié)果4.1.4. open/setSpe

12、llyCy1）接口描述2）請(qǐng)求參數(shù)3）返回結(jié)果4.1.5. open/AddMyCy1）接口描述功能說明把內(nèi)容加入個(gè)人彩印。URL待定返回值字段字段類型字段說明resultCodestring200 表示操作成功字段類型及范圍說明sourtring請(qǐng)求來源，第應(yīng)用申請(qǐng)的appkeybearer_tokenstring 用戶登錄后，用碼獲取的Acs_token 值mobileNumstring需要設(shè)置專屬彩印的移動(dòng)號(hào)碼signContentstring彩印內(nèi)容，52 個(gè)字符功能說明為彩印用戶設(shè)置專屬彩印。URL待定支持格式JSONHTTP 請(qǐng)求方式GET是否需要是返回值字段字段類型字段說明res

13、ultCodestring200 表示操作成功bearer_tokenstring 用戶登錄后，用碼獲取的Acs_token 值signContentstring彩印內(nèi)容，52 個(gè)字符2）請(qǐng)求參數(shù)3）返回結(jié)果4.1.6. open/invite1）接口描述2）請(qǐng)求參數(shù)3）返回結(jié)果返回值字段字段類型字段說明resultCodestring200 表示操作成功字段類型及范圍說明sourtring請(qǐng)求來源，第應(yīng)用申請(qǐng)的appkeybearer_tokenstring 用戶登錄后，用碼獲取的Acs_token 值mobileNumstring需要邀請(qǐng)開通彩印業(yè)務(wù)機(jī)號(hào)碼功能說明邀請(qǐng)好友開通彩印業(yè)務(wù)。UR

14、L待定支持格式JSONHTTP 請(qǐng)求方式GET是否需要是返回值字段字段類型字段說明resultCodestring200 表示操作成功字段類型及范圍說明sourtring請(qǐng)求來源，第應(yīng)用申請(qǐng)的appkeybearer_tokenstring 用戶登錄后，用碼獲取的Acs_token 值signContentstring彩印內(nèi)容，52 個(gè)字符支持格式JSONHTTP 請(qǐng)求方式GET是否需要是（新增）4.1.7. open/ tran1）接口描述2）請(qǐng)求參數(shù)3）返回結(jié)果4.2.頁面組件頁面由于是直接調(diào)用彩印開放頁面，所以不需要進(jìn)行 acs_token 鑒權(quán)。點(diǎn)擊網(wǎng)頁組件后彈出操作窗口，在彈出操作窗

15、口可以完成以下功能：修改個(gè)人彩?。褐苯影褍?nèi)容設(shè)置為個(gè)人的彩印，只支持設(shè)置為單條彩印內(nèi)容；設(shè)置專屬彩?。褐苯釉O(shè)置為針對(duì)好友的專屬彩印；加入彩?。褐苯影褍?nèi)容加入個(gè)人的彩印中；開通彩印業(yè)務(wù)：彩印向用戶下發(fā)開通指引，用戶按照指引回復(fù)即可開通彩印業(yè)務(wù)。1）網(wǎng)頁組件嵌入網(wǎng)頁后的效果如下圖，紅色方框圖標(biāo)為微組件的圖標(biāo)返回值字段字段類型字段說明resultCodestring200 表示操作成功字段類型及范圍說明sourtring請(qǐng)求來源，第應(yīng)用申請(qǐng)的appkeymobileNumstring需要觸發(fā)開通彩印業(yè)務(wù)機(jī)號(hào)碼功能說明支持用戶通過第觸發(fā)彩印下發(fā)開通指引，用戶回復(fù)即可開通業(yè)務(wù)URL待定支持格式JSONH

16、TTP 請(qǐng)求方式GET是否需要是2）點(diǎn)擊組件彈出頁面如下：“設(shè)為個(gè)人彩印”界面內(nèi)容“設(shè)為專屬彩印”界面內(nèi)容“加入彩印”界面內(nèi)容5. SMC 管理5.1. 開發(fā)者管理管理員可以對(duì)開發(fā)者進(jìn)行以下管理操作：開發(fā)者查詢：管理員可以按照開發(fā)者名稱、開發(fā)者帳號(hào)、時(shí)間等多種方式查詢開發(fā)者及詳情。開發(fā)者禁用：管理員查詢到具體的開發(fā)者后，可以對(duì)開發(fā)者進(jìn)行禁用。開發(fā)者被禁用后，其相關(guān)的應(yīng)用也會(huì)被禁用，即用戶無法通過開發(fā)者的應(yīng)用與開放交互。開發(fā)者恢復(fù)：管理員可以對(duì)被禁用的開發(fā)者予以恢復(fù)，開發(fā)者回復(fù)的同時(shí)，其同時(shí)被禁用的應(yīng)用也會(huì)跟著恢復(fù)正常。開發(fā)者刪除：管理員可以刪除開發(fā)者，刪除開發(fā)者并非真正刪除其資料，只是置為無效

17、狀態(tài)，隱藏顯示。5.2. 應(yīng)用管理管理員可以根據(jù)關(guān)鍵字、時(shí)間、開發(fā)者帳號(hào)等信息查詢應(yīng)用，并可以點(diǎn)擊查詢應(yīng)用詳情。信息包括：開發(fā)者名稱應(yīng)用名稱應(yīng)用類型（網(wǎng)頁應(yīng)用、應(yīng)用）應(yīng)用分類：按照應(yīng)用的性質(zhì)分類，如趣味、資訊、社交等狀態(tài)應(yīng)用詳情包括：開發(fā)者名稱開發(fā)者帳號(hào)appkey應(yīng)用類型應(yīng)用分類狀態(tài)應(yīng)用簡(jiǎn)介網(wǎng)頁代碼（如非網(wǎng)頁應(yīng)用，該部分內(nèi)容為空）管理員可以對(duì)應(yīng)用進(jìn)行禁用與恢復(fù)，禁用后相關(guān)應(yīng)用接口、網(wǎng)頁調(diào)用都將無效。5.3.管理管理員可以登錄 SMC 按號(hào)碼查詢彩印用戶的開放情況，并可以為用戶取消。查詢信息包括：序號(hào)號(hào)碼應(yīng)用名稱時(shí)間失效時(shí)間狀態(tài)（正常、取消）管理員可以根據(jù)用戶要求，為用戶取消應(yīng)用。6. 彩印門

18、戶彩印門戶（包括 WEB、WAP、客戶端）提供開放管理功能，支持彩印用戶查詢個(gè)人對(duì)第應(yīng)用的情況，并可以自行取消對(duì)第應(yīng)用的。7. 門戶彩印開放采用相對(duì)獨(dú)立的門戶，通過在當(dāng)前彩印門戶頂部加“開放”，跳轉(zhuǎn)到開放。如下圖7.1.架構(gòu)開放門戶主要分為四大部分內(nèi)容：首頁：關(guān)于開放的說明，以及展現(xiàn)其余幾大部分的導(dǎo)航頁面；開發(fā)者：申請(qǐng)開發(fā)者、修改開發(fā)者資料；接入指南：包括接入指南、接入指南、API 接口說明等；創(chuàng)建應(yīng)用：開發(fā)者申請(qǐng)創(chuàng)建應(yīng)用，為各個(gè)應(yīng)用分配appkey；網(wǎng)頁應(yīng)用組件代碼創(chuàng)建。7.2.登錄開發(fā)者需要使用申請(qǐng)的開發(fā)者帳號(hào)及登錄開放，才能進(jìn)行以下操作：編輯開發(fā)者信息創(chuàng)建應(yīng)用查看開放其他內(nèi)容則不需要登錄

19、。7.3. 開發(fā)者7.3.1. 成為開發(fā)者如果用戶尚未登錄，通過首頁的“成為開發(fā)者”模塊可以進(jìn)入開發(fā)者申請(qǐng)頁面，用戶填寫完必要的信息并提交驗(yàn)證，驗(yàn)證通過后將正式成為開發(fā)者。對(duì)于企業(yè)開發(fā)者及個(gè)人開發(fā)者，填寫的信息分別如下：1） 個(gè)人開發(fā)者需要填寫的信息包括（帶紅色星號(hào)為必填）：帳號(hào)*號(hào)碼*郵箱*所在地區(qū)個(gè)人2） 企業(yè)開發(fā)者需要填寫的信息包括（帶紅色星號(hào)為必填）：開發(fā)者帳號(hào)*公司全稱*號(hào)*公司地址*公司*聯(lián)系人*聯(lián)系人*聯(lián)系人郵箱*公司7.3.2. 編輯開發(fā)者信息開發(fā)者登錄開放后，可以進(jìn)入“編輯開發(fā)者信息”頁面瀏覽開發(fā)者信息及對(duì)部分信息進(jìn)行修改?！熬庉嬮_發(fā)者信息”頁面展示個(gè)人及企業(yè)開發(fā)者信息如下：

20、1）個(gè)人開發(fā)者（*號(hào)標(biāo)識(shí)部分內(nèi)容可修改）帳號(hào)*號(hào)碼*郵箱*所在地區(qū)*個(gè)人*2）企業(yè)開發(fā)者（*號(hào)標(biāo)識(shí)部分內(nèi)容可修改）開發(fā)者帳號(hào)*公司全稱號(hào)公司地址*公司*聯(lián)系人*聯(lián)系人*聯(lián)系人郵箱*公司*7.4. 應(yīng)用管理應(yīng)用7.4.1.“應(yīng)用”頁面供開發(fā)者查詢目前個(gè)人已經(jīng)創(chuàng)建的應(yīng)用，并可以查詢每個(gè)應(yīng)用的詳細(xì)信息，以及刪除應(yīng)用（隱藏應(yīng)用）。應(yīng)用包括信息有：應(yīng)用名稱應(yīng)用類型：網(wǎng)頁應(yīng)用、應(yīng)用應(yīng)用分類：按照應(yīng)用的性質(zhì)分類，如趣味、資訊、社交等點(diǎn)擊，可以打開具體的應(yīng)用詳情，內(nèi)容包括：appkey應(yīng)用名稱應(yīng)用類型：網(wǎng)頁應(yīng)用、應(yīng)用應(yīng)用分類：按照應(yīng)用的性質(zhì)分類，如趣味、資訊、社交等應(yīng)用簡(jiǎn)介組件代碼（如非網(wǎng)頁應(yīng)用，該部分內(nèi)容為空）7.4.2. 創(chuàng)建應(yīng)用開發(fā)者可以創(chuàng)建兩類應(yīng)用