彩印開放平臺需求v2

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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