项目接口文档

项目接口文档
项目接口文档

接口使用说明书

2016年9月

版本控制文档信息

文档变更记录

目录

1.接口概述 (4)

1.1. 概述 (4)

1.2. 基本规则 (4)

1.2.1. 域名 (4)

1.2.2. 通用接口调用参数说明 (4)

2.接口定义 (6)

2.1. 登录注册 (6)

2.1.1. 登录接口 (6)

2.1.1.1. 账号密码登录 (6)

2.1.1.2. 微信登录............................................................................. 错误!未定义书签。

2.1.2. 注册和修改接口..................................................................... 错误!未定义书签。

2.1.2.1. 完善个人信息接口............................................................. 错误!未定义书签。

2.1.2.2. 获取个人资料..................................................................... 错误!未定义书签。

2.1.2.

3. 上传/修改企业信息 ........................................................... 错误!未定义书签。

2.1.2.4. 上传/修改工作经历 ........................................................... 错误!未定义书签。

2.1.2.5. 设置/修改提现密码 ........................................................... 错误!未定义书签。

2.1.

3. 短信部分接口......................................................................... 错误!未定义书签。

2.1.

3.1. 发送短信验证码接口......................................................... 错误!未定义书签。

2.1.4. 服务部分接口......................................................................... 错误!未定义书签。

2.1.4.1. 上传/修改个人服务信息 ................................................... 错误!未定义书签。

2.1.4.2. 获取服务列表..................................................................... 错误!未定义书签。

2.1.4.

3. 获取服务详情..................................................................... 错误!未定义书签。

2.1.4.4. 评价列表(全部服务或单个服务) ...................................... 错误!未定义书签。

2.1.4.5. 预约..................................................................................... 错误!未定义书签。

2.1.4.6. 服务评价............................................................................. 错误!未定义书签。

2.1.5. 我的账户................................................................................. 错误!未定义书签。

2.1.5.1. 获取用户收入/支出记录 ................................................... 错误!未定义书签。

2.1.5.2. 分页获取收入/支出记录 ................................................... 错误!未定义书签。

2.1.5.

3. 添加收入/支出记录 ........................................................... 错误!未定义书签。

2.1.6. 红包部分接口......................................................................... 错误!未定义书签。

2.1.6.1. 领取红包............................................................................. 错误!未定义书签。

2.1.6.2. 发放红包............................................................................. 错误!未定义书签。

2.1.7. 精英汇部分接口..................................................................... 错误!未定义书签。

2.1.7.1. 获取精英列表..................................................................... 错误!未定义书签。

2.1.7.2. 精英详情............................................................................. 错误!未定义书签。

2.1.8. 任务接口................................................................................. 错误!未定义书签。

2.1.9. 其他接口................................................................................. 错误!未定义书签。

2.1.9.1. 消息..................................................................................... 错误!未定义书签。

2.1.9.2. 省市区获取......................................................................... 错误!未定义书签。

2.1.9.

3. 行业类型获取..................................................................... 错误!未定义书签。

2.1.9.4. 上传多媒体资源................................................................. 错误!未定义书签。

2.1.9.5. 申请加V ............................................................................. 错误!未定义书签。

1.接口概述

1.1.概述

本文档使用**H5端、Android端、Ios端接口说明。

1.2.基本规则

1.2.1.域名

http://www.***.com(公司测试域名)

1.2.2.通用接口调用参数说明

(1)token系统生成加密字符串,作为接口安全校验值,由加密字符串接口生成。

(2)version版本号,当前用户使用客户端版本号(H5端、web端默认1.0)。(3)clientType 客户端类型,类型分别为android、ios、h5、web。

(4)接口参数Type M 表示必填项,N表示选填项。

(5)接口返回格式:json。

(6)通用格式说明

失败,包含系统异常导致调用失败、接口调用成功但参数校验失败、业务操作失败,接口返回json示例如下:

{

" status": {

"state": "错误码",

"msg": "错误信息"

}

}

成功:

返回单条数据示例如下:

{

"status": {

"state": "1”,

"msg": ""

},

"content": { }

}

返回多条数据示例如下:

{

"status": {

"state": "1”,

"msg": ""

},

"content": [

{……},

{……}

]

}

(7)错误状态码说明:

(8)接口返回错误信息msg:

msg信息是调用接口失败提示信息。

