財務(wù)共享影像管理系統(tǒng)接口方案書A3國信合成

xxxx財務(wù)共享影像管理系統(tǒng)接口方案書深圳市國信合成科技有限公司第1頁共17頁保密資料編號：SiiT-YBBX20150623項目編號：SiiT-YBBX20150623內(nèi)部資料，注意保密xxxx財務(wù)共享影像管理系統(tǒng)接口方案書深圳市國信合成科技有限公司2015年06月23日文檔屬性文檔屬性內(nèi)容項目名稱xxxx財務(wù)共享影像管理系統(tǒng)應(yīng)用軟件采購項目項目編號SiiT-YBBX20150623文檔名稱接口方案書文檔版本號A3文檔狀態(tài)正式稿文檔編寫完成日期2015-06-23作者深圳市國信合成科技有限公司發(fā)布范圍xxxx、深圳市國信合成科技有限公司文檔變更歷史清單文檔版本號變更日期修改人備注A12015-06-23深圳市國信合成科技有限公司新建A32015-08-04深圳市國信合成科技有限公司新建3.本次修改變更說明序號變更內(nèi)容簡述A3將接口參數(shù)統(tǒng)一調(diào)整為小寫；增加參數(shù)是否為必填項描述目錄TOC\o"1-3"\h\z1 需求背景 42 接口需求 43 業(yè)務(wù)流程 43.1報賬單構(gòu)正常流程 43.2報賬單影像修改流程 53.3報賬單退單流程 63.4電子憑證流程 74 接口規(guī)則描述 85 影像接口描述 85.1影像系統(tǒng)服務(wù)接口描述 95.2接口參數(shù)如下 95.3接口參數(shù)描述 95.4接口返回值 96 影像系統(tǒng)接口參數(shù)使用說明 106.1接口列表 106.2接口詳細 106.2.1 觸發(fā)單據(jù)掃描流程接口 106.2.2 獲得影像調(diào)閱地址接口 126.2.3 通知影像系統(tǒng)退單接口(作廢接口) 136.2.4 影像系統(tǒng)自動歸檔接口 146.2.5 發(fā)起事后補充流程 157 EForm系統(tǒng)接口參數(shù)使用說明 157.1接口列表 157.2接口詳細 157.2.1 通知影像狀態(tài)接口 158 Sun系統(tǒng)接口參數(shù)使用說明 168.1接口列表 168.2接口詳細 168.2.1 同步憑證中間表 16需求背景深圳市國信合成科技有限公司作為xxxx財務(wù)共享影像系統(tǒng)供應(yīng)商，為配合財務(wù)共享影像管理系統(tǒng)項目建設(shè)需要合作，需要設(shè)計一套通用接口，便于本項目順利與Eform系統(tǒng)、sun系統(tǒng)集成。接口需求影像系統(tǒng)與其他各系統(tǒng)的需對接如下表所示:序號接口項目接口說明1影像系統(tǒng)接口服務(wù)影像系統(tǒng)提供該服務(wù)，供兩個系統(tǒng)交互時使用，具體使用參考下面詳細說明2Eform系統(tǒng)xxxx報賬系統(tǒng)3Sun系統(tǒng)xxxx核算系統(tǒng)業(yè)務(wù)流程說明：下面各個流程描述中，紅色的批注為：EForm系統(tǒng)提供的接口（推送接口）；藍色的為：影像系統(tǒng)提供的接口（設(shè)置接口）；（X）中的值為，提交的狀態(tài)值。||：需要暫停，等待影像反饋的節(jié)點；下面的流程說明，也按照這個規(guī)則，紅色的狀態(tài)為：EForm系統(tǒng)，藍色的狀態(tài)為：影像系統(tǒng)。報賬單構(gòu)正常流程發(fā)起人，提交申請后，從Eform系統(tǒng)打印出帶有條形碼的封面，交給會計初審崗，由會計初審崗的工作人員把封面和單據(jù)掃描進影像系統(tǒng)。（此時Eform系統(tǒng)中的影像狀態(tài)為：等待掃描）,此時業(yè)務(wù)流程暫停，等待影像系統(tǒng)返回狀態(tài)；會計初審掃描完單據(jù)后，影像系統(tǒng)自動調(diào)用“通知狀態(tài)”接口，通知Eform系統(tǒng)自動觸發(fā)電子流程進入下一環(huán)節(jié)（在此之后Eform系統(tǒng)就可以調(diào)用“影像調(diào)閱接口“接口，查看單據(jù)掃描的影像）；最終FSSC復(fù)核審批完成后，Eform系統(tǒng)，調(diào)用“通知自動歸檔“接口，通知財務(wù)影像系統(tǒng)需要歸檔對應(yīng)的單據(jù)，財務(wù)影像系統(tǒng)自動將對應(yīng)單據(jù)進行歸檔。報賬單影像修改流程影像系統(tǒng)通知EForm系統(tǒng)已經(jīng)掃描后，EForm系統(tǒng)繼續(xù)電子流程時，在調(diào)閱影像的頁面進行重掃操作，財務(wù)影像系統(tǒng)自動調(diào)用“通知報賬單狀態(tài)“接口，通知EForm系統(tǒng)單據(jù)正在重掃，EFrom根據(jù)對應(yīng)的信息，掛起對應(yīng)單據(jù)的電子流程，等待影像系統(tǒng)通知。備注：會計初審崗、FSSC1、FSSC2三個審批環(huán)節(jié)可發(fā)起影像修改指令；其余環(huán)節(jié)僅供查閱影像。影像系統(tǒng)重掃完成時，會再次調(diào)用“通知報賬單狀態(tài)“接口，通知EForm系統(tǒng)單據(jù)重掃完成，EForm系統(tǒng)根據(jù)信息自動取消電子流程的掛起狀態(tài)，流程可繼續(xù)往下流轉(zhuǎn)審批。報賬單退單流程EForm系統(tǒng)單據(jù)退單（作廢）時，需要通知財務(wù)影像系統(tǒng)進行同步退單。此時需要調(diào)用退單接口，影像系統(tǒng)收到相關(guān)信息后，結(jié)束財務(wù)共享影像系統(tǒng)中的對應(yīng)單據(jù)流程(單號不能再使用)。電子憑證流程SUN系統(tǒng)定時將需要同步的憑證數(shù)據(jù)寫入視圖中，財務(wù)共享影像系統(tǒng)定期讀取sun系統(tǒng)提供視圖中獲取對應(yīng)憑證數(shù)據(jù)后，寫入影像系統(tǒng)，憑證后續(xù)流程由影像系統(tǒng)進行處理。接口規(guī)則描述EForm系統(tǒng)與影像間的接口，采用WebService方式進行數(shù)據(jù)交互。在交互時，遵循以下規(guī)則：根據(jù)業(yè)務(wù)場景，分為同步調(diào)用和異步調(diào)用兩種方式。對于影像退回修改、影像調(diào)閱等接口，采用同步調(diào)用的方式。影像已掃描、完成回退掃描等接口，采用異步方式。對于調(diào)用失敗的情況，可由系統(tǒng)進行自動若干次的重試。仍然失敗的情況，記錄相關(guān)日志信息。對于一個單據(jù)號的調(diào)用，確保調(diào)用順序保持一致，不因異步調(diào)用而出現(xiàn)順序變化。對于接口XML的輸入?yún)?shù)和輸出參數(shù)，所有節(jié)點的字母都是小寫，由于文檔編寫可能出現(xiàn)大寫，在這里特殊說明。影像接口描述影像系統(tǒng)服務(wù)接口描述接口定義為：StringImageInterfaceService(Stringparam)接口參數(shù)如下<?xmlversion="1.0"encoding="UTF-8"?><params><safety><clientcode>調(diào)用系統(tǒng)編碼</clientcode><servicecode>被調(diào)用系統(tǒng)編碼</servicecode><time>調(diào)用時間，格式為：YYYYMMDDHHmmSS,例如：20140712161833</time><ticket>驗證串，clientcode+servicecode+time節(jié)點的值+雙方約定的key生成的MD5值</ticket></safety><serverbody><servername>調(diào)用接口標記</servername><services><service><serviceid>每個service的唯一標記</serviceid><…>各個參數(shù)節(jié)點</…></service><service>…………</service></services></serverbody></params>接口參數(shù)描述節(jié)點上級節(jié)點說明paramsXML根節(jié)點safetyparams接口安全驗證節(jié)點，默認接口是進行白名單(IP)驗證，是否進行明文參數(shù)驗證由具體項目，在影像系統(tǒng)進行配置，需要驗證時，time,ticket參數(shù)必填，相反則不用clientcodesafety調(diào)用系統(tǒng)代碼，這里默認為FKservicecodesafety提供服務(wù)的系統(tǒng)編碼，這里默認為：ImageCentertimesafety明文參數(shù)驗證時，該節(jié)點必輸，格式為：YYYYMMDDHHmmSS,例如：20140712165112ticketsafety明文參數(shù)驗證時，該節(jié)點必輸，取值為：clientcode+servicecode+time節(jié)點的值+“image”的MD5值“image”這個是由雙方配置的，可以改變serverbodyparams接口調(diào)用參數(shù)主體節(jié)點servernameserverbody調(diào)用的服務(wù)標記servertypeserverbody調(diào)用的服務(wù)類型，0/實時接口，1/定時接口，影像系統(tǒng)可配置，默認取影像系統(tǒng)配置servicesserverbody請求列表節(jié)點serviceservername值調(diào)用接口每條單獨的記錄信息，可以一次執(zhí)行多個單據(jù)serviceidservice本個服務(wù)的唯一標記各個參數(shù)節(jié)點service具體的接口中的參數(shù)接口返回值<?xmlversion="1.0"encoding="UTF-8"?><root><result>接口處理結(jié)果，0/成功，1/失敗，這里只表示結(jié)果處理是否成功，不表示業(yè)務(wù)處理是否成功，業(yè)務(wù)處理是否成功需要解析Item中的內(nèi)容</result><errormsg>錯誤信息</errormsg><items><item><serviceid>每個service的唯一標記，入?yún)⒌闹?，直接寫回到這里</serviceid><result>該serviceid處理結(jié)果，0/成功，1/失敗</result><success>成功結(jié)果</success><errormsg>錯誤信息</errormsg><…>可以擴充節(jié)點</…></item><item>…………</item></items></root>影像系統(tǒng)接口參數(shù)使用說明接口列表序號接口項目接口說明1觸發(fā)單據(jù)掃描流程接口Eform系統(tǒng)提交表單時，由EForm系統(tǒng)調(diào)用該接口，通知影像系統(tǒng)發(fā)起對應(yīng)的掃描流程。2獲得影像調(diào)閱地址接口需要查閱影像時，EForm及Sun系統(tǒng)可以通過該鏈接查看對應(yīng)單據(jù)的影像信息，再IE中打開來查閱對應(yīng)單據(jù)的影像。3獲得影像條碼生成地址獲取對應(yīng)條碼生成條碼影像的地址，在IE中打開4通知影像系統(tǒng)自動歸檔接口其它系統(tǒng)需要自動歸檔影像系統(tǒng)的歸檔待辦時，需要調(diào)用該接口，自動提交影像系統(tǒng)的歸檔待辦工作。5通知影像系統(tǒng)退單(作廢)EForm系統(tǒng)退單后，刪除，作廢，需要通知影像系統(tǒng)退單6發(fā)起事后補充流程如果是需要事后補充發(fā)票的，需要EForm系統(tǒng)結(jié)束流程時，調(diào)用該接口通知財務(wù)影像系統(tǒng)接口詳細觸發(fā)單據(jù)掃描流程接口接口提供方影像系統(tǒng)接口用途EForm需要掃描報賬單時，將報賬單的基本信息通過該接口推送到影像系統(tǒng)，并等待影像系統(tǒng)掃描接口標記startWorkFlow接口參數(shù)名稱說明數(shù)據(jù)類型參數(shù)類型必填項barcode影像條碼號（索引號）字符串inYEStype單據(jù)類型,1報賬單字符串inYESbranchcode提單用戶所屬機構(gòu)編碼字符串inYESPartnerName往來單位名稱字符串InNOusername報賬人姓名字符串inYESuseraccount操作人賬號字符串In（員工代號）YESbilldate報賬日期字符串inYESamount金額字符串inYESbillcode表單編號字符串In（單據(jù)號）YESbilltype單據(jù)類型字符串表單ID(1.1,1.2….)YESbusstype業(yè)務(wù)類型字符串In（工程款，設(shè)備款……）NOremark摘要，描述信息字符串inNO接口入?yún)⒈热缫淮伟l(fā)起單據(jù)：TEST2014071200001和TEST2014071200002報賬單流程<?xmlversion="1.0"encoding="UTF-8"?><params><safety><clientcode>FK</clientcode><servicecode>ImageCenter</servicecode><time>20140712161833</time><ticket>“FK”+“ImageCenter”+“20140712161833”+“ImageCenterFK”的MD5值，這里就不算了</ticket></safety><serverbody><servername>startWorkFlow</servername><servertype></servertype><services><service><serviceid>1</serviceid><barcode>TEST2014071200001</barcode><type>1</type><branchcode>4400</branchcode><username>zhangsan</username><useraccount>zhangsan</useraccount><billdate>2014-07-12</billdate><amount>123.11</amount><billcode>BXD_201407120023</billcode><billtype>報銷單</billtype><busstype>YS</busstype><remark>出差報銷</remark></service><service><serviceid>2</serviceid><barcode>TEST2014071200002</barcode><type>1</type><branchcode>4400</branchcode><username>zhangsan</username><useraccount>zhangsan</useraccount><billdate>2014-07-12</billdate><amount>232.11</amount><billcode>BXD_201407120024</billcode><billtype>報銷單</billtype><busstype>YS</busstype><remark>出差報銷</remark></service></services></serverbody></params>接口出參TEST2014071200001單據(jù)觸發(fā)流程成功，TEST2014071200002單據(jù)觸發(fā)流程失敗，返回值如下：<?xmlversion="1.0"encoding="UTF-8"?><root><result>0</result><success></success><errormsg>單據(jù)TEST2014071200002觸發(fā)失敗，已經(jīng)存在且狀態(tài)為已掃描！</errormsg><items><item><serviceid>1</serviceid><result>0</result><success></success><errormsg></errormsg></item><item><serviceid>2</serviceid><result>1</result><success></success><errormsg>單據(jù)TEST2014071200002觸發(fā)失敗，已經(jīng)存在且狀態(tài)為已掃描！</errormsg></item></items></root>獲得影像調(diào)閱地址接口接口提供方影像系統(tǒng)接口用途掃描后，其他系統(tǒng)可以根據(jù)這個接口調(diào)閱對應(yīng)單據(jù)的影像信息接口標記createImagePath接口參數(shù)名稱說明數(shù)據(jù)類型參數(shù)類型必填項barcode影像條碼號StringInYESevaluation是否可以評價，1可以評價，其他為不可以評價StringinYEStype調(diào)閱的單據(jù)類型，1報賬單StringInNOcandownPrint是否可以下載和打印影像，1可以，0或者其他不可以StringInYEScommentType批注操作標識：0無權(quán)看見批注，默認1可以看見批注2可看見且能編輯StringInYESimageop操作限制：1/只能補充，2/只能刪除，3/不限制StringInYESuseraccount查閱用戶帳號StringInYESaccountdate記賬日期StringInNOshowother是否顯示關(guān)聯(lián)影像,0不顯示，1顯示，默認0StringInYES參數(shù)使用說明：1.參數(shù)組合使用：在會計初審環(huán)節(jié)、FSSC1、FSSC2審批環(huán)節(jié)時Evaluation=1、CanDownPrint=1、commentType=1、imageop=3；2.參數(shù)組合使用：其余審批待辦環(huán)節(jié)，Evaluation=0、CanDownPrint=0、commentType=0、imageop=0；3.accountdate、showother默認不用傳輸接口入?yún)⒈热缫榭矗篢EST2014071200001單據(jù)的影像<?xmlversion="1.0"encoding="UTF-8"?><params><safety><clientcode>FK</clientcode><servicecode>ImageCenter</servicecode><time>20140712161833</time><ticket>MD5值，這里就不算了</ticket></safety><serverbody><servername>createImagePath</servername><servertype></servertype><services><service><serviceid>1</serviceid><barcode>TEST2014071200001</barcode><type>1</type><evaluation>1</evaluation><CanDownPrint>1</CanDownPrint><commentType>0</commentType><imageop>0</imageop><userid>zhangsan</userid><accountdate>2014-10-12</accountdate><showother>1</showother></service></services></serverbody></params>接口出參<?xmlversion="1.0"encoding="UTF-8"?><root><result>0</result><success></success><errormsg></errormsg><items><item><serviceid>1</serviceid><result>0</result><success>/showImage.do?barcode=TEST2014071200001</success><errormsg></errormsg></item></items></root>通知影像系統(tǒng)退單接口(作廢接口)接口提供方影像系統(tǒng)接口用途Eform系統(tǒng)，根據(jù)單據(jù)作廢，刪除等操作，如果單據(jù)已經(jīng)在影像系統(tǒng)中存在，那么就要調(diào)用該接口接口通知影像系統(tǒng)退單接口標記rejectBill接口參數(shù)名稱說明數(shù)據(jù)類型參數(shù)類型必填項barcode影像條碼號字符串inYESbilltype單據(jù)類型，1/報賬單StringinNOuseraccount退單人帳號字符串inYESusername退單人姓名字符串inYESphone退單人電話字符串inNOremark退單描述字符串inNO使用說明影像系統(tǒng)自動歸檔接口接口提供方影像系統(tǒng)接口用途Eform系統(tǒng)走完所有審批流程時，確定影像無誤且不能再修改時，調(diào)用該接口鎖定影像數(shù)據(jù)，鎖定后只能查閱接口標記lockedBillcode接口參數(shù)名稱說明數(shù)據(jù)類型參數(shù)類型必填項barcode影像條碼號字符串inYESbilltype單據(jù)類型，1/報賬單NOBustype業(yè)務(wù)類型，暫定為定值:FK字符串inNOoptype操作類型，1提交到待歸檔，2自動歸檔，默認是自動歸檔YESvoucher憑證信息year憑證年度NObranch憑證帳套date制證日期NO注：barcode，bustype，optype是必填參數(shù)，其它是可選參數(shù)。Param參數(shù)有數(shù)據(jù)時，解析更新對應(yīng)字段信息。??對應(yīng)條碼如果不存在，或不在對應(yīng)環(huán)節(jié)返回對應(yīng)的信息。本項目optype傳參數(shù)2使用說明參考7.2.1發(fā)起事后補充流程接口提供方影像系統(tǒng)接口用途有些單據(jù)在結(jié)束流程后，還需要后期補充一些發(fā)票信息，但是該單據(jù)一般有滯后性，不是很及時可以獲取到，所以需要先報賬后，后期再補掃進來，要在補錄時，就需要這個接口來完成。接口標記startImagePlusFlow接口參數(shù)名稱說明數(shù)據(jù)類型參數(shù)類型必填項barcode影像條碼號字符串inYESbilltype單據(jù)類型，1/報賬單字符串InNOu