劇院數字化服務系統(tǒng)接口規(guī)范

1劇院數字化服務系統(tǒng)接口規(guī)范本標準規(guī)定了劇院數字化服務系統(tǒng)建設中的通用信息交互要求和基本原則。本標準適用于劇院數字化服務系統(tǒng)建設中的基礎接口設計、ERP系統(tǒng)接口設計、顧客平安系統(tǒng)接口設計、微網站接口設計、會員卡管理系統(tǒng)接口設計、票務管理系統(tǒng)接口設計以及停車場管理系統(tǒng)接口設計要求。2規(guī)范性引用文件下列文件對于本文件的應用是必不可少的。凡是注日期的引用文件，僅注日期的版本適用于本文件。凡是不注日期的引用文件，其最新版本（包括所有的修改單）適用于本文件。GB/T8566-2007軟件生存周期過程GB/T8567-2006計算機軟件文檔編制規(guī)范GB/T11457-2006信息技術軟件工程術語GB/T15126-2008信息技術開放系統(tǒng)互連網絡服務定義GB/T15532-2008計算機軟件測試規(guī)范GB/T18726-2011現(xiàn)代設計工程集成技術的軟件接口規(guī)范3術語和定義下列術語和定義適用于本文件3.1劇院數字化服務系統(tǒng)digitalservicesystemfortheaters劇院數字化服務系統(tǒng)，是指通過以物聯(lián)網、云計算、大數據等新一代信息技術的應用，達到提升劇院顧客服務品質，支撐強化劇院管理系統(tǒng)，完善劇院營銷體系的目的。3.2接口interface接口是計算機系統(tǒng)中兩個獨立的部件進行信息交換的共享邊界。這種交換可以發(fā)生在計算機軟、硬件，外部設備或進行操作的人之間，也可以是它們的結合。3.3微網站micro-site微網站指源于WebApp和網站的融合創(chuàng)新，兼容iOS、android、WP等各大操作系統(tǒng)，可以方便的與微信、微博等應用的鏈接，適應移動顧客端瀏覽市場對瀏覽體驗與交互性能要求的新一代網站。24符號和縮略語RFID(RadioFrequencyIdentification)射頻識別APP（application）移動應用軟件ERP(EnterpriseResourcePlanning)企業(yè)資源計劃ID（identity）身份標識號OA（OfficeAutomation）辦公自動化URL（UniformResourceLocator）統(tǒng)一資源定位符POI(PointofInterest)興趣點UUID（UniversallyUniqueIdentifier）通用唯一識別碼PKI/CA（PublicKeyInfrastructure/CertificateAuthority）公鑰基礎設施/認證中心5信息交互接口劇院數字化服務系統(tǒng)接口設計要求包括了基礎接口設計、ERP系統(tǒng)接口設計、顧客平安系統(tǒng)接口設計、微網站接口設計、會員卡管理系統(tǒng)接口設計、票務管理系統(tǒng)接口設計、智能泊車系統(tǒng)接口設計等。6基礎接口設計6.1調用方式采用WebService調用方式。6.2獲取6.2.1接口描述Token是訪問外部服務系統(tǒng)接口的全局唯一憑證,通過WebService方式訪問獲取Token，客戶端系統(tǒng)調用各接口時都需使用Token。6.2.2輸入參數輸入參數為：應用ID、時間戳。6.2.3輸出參數輸出參數為：狀態(tài)碼、錯誤信息、應用ID、時間戳、Token。6.3獲取會員信息6.3.1接口描述根據會員編號、或者手機號碼、或者身份證號查詢會員信息。6.3.2輸入參數輸入參數為：會員編號、電話號碼、會員登錄名。6.3.3輸出參數3輸出參數為：狀態(tài)碼、錯誤信息、會員編號、會員名稱、會員登錄名、會員登錄ID、昵稱、電話、會員卡號、地址、身份證號、性別、出生日期、登記日期、郵箱、消費總額、車牌號、興趣愛好、總積分、會員狀態(tài)、會員等級、余額。6.4會員注冊接口6.4.1接口描述調用外部服務系統(tǒng)提供的接口，將系統(tǒng)注冊的會員信息實時推送到外部服務系統(tǒng)進行保存。6.4.2輸入參數輸入參數為：會員名稱、會員密碼、電話、身份證號、郵箱。6.4.3輸出參數輸出參數為：狀態(tài)碼、錯誤信息。6.5公司信息同步6.5.1接口描述當OA系統(tǒng)中，分部（公司）信息發(fā)生變化（新增、更新、刪除等）后，調用外部服務系統(tǒng)提供的接口及時的將分部變化信息推送至外部服務系統(tǒng)進行同步更新。6.5.2輸入參數輸入參數為：操作類型、數據集、公司ID、公司名稱、上級公司ID、排序號、狀態(tài)。6.5.3輸出參數輸出參數為：狀態(tài)碼、錯誤信息。6.6部門信息同步6.6.1接口描述當OA系統(tǒng)中，部門信息發(fā)生變化（新增、更新、刪除等）后，調用外部服務系統(tǒng)提供的接口及時的將部門變化信息推送至外部服務系統(tǒng)進行同步更新。6.6.2輸入參數輸入參數為：操作類型、數據集、部門ID、公司名稱、上級部門ID、排序號、狀態(tài)、公司ID。6.6.3輸出參數輸出參數為：狀態(tài)碼、錯誤信息。6.7人員信息同步6.7.1接口描述當OA系統(tǒng)中，人員信息發(fā)生變化（新增、更新、刪除等）后，調用外部服務系統(tǒng)提供的接口及時的將人員變化信息推送至外部服務系統(tǒng)進行同步更新。46.7.2輸入參數輸入參數為：操作類型、數據集、分部、部門、員工工號、姓名、性別、崗位、直接上級、狀態(tài)、辦公電話、移動電話、其他電話、電子郵件、出生日期、籍貫、人員性質、更改日期、登錄名、加密密碼。6.7.3輸出參數輸出參數為：狀態(tài)碼、錯誤信息。6.8崗位信息同步6.8.1接口描述當OA系統(tǒng)中，崗位信息發(fā)生變化（新增、更新、刪除等）后，調用外部服務系統(tǒng)提供的接口及時的將崗位變化信息推送至外部服務系統(tǒng)進行同步更新。6.8.2輸入參數輸入參數為：操作類型、數據集、崗位編碼、崗位名稱、部門編碼、單位編碼。6.8.3輸出參數輸出參數為：狀態(tài)碼、錯誤信息。7ERP系統(tǒng)接口設計7.1獲取Token7.1.1接口描述Token是調用命令的全局唯一票據，接入系統(tǒng)調用各接口命令時都需使用Token。7.1.2輸入參數輸入參數為：應用ID、應用密鑰。7.1.3輸出參數輸出參數為：狀態(tài)碼、錯誤信息、應用ID、時間戳、Token、過期狀態(tài)。7.2商鋪信息同步7.2.1接口描述當ERP系統(tǒng)中，商鋪信息發(fā)生變化（新增、更新、刪除等）后，調用外部服務系統(tǒng)提供的接口及時的將商鋪變化信息推送至外部服務系統(tǒng)進行同步更新。7.2.2輸入參數輸入參數為：操作類型、數據集、商戶編碼、中文名稱、英文名稱、店招品牌、狀態(tài)、商戶地址、商戶性質、商戶圖片、優(yōu)惠信息、聯(lián)系方式。7.2.3輸出參數5輸出參數為：狀態(tài)碼、錯誤信息。7.3商品類別信息同步7.3.1接口描述當ERP系統(tǒng)中商品類別信息發(fā)生變化（新增、更新、刪除等）后，調用外部服務系統(tǒng)提供的接口及時的將商品類別變化信息推送至外部服務系統(tǒng)進行同步更新。7.3.2輸入參數輸入參數為：操作類型、數據集、編碼、中文名稱、英文名稱、級次、最上級ID、父類ID、標簽狀態(tài)。7.3.3輸出參數輸出參數為：狀態(tài)碼、錯誤信息。7.4商品信息同步7.4.1接口描述當ERP系統(tǒng)中，商品信息發(fā)生變化（新增、更新、刪除等）后，調用外部服務系統(tǒng)提供的接口及時的將商品變化信息推送至外部服務系統(tǒng)進行同步更新。7.4.2輸入參數輸入參數為：操作類型、數據集、商品編碼、商品條碼、商品中文名稱、商品英文名稱、商品門店、合同編號、商品狀態(tài)、開始日期、結束日期、租戶編碼、商品類別。7.4.3輸出參數輸出參數為：狀態(tài)碼、錯誤信息。7.5消費記錄信息同步7.5.1接口描述ERP系統(tǒng)將除了外部服務系統(tǒng)之外的消費記錄信息通過數據接口及時推送到外部服務系統(tǒng)進行同步保存。7.5.2輸入參數輸入參數為：消費記錄ID、租賃商戶的店鋪標號、商場統(tǒng)一提供POS機號、小票序號、銷售日期、類別、系統(tǒng)中給定的每個商鋪的商品代碼、價格、數量、此小票總成交金額、付款方式、原收銀機號、原交易流水號、現(xiàn)金信用卡、儲值卡、促銷券、手工、其他支付、會員編號、消費類別。7.5.3輸出參數輸出參數為：狀態(tài)碼、錯誤信息。7.6實時消費信息同步7.6.1接口描述6外部服務系統(tǒng)將用戶實時消費記錄通過接口推送到ERP系統(tǒng)保存。7.6.2輸入參數輸入參數為：消費記錄ID、租賃商戶的店鋪標號、商場統(tǒng)一提供POS機號、小票序號、銷售日期、類別、系統(tǒng)中給定的每個商鋪的商品代碼、價格、數量、此小票總成交金額、付款方式、原收銀機號、原交易流水號、現(xiàn)金信用卡、儲值卡、促銷券、手工、其他支付、會員編號、消費類別。7.6.3輸出參數輸出參數為：狀態(tài)碼、錯誤信息。8顧客平安系統(tǒng)接口8.1獲取高危預警事件信息接口8.1.1接口描述通過對各種環(huán)境、動能、溫度、壓力、火災、高危氣體（包括氣體成份、煙霧）數據信息等數據的勘測和分析，當發(fā)生高危情況時，智慧劇院系統(tǒng)-外部服務系統(tǒng)通過調用接口的方式，及時獲取預警信息，同時將預警信息發(fā)布給安保及其他外圍系統(tǒng)，包括事件編號、事件名稱、事件描述、事件等級、事件發(fā)生時間、事件發(fā)生地點、事件類型。8.1.2輸入參數輸入參數為：事件編號、事件名稱、事件描述、事件等級、事件發(fā)生時間、事件發(fā)生地點、事件類8.1.3輸出參數輸出參數為：狀態(tài)碼、錯誤信息。8.2獲取兒童走失告警信息接口8.2.1接口描述智慧劇院系統(tǒng)-外部服務系統(tǒng)通過調用接口的方式，及時獲取兒童走失信息，當兒童接近劇院一些關鍵出口時，通過RFID設備獲取兒童位置信息，包括時間、位置等信息。8.2.2輸入參數輸入參數為：編號、描述、時間、走失位置。8.2.3輸出參數輸出參數為：狀態(tài)碼、錯誤信息。8.3獲取客流勘測信息接口8.3.1接口描述智慧劇院系統(tǒng)-外部服務系統(tǒng)通過調用接口的方式，獲取客流信息，包括客流密度、位置等信息。78.3.2輸入參數輸入參數為：時間、位置。8.3.3輸出參數輸出參數為：狀態(tài)碼、返回信息、時間、位置、客流密度。9微網站接口9.1認證簽名認證簽名的算法為：（1）將需要參與認證的請求參數按參數名升序排序。（2）按請求參數名及參數值相互連接組成一個字符串：<paramName1><paramValue1><paramName2><paramValue2>…；（3）將應用密鑰分別添加到以上請求參數串的頭部和尾部：<secret><請求參數字符串><secret>。（4）對該字符串進行SHA1運算，得到一個二進制數組；（5）將該二進制數組轉換為十六進制的字符串，該字符串即是這些請求參數對應的簽名。9.2獲取微網站首頁信息接口9.2.1獲取微網站的頁面幻燈片信息9.2.1.1輸入參數輸入參數為：認證簽名、應用標識、手機唯一標識、模塊ID、系統(tǒng)ID。9.2.1.2輸出參數輸出參數為：狀態(tài)碼、錯誤信息。9.2.2獲取微網站的模塊信息9.2.2.1輸入參數輸入參數為：認證簽名、應用標識、手機唯一標識、系統(tǒng)ID、是否發(fā)布。9.2.2.2輸出參數輸出參數為：狀態(tài)碼、錯誤信息。9.3微網站訪問統(tǒng)計接口9.3.1接口描述記錄商城訪問。9.3.2輸入參數輸入參數為：認證簽名、應用標識、手機唯一標識、系統(tǒng)ID、用戶ID、類型（微官網或微信）。9.3.3輸出參數8輸出參數為：狀態(tài)碼、返回信息。9.4注冊/登錄9.4.1驗證手機或發(fā)送驗證碼9.4.1.1輸入參數輸入參數為：認證簽名、應用標識、手機唯一標識、系統(tǒng)ID、接受驗證碼的手機號碼。9.4.1.2輸出參數輸出參數為：狀態(tài)碼、返回信息。9.4.2重新獲取驗證碼9.4.2.1輸入參數輸入參數為：認證簽名、應用標識、手機唯一標識、系統(tǒng)ID、接受驗證碼的手機號碼。9.4.2.2輸出參數輸出參數為：狀態(tài)碼、返回信息。9.4.2登錄9.4.2.1輸入參數輸入參數為：認證簽名、應用標識、手機唯一標識、系統(tǒng)ID、接受驗證碼的手機號碼、驗證碼。9.4.2.2輸出參數輸出參數為：狀態(tài)碼、返回信息。9.4.3核對驗證碼9.4.3.1輸入參數輸入參數為：手機號碼、驗證碼。9.4.3.2輸出參數輸出參數為：狀態(tài)碼、返回信息。9.4.4綁定會員卡9.4.4.1輸入參數輸入參數為：手機號碼、會員卡號。9.4.4.2輸出參數輸出參數為：狀態(tài)碼、返回信息。9.4.5注冊9.4.5.1輸入參數9輸入參數為：認證簽名、應用標識、手機唯一標識、系統(tǒng)id、手機號碼、用戶名、生日。9.4.5.2輸出參數輸出參數為：狀態(tài)碼、返回信息。9.5劇院活動管理接口9.5.1獲取活動列表9.5.1.1輸入參數輸入參數為：認證簽名、應用標識、手機唯一標識、系統(tǒng)ID、類型（1.熱門活動、2.商品活動）、頁碼（默認第一頁）、頁長度（默認的記錄條數）、時間戳。9.5.1.2輸出參數輸出參數為：狀態(tài)碼、返回信息。9.5.12獲取活動詳細信息9.5.2.1輸入參數輸入參數為：認證簽名、應用標識、手機唯一標識、系統(tǒng)ID、活動ID、用戶ID。9.5.2.2輸出參數輸出參數為：狀態(tài)碼、返回信息。9.6劇院簡介管理接口9.6.1獲取劇院簡介接口9.6.1.1輸入參數輸入參數為：認證簽名、應用標識、手機唯一標識、劇院簡介ID、系統(tǒng)ID。9.6.1.2輸出參數輸出參數為：狀態(tài)碼、返回信息。9.6.2獲取劇院內容接口9.6.2.1輸入參數輸入參數為：認證簽名、應用標識、手機唯一標識、系統(tǒng)ID。9.6.2.2輸出參數輸出參數為：狀態(tài)碼、返回信息。10會員卡管理系統(tǒng)接口10.1會員卡信息同步接口當會員卡管理系統(tǒng)中，會員卡信息發(fā)生變化（新增、更新、注銷等）后，調用外部服務系統(tǒng)提供的接口，及時將會員卡變化信息推送至外部服務系統(tǒng)進行同步更新。10.1.1輸入參數輸入參數為：操作類型、數據集、會員編號、會員名稱、公司名稱、電話地址、會員卡號、身份證號、性別、出生日期、登記日期、有效期限、總消費額、總折扣額、總積分、會員狀態(tài)、會員等級、余額。10.1.2輸出參數輸出參數為：狀態(tài)碼、返回信息。10.2虛擬會員信息同步接口虛擬會員與實體會員卡進行綁定后，外部服務系統(tǒng)將變更的會員信息（積分、余額等）實時推送到會員卡管理系統(tǒng)進行同步保存更新。10.2.1輸入參數輸入參數為：會員編號、會員名稱、公司名稱、電話地址、會員卡號、身份證號、性別、出生日期、登記日期、有效期限、總消費額、總折扣額、總積分、會員狀態(tài)、會員等級、余額。10.2.2輸出參數輸出參數為：狀態(tài)碼、返回信息。10.3會員消費記錄接口會員卡管理系統(tǒng)調用外部服務系統(tǒng)提供的接口，將會員卡消費歷史記錄推送到外部服務系統(tǒng)。10.3.1輸入參數輸入參數為：消費門店號、流水號、消費時間、會員編號、商品編碼、專柜商號、商品類別、消費類別、零售單價、零售數量、優(yōu)惠金額、積分額、消費金額。10.3.2輸出參數輸出參數為：狀態(tài)碼、返回信息。10.4會員充值記錄接口會員卡管理系統(tǒng)調用外部服務系統(tǒng)提供的接口，將會員卡的充值記錄實時推送到外部服務系統(tǒng)。10.3.1輸入參數輸入參數為：充值專柜號、流水號、充值時間、充值金額、充值前金額、充值后金額、充值渠道、會員編號、積分額。10.3.2輸出參數輸出參數為：狀態(tài)碼、返回信息。11票務系統(tǒng)接口11.1劇院排期接口11.1.1接口描述票務系統(tǒng)提供中間表，外部服務系統(tǒng)通過中間表查詢獲取劇院排期數據。票務系統(tǒng)為外部服務系統(tǒng)提供劇院節(jié)目排期表結構信息，并為其創(chuàng)建一個數據庫用戶，分配該表的查詢權限。11.1.2輸入參數11.1.3輸出參數輸出參數：最低票價、最高票價、演出商品的編號、喜歡數、演出商品的編號、演出名稱、項目狀態(tài)（0售票中；1預售；2無效；3待定；4售完；5延期；6取消；7已結束(商品下架時自動變更為此狀態(tài))）、縮略圖地址（并非全地址URL）、場館編號、場館名稱、開始日期(格式：yyyy-MM-dd)、結束日期(格式：yyyy-MM-dd)、創(chuàng)建時間（date）、一級分類編號、一級分類名稱、二級分類編號、二級分類名稱；場館流水ID、場館名稱、場館地址、場館推薦是否顯示(0不顯示，1顯示)；商品大類別流水ID、商品大類別名稱、商品大類別序號（排序）；商品子類別流水ID、商品子類別名稱、商品大類別流水ID、商品大類別名稱、商品子類別序號（排序）。11.2用戶購票接口11.2.1接口描述外部服務系統(tǒng)與票務系統(tǒng)做界面集成，完成系統(tǒng)在線售票功能，票務系統(tǒng)提供售票訪問的URL給外部服務系統(tǒng)。11.2.2輸入參數11.2.3輸出參數輸出參數：節(jié)目編號11.3我的訂單接口11.3.1接口描述票務系統(tǒng)提供中間表，外部服務系統(tǒng)通過中間表查詢我的訂單數據。票務系統(tǒng)為外部服務系統(tǒng)提供我的訂單表結構信息，并為其創(chuàng)建一個數據庫用戶，分配該表的查詢權限。11.3.2輸入參數11.3.3輸出參數輸出參數：訂單編號、會員編號、訂單來源、訂單創(chuàng)建時間、訂單座位信息、訂單狀態(tài)、訂單支付標記、演出商品編號、演出商品名稱、演出商品圖片、演出場館編號、演出場館名稱、演出日期和時間、訂單應收、訂單實收、使用余額數、使用積分值、一級分類編號、一級分類名稱、二級分類編號、二級分類名稱。11.4會員信息修改11.4.1接口描述用戶進行訂單確認時需要輸入用戶收獲地址，票務管理系統(tǒng)調用外部服務系統(tǒng)會員信息查詢接口查詢會員地址，若沒有地址，用戶需要輸入新地址，此時票務管理系統(tǒng)調用外部服務系統(tǒng)會員信息修改接口將會員地址推送到外部服務系統(tǒng)進行保存。11.4.2輸入參數輸入參數：會員編號、身份證號、郵箱、地址。11.4.3輸出參數輸出參數為：狀態(tài)碼、返回信息。11.5消費余額同步11.5.1接口描述當會員支付成功后，票務系統(tǒng)將用戶電子錢包支付扣減的金額同步到外部服務系統(tǒng)，同步扣減會員的余額。11.5.2輸入參數輸入參數：會員編號、產生時間、金額、備注。11.5.3輸出參數輸出參數為：狀態(tài)碼、返回信息。11.6電子錢包驗證11.6.1接口描述會員支付訂單選擇用“電子錢包”支付時。需要驗證“電子錢包”密碼是否正確。如果正確則返回“成功”及實時余額，如果不正確則返回“失敗”。11.6.2輸入參數輸入參數：會員編號、電子錢包密碼。11.6.3輸出參數輸出參數為：狀態(tài)碼、返回信息、余額。12智能泊車系統(tǒng)接口12.1反向尋車接口12.1.1接口描述用戶通過手機APP點擊反向尋車功能，停車場系統(tǒng)根據顧客輸入的車牌號，查詢車輛停車位置信息，包含停車樓層、車輛停放區(qū)域（如A區(qū)、B區(qū)）、停車車位號等信息，與停車場地圖POI信息對應，根據路線規(guī)劃通過圖聚提供的導航引擎進行導航，導航到停車位。12.1.2輸入參數輸入參數：車牌號。12.1.3輸出參數輸出參數為：狀態(tài)碼、返回信息、停車樓層、車輛停放區(qū)域、停車車位號余額。12.2查詢空車位信息接口12.2.1接口描述用戶通過手機APP點擊空車位查詢按鈕，執(zhí)行空車位查詢操作，停車場管理系統(tǒng)將所有停車空位信息（包括空車位總數、每一層和每個區(qū)域的空車位數量以及空車位對應的地圖上具體位置）查出，在地圖上顯示。12.2.2輸入參數12.2.3輸出參數輸出參數為：空車位總數、某層空車位數、某區(qū)域空車位數。12.3空車位詳細信息接口12.3.1接口描述用戶通過手機APP點擊空車位查詢按鈕，執(zhí)行空車位查詢操作，停車場管理系統(tǒng)將所有停車空位信息查出，在地圖上顯示。用戶通過APP選定某個空車位，停車場管理系統(tǒng)返回該空車位具體位置信息，包括空車位的編號、坐標等信息。根據定位用戶的位置及選定的空車位的坐標，導航到該空車位。外部服務系統(tǒng)通過傳入選定的空車位編號，與停車場系統(tǒng)做應用集成。12.3.2輸入參數車位編號。12.3.3輸出參數輸出參數為：狀態(tài)碼、返回信息、空車位編號、空車位坐標。12.4獲取車輛失位接口12.4.1接口描述停車場管理系統(tǒng)判斷車輛移位，將車輛失位告警信息，包括車牌號、車位號、停車區(qū)域、失位告警信息，通過調用外部服務系統(tǒng)提供的接口將車輛失位信息推送過來。12.4.2輸入參數輸入參數：車位編號、停車區(qū)域、停放車位、進入時間、告警信息。12.4.3輸出參數輸出參數為：狀態(tài)碼、返回信息。12.5獲取無牌車接口12.5.1接口描述根據給定的時間段，獲取該時間段內的所有無牌