2.接口定义

2.1.登录注册

2.1.1.登录接口

2.1.1.1.账号密码登录

【应用场景】

【接口说明】

校验用户登录信息是否正确,并返回用户个人信息(非微信用户登录)。【接口形式】

HTTP POST

【接口URL】

*****/login

【参数定义】

输入参数定义如下:

返回信息定义如下:(json)

接口调用说明文档

XXX)科技有限公司 数据接口 2015-5-26

目录 第1章引言. ......................................................... 错误!未定义书签。 背景. ........................................................... 错误!未定义书签。 第2章接口与数据定义. ................................................... 错误!未定义书签。 曝光台查询接口. ..................................................... 错误!未定义书签。 曝光台列表查询.......................... 错误!未定义书签。 曝光台详情查询.......................... 错误!未定义书签。 信用公示查询接口定义.......................... 错误!未定义书签。 守信公示列表查询.......................... 错误! 未定义书签。 守信公示详情查询.......................... 错误!未定义书签。 失信公示列表查询.......................... 错误!未定义书签。 失信公示详情查询.......................... 错误!未定义书签。 企业名称查询接口定义.......................... 错误!未定义书签。 Webservice 方法定义 ........................ 错误! 未定义书签。 请求参数. .................................................... 错误! 未定义书签。 返回数据. .................................................... 错误!未定义书签。 企业信息查询接口定义.......................... 错误!未定义书签。 Webservice 方法定义 ........................ 错误! 未定义书签。 请求参数. .................................................... 错误! 未定义书签。 返回数据. .................................................... 错误!未定义书签。

开发接口文档-API文档模板

XXX项目接口文档版本控制信息 获取所有字段 获取所有字段 请求地址:/session/field/findAll 请求参数 响应

请求例子:响应例子:{"code":"10000","exception":null,"isSuccess":true,"message":"成功,系统处理正常! ","page":0,"pageSize":0,"returnObject":null,"returnValue":{"types":null,"villages":null,"companys":[{"iconColour":"","iconSize":0,"ico nStyle":"","id":4,"name":"XX"},{"iconColour":"","iconSize":0,"iconStyle":"","id":5,"name":"XX"},{"iconColour":"","iconSize":0,"iconSty le":"","id":7,"name":"XX"}]},"totals":0} 文件上传 文件上传(ajax) 请求地址:/session/file/upload 请求参数 响应 请求例子:var formData = new FormData(); ("file", [0]); $.ajax({ url : routePath + "/session/file/upload", type : 'POST', data : formData,

processData : false, contentType : false, success : function(result) { result = (result); if == "10000"){ ('上传成功!'); $("#editHeadPortrait").val } } }); 响应例子:returnValue里包含了 fileName和filePath 字段管理-所属类型 新增所属类型 请求地址:/session/fieldType/save 请求参数 响应 请求例子:响应例子:{"code":"10000","exception":null,"isSuccess":true,"message":"成功,系统处理正常!","page":0,"pageSize":0,"returnListSize":0,"returnObject":null,"returnValue":null,"totals":0}

帝国CMS版接口说明

帝国CMS接口使用手册 一、简介 1、本接口应用于帝国CMS 版新闻系统模型的栏目文章发布; 2、本接口可以自动生成文章、栏目、首页等静态HTML页面; 3、本接口可以生成随机点击数,详见发布接口参数说明; 4、发布时请使用管理员用户帐号; 5、在帝国CMS utf8版使用本接口时,请在发布规则中选择编码为UTF-8; 6、本接口基于帝国CMS UTF8版制作,适用于帝国CMS GBK/utf-8等版本,应用于其他版本时请自行测试调整;; 7、接口文件无须任何改动即可使用,如果你希望增加校验或其他功能,请仔细修改; 8、2个接口文件请复制在网站 /e/admin目录下使用; 二、安装接口 在接口文件夹中找到接口文件,如图: 请将、等接口文件上传到指定目录,请使用二进制方式上传,如图: 三、配置发布规则 1、将范例发布规则文本导入ET2发布配置,或使用软件内置发布规则范例,如图:

2、将检查网址和发布网址中的“您的网站”改为您要发布的网站网址,如图: 3、在检查网址填上您要发布的栏目ID,如图: 4、在参数取值页,填上您要发布的网站栏目ID,如图: 这里查看栏目ID:

4、填上您的管理账号、密码,注意格式,如图: 四、接口说明 一、检查接口 1、接口文件名,为保密,请自行修改文件名; 2、本接口文件复制在网站/e/admin目录使用,如果目录名有变更,请自行对应; 3、主要参数 keyboard 文章标题 classid 栏目ID,用于指定检查栏目,可在后台网站栏目管理处查看; vercode 校验码,请自行设定,并在检查接口文件开始处修改$vercode 使其一致; 4、发布配置-文章检查网址处,可以如下填写: 注:使用大小写敏感的服务器的用户请注意网址大小写和网站文件一致 5、接口文件无须任何改动即可使用,如果你希望增加校验或其他功能,请仔细修改; 二、发布接口 1、接口文件名,为保密,请自行修改文件名; 2、本接口文件请复制在网站/e/admin目录下使用,为保密,请自行修改文件名;

接口使用说明文档

中国移动短信网关 SP端接口使用手册 China Mobile Shot Message Gateway Interface for SP Manual 作者:沈岗 日期:2004年1月 版本:V1.2

一、CMSMIF.CMPPApp 简要说明: 该类采用CMPP协议(V2.0)实现了SP端与移动短信网关的连接处理。 本类中,采用长连接方式与ISMG通讯。通信双方以客户-服务器方式建立TCP连接,用于双方信息的相互提交。当信道上没有数据传输时,通信双方应每隔时间C发送链路检测包以维持此连接,当链路检测包发出超过时间T后未收到响应,立即再发送链路检测包,再连续发送N-1次后仍未得到响应则断开此连接。参数C、T、N可通过属性配置。 消息发送时采用并发方式,即发送一条消息不等待网关回复确认,继续向网关发送短信,这样发送消息速度非常快,完全取决于网关的处理速度及网络速度。为避免消息丢失,同时采用了滑动窗口流量控制,窗口大小可通过属性设置。 消息接收、网络断开等采用事件触发方式,不需应用程序轮询,在此接口基础之上编程方便。 类中运用了多线程技术,如一条线程处理发送网络包,而另一条线程处理从网关上接收网络包,其他还有一些线程处理检测包、网络连接情况监测等,使程序思路明确、执行效率很高、运行非常稳定。 (一)属性 1.ActiveInterval 说明:检测包发送时间间隔,单位:毫秒。默认值为120000,即120秒。为上 述类说明中的C参数。 2.MaxNetworkPackSize 说明:与ISMG通讯时最大网络包大小,单位:字节。默认值为512Byte。 3.MaxRetryTimes 说明:网络超时最大重发次数,单位:次。默认值为3次。为类说明中的N。 4.OverTime 说明:网络包发送超时时间,单位:毫秒,超过此值还未收到回复则重发。默认值 为60000,即60秒。为类说明中的T。 5.QueueLength 说明:网络队列大小,单位:个,默认值为20。为类说明中的滑动窗口大小, 以控制发送流量。 (二)方法 1.ConnectToIsmg 方法说明: 连接到远程短信网关ISMG上,只有连接到远程短信网关上,才可进行短信收发操作。 在本操作中,自动初始化本地Socket,以连接到指定IP服务器的指定端口上。 声明原型:int ConnectToIsmg(string ServerIP,int Port,string SP_ID,string Secret,string SN) 参数说明: ServerIP:远程短信网关服务器的IP地址,如211.138.200.51 Port:远程短信网关服务器的端口号,如7890 SP_ID:企业服务代码

接口文档规范

XXX接口说明书(版本:V1.0)

修订记录

1简介 1.1文档目的 接口文档是前端与后端交互密不可分的环节,接口的规范性会直接影响双方对接过程中的效率和质量。本着快速高效开发的目的性,避免对接过程中的错误率。 1.2接口规范 (1) 遵循RESTful API设计风格 (2) 数据格式采用json格式 (3) 返回统一结构数据 例如: 结构:data(数据)、errorCode(状态码)、msg(提示信息) { data:{}, // 数据类型不一定为object类型 errorCode:10001, msg:'' } (4) 枚举型参数应列举参数所有值及说明 例如: gender:性别(男:1,女:2) userInfo:{ name:'张三', age:23, gender:1 }

(5) 具有嵌套关系的参数应指明嵌套关系及子级数据结构例如: billList: 账单列表(父级) billList:[ { id:'001', billName:'测试数据', billStauts:1, address:'雁塔区' } ] (6) 返回参数数据类型保持一致性 例如: billList: 账单列表(有数据) billList:[ { id:'001', billName:'测试数据', billStauts:1, address:'雁塔区' } ] billList: 账单列表(无数据) billList:[] 返回的参数数据类型都为:array (7) 下拉及选择型数据以键值对的形式返回 例如: orderOperate:订单操作 orderOperate:[

项目接口文档

接口使用说明书 2016年9月

版本控制文档信息 文档变更记录

目录 1.接口概述 (4) 1.1. 概述 (4) 1.2. 基本规则 (4) 1.2.1. 域名 (4) 1.2.2. 通用接口调用参数说明 (4) 2.接口定义 (6) 2.1. 登录注册 (6) 2.1.1. 登录接口 (6) 2.1.1.1. 账号密码登录 (6) 2.1.1.2. 微信登录............................................................................. 错误!未定义书签。 2.1.2. 注册和修改接口..................................................................... 错误!未定义书签。 2.1.2.1. 完善个人信息接口............................................................. 错误!未定义书签。 2.1.2.2. 获取个人资料..................................................................... 错误!未定义书签。 2.1.2. 3. 上传/修改企业信息 ........................................................... 错误!未定义书签。 2.1.2.4. 上传/修改工作经历 ........................................................... 错误!未定义书签。 2.1.2.5. 设置/修改提现密码 ........................................................... 错误!未定义书签。 2.1. 3. 短信部分接口......................................................................... 错误!未定义书签。 2.1. 3.1. 发送短信验证码接口......................................................... 错误!未定义书签。 2.1.4. 服务部分接口......................................................................... 错误!未定义书签。 2.1.4.1. 上传/修改个人服务信息 ................................................... 错误!未定义书签。 2.1.4.2. 获取服务列表..................................................................... 错误!未定义书签。 2.1.4. 3. 获取服务详情..................................................................... 错误!未定义书签。 2.1.4.4. 评价列表(全部服务或单个服务) ...................................... 错误!未定义书签。 2.1.4.5. 预约..................................................................................... 错误!未定义书签。 2.1.4.6. 服务评价............................................................................. 错误!未定义书签。 2.1.5. 我的账户................................................................................. 错误!未定义书签。 2.1.5.1. 获取用户收入/支出记录 ................................................... 错误!未定义书签。 2.1.5.2. 分页获取收入/支出记录 ................................................... 错误!未定义书签。 2.1.5. 3. 添加收入/支出记录 ........................................................... 错误!未定义书签。 2.1.6. 红包部分接口......................................................................... 错误!未定义书签。 2.1.6.1. 领取红包............................................................................. 错误!未定义书签。 2.1.6.2. 发放红包............................................................................. 错误!未定义书签。 2.1.7. 精英汇部分接口..................................................................... 错误!未定义书签。 2.1.7.1. 获取精英列表..................................................................... 错误!未定义书签。 2.1.7.2. 精英详情............................................................................. 错误!未定义书签。 2.1.8. 任务接口................................................................................. 错误!未定义书签。 2.1.9. 其他接口................................................................................. 错误!未定义书签。 2.1.9.1. 消息..................................................................................... 错误!未定义书签。 2.1.9.2. 省市区获取......................................................................... 错误!未定义书签。 2.1.9. 3. 行业类型获取..................................................................... 错误!未定义书签。 2.1.9.4. 上传多媒体资源................................................................. 错误!未定义书签。

APP接口开发规范文档-V1.0

{ APP接口规文档}手机客户端接口文档

版本历史

目录 一、概述 (1) 1.1 有关接口 (1) 1.1.1接口是纯数据的交互 (1) 1.2 接口的分类 (1) 1.2.1查询类接口 (1) 1.2.2 操作类接口 (1) 1.2.3上传下载类接口 (1) 1.2.4推送类接口 (1) 二、查询类接口格式规 (1) 2.1获取单条对象信息 (1) 2.1.1 请求格式 (1) 2.1.2参数说明 (2) 2.1.3正常返回结果 (2) 2.2获取列表对象信息 (3) 2.2.1 请求格式 (3) 2.2.2参数说明 (3) 2.2.3正常返回结果 (3) 三、操作类接口 (4) 3.1 新增操作 (4) 3.1.1接口说明 (4) 3.1.2参数说明 (4) 3.1.3正常返回结果 (4) 3.1.4错误返回列表 (5) 3.2 修改操作 (5) 3.2.1接口说明 (5) 3.2.2参数说明 (5) 3.2.3正常返回结果 (5) 3.2.4错误返回列表 (5) 3.3 删除操作 (6) 3.3.1接口说明 (6) 3.3.2参数说明 (6) 3.3.3正常返回结果 (6) 3.3.4错误返回列表 (6) 四、上传下载类 (7) 4.1 上传文件 (7) 4.1.1接口说明 (7) 4.1.2参数说明 (7) 4.1.3正常返回结果 (7) 4.1.4错误返回列表 (7) 4.2 下载文件 (7) 4.2.1接口说明 (7)

4.2.2参数说明 (8) 4.2.3正常返回结果 (8) 4.2.4错误返回列表 (8) 五、推送类接口 (8) 5.1 推送消息 (8) 5.1.1接口说明 (8) 5.1.2参数说明 (8) 5.1.3正常返回结果 (9) 5.1.4错误返回列表 (9) 六、通用返回格式 (9) 6.1 正确返回 (9) 6.1.1接口说明 (9) 6.1.2参数说明 (9) 6.1.3正常返回结果 (9) 6.1.4错误返回列表 (10) 6.2 错误返回 (10) 6.2.1接口说明 (10) 6.2.2参数说明 (10) 6.2.3正常返回结果 (10) 6.2.4错误返回列表 (10) 七、附录 (11) 7.1 通用错误返回列表 (11) 7.2 URL地址信息 (11) 7.2.1 主机地址 (11) 7.2.2 URL列表 (11) 7.3 安全机制 (11) 7.3.1 验证签名机制 (11) 7.4 其他 (12) 7.2.1 列表数据为空的返回 (12)

软件接口文档v2.0

研发平台软件项目 软件项目接口文档 作者: 完成日期: 签收人: 签收日期: 修改情况记录:

第1章引言........................................................................................... 错误!未定义书签。 编写目的................................................................................... 错误!未定义书签。 术语........................................................................................... 错误!未定义书签。 参考文献................................................................................... 错误!未定义书签。第2章接口定义................................................................................... 错误!未定义书签。 同步接口指令........................................................................... 错误!未定义书签。

1.1编写目的 说明对程序系统的接口设计、数据结构设计等,为开发编码奠定基础。 本文档描述本地UI软件的JavaScript代码和STB浏览器组件库iPanel之间的交互接口,包括请求的格式,请求结果的格式,相关错误的定义,以及请求和结果返回的交互流程。 本文的主要读者为需要系统前端开发人员、STB开发人员,以及需要了解本前端与STB 接口的相关人员。 1.2术语 术语或缩写词说明性定义 IPTV 交互式网络电视 STB 机顶盒 HTML 超文本置标语言 JavaScript 一种应用于客户端Web开发的脚本语言 CSS 层叠样式表 DOM 文档对象模型 JSON 专门为浏览器中的网页上运行的JavaScript代码而设计的 一种数据格式 XML 可扩展置标语言 iPanel IPTV终端浏览器 1.3参考文献

数据对接接口说明

数据对接接口说明 1.试剂管理平台接口概述 试剂管理平台(以下简称“平台”)集试剂采购、审批、库房管理、废弃物处置、结算、资料查询、安全教育宣传于一体的、量身定制的信息化管理平台。“平台”以“方便师生,寓管理于服务,以服务促管理”作为指导思想,通过简化、优化采购、审批等各环节流程,透明、规范采购,实现试剂全程可追溯、全过程闭环管理。 为保证“平台”供货商产品数据更新的及时性,现将其中部分功能数据对接接口的方式向供货商提供,具体接口如下表所示: ,并获取一个秘钥(userKey)。接口成功部署后,可通过访问 http://ip:port/services/frontWebService?wsdl获取接口的详细描述。 2.数据对接方法 2.1.String sayHi(String name) 这是一个测试方法,返回"hello, " + name的字符串,测试地址为: http://ip:port/services/frontWebService/sayHello?name=J 2.2.String submit(String xmlData, String sign) 主要的业务处理方法,后面所说的xml报文,即该方法的xmlData参数,sign 为xmlData+userKey的md5密文。返回值为xml格式的字符串。 3.XML报文定义规则 3.1.请求报文

3.2. 若无特殊说明,业务处理成功后,返回如下xml报文: ok 3.3.失败返回报文 若无特殊说明,业务处理失败后,返回如下xml报文: 4. 4.1.通用功能 4.1.1.文件上传(FUNC_ID= 1001) 4.1.2.文件下载(FUNC_ID= 1002) 4.2.产品信息 用于供货商上传产品数据,平台将以产品数据中“品牌”+“货号”+“包装规格”作为某条产品的唯一标识,如出现重复的将以最后一次上传为准。 数据接口开放时间为每天的08:00-22:00。 新上传的数据会在第二天生效,即上传后的第2天用户才可以搜索到。 上传的产品中不得存在管控品,包括易制毒、易制爆、剧毒和精神麻醉品,如因此产生的一切责任由供货商自己负责。 4.2.1.产品上传(FUNC_ID= 1201) 请求报文中节点描述如下:

api接口文档

API(Application Programming Interface,应用程序编程接口)是一些预先定义的函数,目的是提供应用程序与开发人员基于某软件或硬件的以访问一组例程的能力,而又无需访问源码,或理解内部工作机制的细节。API除了有应用“应用程序接口”的意思外,还特指API的说明文档,也称为帮助文档。 API:应用程序接口(API:Application Program Interface) 应用程序接口(是一组定义、程序及协议的集合,通过API 接口实现计算机软件之间的相互通信。API 的一个主要功能是提供通用功能集。程序员通过调用API 函数对应用程序进行开发,可以减轻编程任务。API 同时也是一种中间件,为各种不同平台提供数据共享。 根据单个或分布式平台上不同软件应用程序间的数据共享性能,可以将API 分为四种类型: 远程过程调用(RPC):通过作用在共享数据缓存器上的过程(或任务)实现程序间的通信。 标准查询语言(SQL):是标准的访问数据的查询语言,通过数据库实现应用程序间的数据共享。 文件传输:文件传输通过发送格式化文件实现应用程序间数据共享。

信息交付:指松耦合或紧耦合应用程序间的小型格式化信息,通过程序间的直接通信实现数据共享。 当前应用于API 的标准包括ANSI 标准SQL API。另外还有一些应用于其它类型的标准尚在制定之中。API 可以应用于所有计算机平台和操作系统。这些API 以不同的格式连接数据(如共享数据缓存器、数据库结构、文件框架)。每种数据格式要求以不同的数据命令和参数实现正确的数据通信,但同时也会产生不同类型的错误。因此,除了具备执行数据共享任务所需的知识以外,这些类型的API 还必须解决很多网络参数问题和可能的差错条件,即每个应用程序都必须清楚自身是否有强大的性能支持程序间通信。相反由于这种API 只处理一种信息格式,所以该情形下的信息交付API 只提供较小的命令、网络参数以及差错条件子集。正因为如此,交付API 方式大大降低了系统复杂性,所以当应用程序需要通过多个平台实现数据共享时,采用信息交付API 类型是比较理想的选择。 API 与图形用户接口(GUI)或命令接口有着鲜明的差别:API 接口属于一种操作系统或程序接口,而后两者都属于直接用户接口。 有时公司会将API 作为其公共开放系统。也就是说,公司制定自己的系统接口标准,当需要执行系统整合、自定义和程序应用等操作时,公司所有成员都可以通过该接口标准调用源代码,该接口标准被称之为开放式API。

项目接口需求及设计说明文档

媒讯集团E A S项目 CTC与EAS接口 需求及设计说明书 文档作者: 创建日期:20X X-05-10 确认日期: 当前版本:1.0 拷贝数量:1 审批签字: 客户方: 实施方:

文档控制 修改记录 日期作者版本参考版本备注

目录 1.概述 (4) 1.1读者 (4) 1.2图例 (4) 1.3目的 (4) 二、业务现状 (5) 三、概要设计 (5) 3.1接口通讯方式 (5) 3.2通讯内容定义 (5) 3.3媒讯CTC系统提供接口使用范例 (5) 3.4金蝶EAS提供接口使用范例 (5) 3.5媒讯CTC系统提供接口服务地址 (7) 3.6金蝶EAS提供接口服务地址 (7) 3.7接口需求 (7) 四、详细设计 (8) 4.1XX EAS接口 (8)

1.概述 金蝶与用户及用户业务系统方通过多次讨论,制定了接口开发需求设计说明书,作为双方后续开发指引。 1.1读者 本文读者对象为业务管理人员、系统设计、开发人员、测试人员。 1.2图例 本文中如未进行特殊说明,各图标代表的含义如下: 表示一个活动; 表示动态的业务数据,如系统单据; 表示流程走向; 表示条件判断、流程分支; 表示静态的业务数据,如基础资料; 表示系统外一个手工处理活动; 表示系统外手工填制的单据; 表示当前系统之外的活动; 表示当前系统之外产生的业务数据。 1.3目的 本文档是媒讯CTC系统与EAS系统接口的需求及设计方案相关文档,可用于指导开发、测试工作和作为验收相关依据文档。

二、业务现状 待补充 三、概要设计 3.1接口通讯方式 金蝶EAS与媒讯CTC系统之间通讯采用WebService方式进行数据传输。 3.2通讯内容定义 对于记录型的大对象,在通讯时,采用String型的xml格式的参数进行传递。对于其他非记录型的对象,在通讯时,可采用非xml格式的参数进行传递,也可使用多个参数。具体格式,请参照每个接口的通讯用例说明。 3.3媒讯CTC系统提供接口使用范例 待补充。 3.4金蝶EAS提供接口使用范例 3.4.1规范说明 EAS通过webService接口与异构系统通信。EAS WebService全部是使用java编写的,其接口描述符合WSDL国际标准,其数据描述符合XSD 国际标准。 本次提供的接口除系统登录接口外,其他接口都需要调用登录接口,以便将登陆的SessionId信息放入到SOAP 的HEADER 报文中。 3.4.2使用示例 金蝶在EAS上发布WebService服务,提供wsdl文件供客户端下载,其他业务系统根据下载的wsdl文件,产生客户端。 建议使用Axis2来生成客户端代理。

中国财务软件数据接口标准(DOC7)

中国财务软件数据接口标准(DOC7) 编者按:标准应该是衡量事务的准则。标准的制定一样都由国际/国家有关标准机构或行业主管部门完成。但一些行业的生产厂商为了爱护用户的投资,促进行业有序进展,也按照本行业的特点,联合起来制定了一些大伙儿认可并共同遵守的规范,这种做法在国外已被广泛采纳。随着中国改革开放的深入,国内一些行业的厂家也开始进行这方面的探究,本期我们刊登的《中国财务软件数据接口标准》确实是由该财务软件行业的民间组织——中国软件行业协会财务及企业治理软件分会制定的,起草者为闻名财务软件厂商深圳金蝶公司。 一、背景 目前,国内财务软件众多,它们采纳的数据库平台和数据库结构各不相同,不同财务软件之间的数据交换,因为数据库平台和结构不同而产生许多困难,几乎任意两个不同软件之间要实现数据传递都会存在专门的数据转换咨询题。烦琐的数据转换工作白费了大量人力和物力,同时也阻碍了财务软件产业的健康进展。国内财务软件的商业化差不多比较成熟,各财务软件公司都有一批用户。由于各种缘故,一些用户期望从一个软件交叉升级为另一软件。由于用户在旧软件上已做了大量的工作,必定期望升级后原有数据能移植到新的软件中,然而有些软件的数据文件通过加密或数据库结构未公布,要从中直截了当读取数据几乎不可能。为了爱护用户已付出的劳动,各财务软件需要提供一个标准的数据输入输出接口。如此,建立一个公用的数据交换标准是专门必要的。 用户在使用财务软件时,有一些需求通过财务软件本身是难以实现的,如:用户期望把会计报表通过电子表格软件处理输出为各种专门形式;另一些高级用户,则期望在其它治理软件中能取到财务数据。这些数据交换工作都需要有一个标准的数据接口来规范。财务会计通过长期的进展已形成一定的理论,财务会计工作也有规范可循,国内财务软件是在这些理论和规范的基础上开发出来的,各软件储存财务数据的模式也大同小异。财务数据要紧按会计科目、凭证、余额及发生额、报表几个部分分块储备,它们之间既

文档管理系统方案

文档管理系统解决方案 2010.08

1概述 .............................................................................................................................................................................. - 4 - 1.1系统目标 (4) 1.2系统框架 (4) 2设计方案 ...................................................................................................................................................................... - 5 - 2.1系统管理 (5) 2.1.1组织机构 ........................................................................................................................................................ - 5 - 2.1.2人员管理 ........................................................................................................................................................ - 5 - 2.1.3编码配置 ........................................................................................................................................................ - 6 - 2.1.4权限管理 ........................................................................................................................................................ - 6 - 2.1.5文档后台管理 ................................................................................................................................................ - 6 - 2.2文档管理主页 (6) 2.2.1文档发布 ........................................................................................................................................................ - 6 - 2.2.2文档排名 ........................................................................................................................................................ - 6 - 2.2.3文档推荐 ........................................................................................................................................................ - 6 - 2.2.4文档分类 ........................................................................................................................................................ - 6 - 2.3文档管理功能 (6) 2.3.1文档上传 ........................................................................................................................................................ - 7 - 2.3.2文档下载 ........................................................................................................................................................ - 7 - 2.3.3文档阅读 ........................................................................................................................................................ - 7 - 2.3.4文档播放 ........................................................................................................................................................ - 7 - 2.3.5文档查找 ........................................................................................................................................................ - 8 - 2.3.6文档统计 ........................................................................................................................................................ - 8 - 2.4系统接口 (8)

项目接口需求及设计说明文档(模板)

客户化开发需求规格说明书 媒讯集团E A S项目 CTC与EAS接口 需求及设计说明书 文档作者: 创建日期:2013-05-10 确认日期: 当前版本:1.0 拷贝数量:1 审批签字: 客户方: 实施方:

文档控制 修改记录 日期作者版本参考版本备注

目录 1.概述 (4) 1.1读者 (4) 1.2图例 (4) 1.3目的 (4) 二、业务现状 (5) 三、概要设计 (5) 3.1接口通讯方式 (5) 3.2通讯内容定义 (5) 3.3媒讯CTC系统提供接口使用范例 (5) 3.4金蝶EAS提供接口使用范例 (5) 3.5媒讯CTC系统提供接口服务地址 (7) 3.6金蝶EAS提供接口服务地址 (7) 3.7接口需求 (7) 四、详细设计 (8) 4.1XX EAS接口 (8)

1.概述 金蝶与用户及用户业务系统方通过多次讨论,制定了接口开发需求设计说明书,作为双方后续开发指引。 1.1读者 本文读者对象为业务管理人员、系统设计、开发人员、测试人员。 1.2图例 本文中如未进行特殊说明,各图标代表的含义如下: 表示一个活动; 表示动态的业务数据,如系统单据; 表示流程走向; 表示条件判断、流程分支; 表示静态的业务数据,如基础资料; 表示系统外一个手工处理活动; 表示系统外手工填制的单据; 表示当前系统之外的活动; 表示当前系统之外产生的业务数据。 1.3目的 本文档是媒讯CTC系统与EAS系统接口的需求及设计方案相关文档,可用于指导开发、测试工作和作为验收相关依据文档。

二、业务现状 待补充 三、概要设计 3.1接口通讯方式 金蝶EAS与媒讯CTC系统之间通讯采用WebService方式进行数据传输。 3.2通讯内容定义 对于记录型的大对象,在通讯时,采用String型的xml格式的参数进行传递。对于其他非记录型的对象,在通讯时,可采用非xml格式的参数进行传递,也可使用多个参数。具体格式,请参照每个接口的通讯用例说明。 3.3媒讯CTC系统提供接口使用范例 待补充。 3.4金蝶EAS提供接口使用范例 3.4.1规范说明 EAS通过webService接口与异构系统通信。EAS WebService全部是使用java编写的,其接口描述符合WSDL国际标准,其数据描述符合XSD 国际标准。 本次提供的接口除系统登录接口外,其他接口都需要调用登录接口,以便将登陆的SessionId信息放入到SOAP 的HEADER 报文中。 3.4.2使用示例 金蝶在EAS上发布WebService服务,提供wsdl文件供客户端下载,其他业务系统根据下载的wsdl文件,产生客户端。 建议使用Axis2来生成客户端代理。

相关文档
最新文档