4PX API接口参数说明文档(2016年7月13日)
API接口调用说明及示例(第四次修订)
产品/项目名称Product/Project Name 保密级别Confidentiality LeveleYou邮件系统机密产品/项目版本Product/Project Version 最后更新日期Last Update8103 2014-09-12 eYou邮件系统V8接口文档北京亿中邮信息技术有限公司All Rights Reserved 版权所有侵权必究仅供内部使用Revision Record 修订记录目录1 API接口简介------------------------------------------------------------------------ 42 API认证概述------------------------------------------------------------------------ 52.1 认证方式的分类-------------------------------------------------------------- 52.2 认证方式的选择-------------------------------------------------------------- 52.3 认证原理 --------------------------------------------------------------------- 53 认证方法详解及示例 ---------------------------------------------------------------- 63.1 OAuth ----------------------------------------------------------------------- 63.2 eYouAuth -------------------------------------------------------------------- 63.2.1 SSO API的eYouAuth认证方法: ------------------------------------- 63.2.2 Feed API的eYouAuth认证方法: ------------------------------------ 73.2.3 申请会话Token:------------------------------------------------------ 94 API接口调用示例 ------------------------------------------------------------------ 114.2 Feed API调用 ---------------------------------------------------------- 114.2.1 资源概述-------------------------------------------------------------- 114.2.2 以用户的增删改查为例,示例各种Feed API调用步骤---------------- 135 附表-------------------------------------------------------------------------------- 171 API接口简介API指eYou邮件系统所提供的接口。
API接口说明书模板
API接口说明书Word模板API接口说明书某某系统接口说明书北京某某科技有限公司2020年7月目录某某系统接口说明书1引言1.1编写目的1.2范围1.3参考资料2APP接口说明2.1接口名称2.1.1请求地址2.1.2参数说明2.1.3返回结果说明2.1.4示例1引言1.1编写目的本报告的目的为了明确某某艺术馆App调用系统服务器的接口,为安排App的开发提供依据。
1.2范围本报告主要围绕App应用提出的基本需求,为下一步的App开发系统提供基础的API接口。
2APP接口说明2.1接口名称2.1.1请求地址2.1.3返回结果说明2.1.4示例URL:http://www.***.com/d/app/focusAd?type=1&locale=zh 返回结果:[{"id":18,"picUrl":"focusad/08f5c8d1-7671-4514-cfc0-7a76e4e64836.jpg","title":"独立风骨","type":1,"createtime":1434532509000,"effTs":14345325 09000,"des":"","isUsing":1,"sortNum":1,"toUrl":"http://w ww.***.com/guest/88242"},{"id":16,"picUrl":"focusad/fd e16538-50f1-48f6-ef14-b17c78772fa1.jpg","title":"华南理工大学","type":1,"createtime":1433154304000,"effTs":14331543 04000,"des":"舞跃华南","isUsing":1,"sortNum":1,"toUrl":"http://www.***com/c ontent/expoEvent16/1"},{"id":19,"picUrl":"focusad/b1782a75-429f-476f-cc75-8c3601e85ddb.jpg","title":"中央美术学院"}]。
api接口说明文档模板文
api接口说明文档模板文api接口说明文档模板1正如在"什么是API"中所说,API函数包含在位于系统目录下的DLL文件中.你可以自己输入API函数的声明,但VB提供了一种更简单的方法,即使用API Text Viewer. 要想在你的工程中声明API函数,只需运行API Text Viewer,打开Win32api.txt(或.MDB如果你已经把它转换成了数据库的话,这样可以加快速度. 使用预定义的常量和类型也是同样的方法. API除了有应用“应用程序接口”的意思外,还特指 API的说明文档,也称为帮助文档。
你将会遇到一些问题假设你想在你的窗体模块中声明一个函数.粘贴然后运行,VB会告诉你:编译错误...Declare 语句不允许作为类或对象模块中的 Public 成员...看起来很糟糕,其实你需要做的只是在声明前面添加一个Private(如 Private Declare Function...).--不要忘了,可是这将使该函数只在该窗体模块可用. 在有些情况下,你会得到"不明确的名称"这样的提示,这是因为函数.常量或其他的什么东西共用了一个名称.由于绝大多数的函数(也可能是全部,我没有验证过)都进行了别名化,亦即意味着你可以通过Alias子句使用其它的而不是他们原有的名称,你只需简单地改变一下函数名称而它仍然可以正常运行.api接口说明文档模板文21、技术优势具有高效率、团结、富有创意的团队,技术实力雄厚,可针对不同层次客户的需求;2、服务优势领先的技术、严密的流程、品牌的保证,为在线交易给予有力的安全保障;庞大的客服体系,为您提供7×24小时不间断的客户服务;3、卡类兑换优势解决客户往返银行汇款的麻烦,提升客户效率,有效增加订单数量。
百汇通具有几十种的卡类兑换方式,与上游运营商合作密切,有大部分运营商充值接口,卡类产品的多样化能够满足所有客户的对于卡类兑换的需求。
中国数据域名API文档
中国数据域名API接口说明文档作者:江苏邦宁科技有限公司发行日期:2010/03/01最新修改:2011/04/18版本变更说明前言本文档描述了中国数据域名注册API接口协议。
本文档描述了基本的数据交换标准,其中包括数据格式,数据定义,以及一些相关约定。
目录1.API接口 (4)1.1接口地址与协议 (4)1.2接口返回值 (4)1.3常见错误说明 (5)2.参数说明 (6)2.1公共参数说明 (6)2.2域名接口功能 (6)2.2.1域名查询 (6)2.2.2域名注册 (7)2.2.3域名续费 (10)2.2.4域名修改密码 (11)2.2.5域名修改DNS (11)2.2.6域名登录控制面板 (12)3.附录 (13)3.1国家与国家的缩写 (13)1.API接口1.1接口地址与协议接口协议:接口采用HTTP+POST协议,参数编码为GBK域名注册、续费等交易接口地址:/agentserver/product/对此地址的操作将实时扣费,操作前,请确保用户账户内有足够的可用金额(可以登录中国数据网站查询可用金额)。
域名查询、修改DNS、修改密码、登录面板等辅助功能地址:/agentserver/assist/对此地址的操作不需要费用。
1.2接口返回值每次操作将返回一个XML,主要包含<returnvalue>和<returninfo>两个结点。
<returnvalue>表示本次操作是否成功,取值为true或false。
<returninfo>返回具体的信息,操作成功有成功的结果,失败有失败的原因等。
举例,以下为查询一个域名是否被注册的返回XML:<?xml version="1.0"encoding="utf-8"?><xmlmsg><returnvalue>true</returnvalue><returninfo>reg</returninfo></xmlmsg>1.3常见错误说明act-invalid act值为空或act不在接受范围之内act-non-exists act不在接受范围之内user-null u_name值为空user-non-exists u_name不存在,请确保该会员名是中国数据网站的会员名checkTime-invalid时间字符串格式不正确(正确的是14位数字串)checkSum-invalid校验码格式不正确(正确的是32位MD5加密串)checksum-fail校验码校验失败,请检查加密方式和相关参数值是否正确2.参数说明2.1公共参数说明2.2域名接口功能2.2.1域名查询1、功能说明域名查询功能是检查一下域名当前是否已经注册。
广州首易信息技术有限公司API接口使用手册说明书
广州首易移动业务A P I (W e b S e r v i c e)使用手册广州首易信息技术有限公司2012年1月目录一、引言 (4)1.1 编写目的 (4)1.2 背景说明 (4)1.3 术语定义 (4)二、概述 (5)2.1 接口功能 (5)2.2 接口组成 (5)三、接口介绍 (6)3.1 网络结构 (6)3.2 运行环境 (6)3.3连接方式 (6)3.4 WebService地址 (6)3.5 WSDL描述文件 (7)四、API函数说明 (7)4.1短信部分 (7)4.1.1 Sms_Send函数 (7)4.1.2 Sms_GetRecv函数 (8)4.1.3 Sms_GetReport函数 (9)4.1.4 Sms_GetSign函数 (10)4.1.5 Sms_GetBalance函数 (10)4.2彩信部分 (11)4.2.1 Mms_UpFile函数 (11)4.2.2 Mms_GetFileStatus函数 (12)4.2.3 Mms_Send函数 (13)4.2.4 Mms_GetRecv函数 (14)4.2.5 Mms_GetReport函数 (15)4.3批量任务部分 (16)4.3.1 Task_UpFile函数 (16)4.3.2 Task_DelFile函数 (17)4.3.3 Task_SmsSend函数 (18)4.3.4 Task_GetSmsStatus函数 (19)4.3.5 Task_SmsStop函数 (20)4.3.6 Task_SmsStart函数 (20)4.3.7 Task_MmsSend函数 (21)4.3.8 Task_GetMmsStatus函数 (22)4.3.9 Task_MmsStop函数 (23)4.3.10 Task_MmsStart函数 (24)五、附件 (24)5.1错误代码汇总表 (24)5.2短信/彩信状态码汇总表 (27)5.3批量任务短信/彩信状态码汇总表 (27)一、引言1.1 编写目的广州首易的移动商务平台提供了强大的移动业务接入机制,现支持短信、彩信的全国应用。
(完整版)接口文档样例模板
字段中文名
英文名
类型
是否必填
业务补充描述
项目ID
Project_id
bigint
Y
1.4、返回信息:
字段中文名
英文名
类型
业务补充描述
项目ID
Id
楼盘Code
f_house_code
项目名
prj_name
标签
prj_tags
开发商
developers
销售状态
project_sale
经纬度
1、查询结果按照创建时间排序显示。。。。。
project_location
project_sale返回信息
字段中文名
英文名
类型
业务补充描述
销售状态
sale_status
在售、待售、售完
project_location
字段中文名
英文名
类型
业务补充描述
经度
longitude
纬度
latitude
1.5、业务返回规则要求(业务方面的返回要求,比如查询结果按照时间排序之类的)
项目名称
项目信息
功能描述:
【获取项目基本信息(整个项目信息模块的接口功能描述)】
返回说明:
参数名称
类型
描述
Code
String
状态码:
200成功
404错误
Msg
String
信息描述
Data
返回的数据
1.
【对标题接口必须有序号,方便后期的维护和修改跟进】【接口功能描述】
1.1、请求协议(https)
1.2、请求方式(GET)
(完整版)接口说明文档
1.1.1.1接口功能
客户端检测服务端是否可达.
接口采用webservice技术。当客户端需要连接服务端并确保连接可达时,将通过webservice的方式向服务器发送检测请求,服务端响应客户端的请求,把处理结果返回给客户端。
接口调用方法为http://url/isServerAvailable.
String
32
timestamp
时间戳,用于防重放攻击
String
18
1.1.1.3应答参数
接口参数说明如下:
名称
说明
数据类型
长度(字节)
result
结果:
1:成功
-1:失败
-2:参数错误
—3:hashCode错误
Int
1
info
返回结果的说明,该字段可选
String
128
hashCode
把所有的简单类型的字段按顺序组合后+key计算md5
方法名:isServerAvailable
1.1.1.2请求参数
包含的参数说明如下:
名称
说明
数据类型
长度(字节)
loginName
接口验证账号
String
30
loginPwd
接口验证密码
String
30
hashCode
除loginName,loginPwd,hashCode外的所有字段+Key 组合后计算md5
String
32
timestamp
时间戳,用于防重放攻击
String
18
4PX API接口参数说明文档(2016年7月13日)
4PX 物流接口参数说明深圳递四方速递2012-06版本信息版本最后修改日期修改人修改内容备注0.1 2012-6-27 陈宏波建立文档0.2 2012-11-14 陈宏波修改文档0.3 2016-04-11 缪金荣修改文档增加黄色底字段和1.11/1.120.4 2016-07-13 缪金荣增加投保类型为6P时的投保信息内容:InsurApplicant、InsurCardNo、InsurCargoName、InsurQuantityPack 增加1.1、1.3、1.4黄色底字段0.5 2017-07-29 吴中卫 1.修改了wsdl调用的url2.创建并预报接口修改为createAndPreAlertOrderServiceNew3.增加补充说明增加返回的参数fpxOrderNo 黄色底字段目录1. 概述 (5)1.1. 写作目的 (5)1.2. 本文读者 (5)1.3. 调用方式 (5)1.3.1.WSDL (5)1.3.2.API订单验证流程 (5)2API 接口参数 (6)2.1. 创建订单 (6)2.1.1.请求参数 (6)2.1.2.返回参数 (13)2.2. 预报订单 (14)2.2.1. 请求参数 (14)2.2.2. 返回参数 (15)2.3. 创建并预报订单 (16)2.3.1. 请求参数 (17)2.3.2. 返回参数 (23)2.4. 修改订单 (25)2.4.1. 请求参数 (25)2.4.2. 返回参数 (30)2.5. 删除订单 (32)2.5.1. 请求参数 (32)2.5.2. 返回参数 (33)2.6. 查询订单 (34)2.6.1. 请求参数 (34)2.6.2. 返回参数 (36)2.7. 运费试算 (41)2.7.1. 请求参数 (42)2.7.2. 返回参数 (44)2.8. 查询轨迹 (47)2.8.1. 请求参数 (47)2.8.2. 返回参数 (47)2.9. 申请拦截 (49)2.9.1. 请求参数 (50)2.9.2. 返回参数 (50)2.10. 查询跟踪号 (51)2.10.1. 请求参数 (52)2.10.2. 返回参数 (52)2.11.查询标签信息 (54)2.11.1 请求参数 (54)2.11.2 返回参数 (54)2.12.打印标签(获取标签图片字节流) (57)2.12.1 请求参数 (57)2.12.2 返回参数 (58)3补充说明 (59)3.1基础数据参照表 (59)3.2常用接口错误代码说明 (59)3.2.1创建并预报异常代码说明 (59)1. 概述1.1. 写作目的本文档是 4PX 提供的物流接口参数说明,以供开发人员和测试人员参考。
快递鸟接口技术文档说明书
快递鸟接口(API)技术文档1前言 (5)2接口规范说明 (5)2.1接口规范及说明 (5)2.1.1报文及报文编码 (5)2.1.2接口数据包结构 (5)2.1.3JSON示例 (6)2.1.4系统级参数 (6)2.1.5流程示意图 (7)2.2签名说明 (7)2.2.1关于签名 (7)2.2.2(C#)DataSign签名加密代码 (9)3下单类接口 (10)3.1接入步骤 (10)3.2预约取件接口 (11)3.2.1功能说明 (11)3.2.2基本信息 (11)3.2.3接口规则 (12)3.2.4支持情况 (12)3.2.5应用级参数 (12)3.2.6返回参数 (17)3.3预约取件取消接口 (17)3.3.1功能说明 (17)3.3.2基本信息 (17)3.3.3接口规则 (18)3.3.4支持情况 (18)3.3.5应用场景 (18)3.3.6应用级参数 (18)3.3.7返回参数 (19)3.4电子面单接口 (19)3.4.1功能说明 (19)3.4.2基本信息 (19)3.4.3应用场景 (20)3.4.4接口规则 (20)3.4.6应用场景 (21)3.4.7应用级参数 (21)3.4.8返回参数 (30)3.5电子面单取消接口 (35)3.5.1功能说明 (35)3.5.2基本信息 (36)3.5.3接口规则 (36)3.5.4支持情况 (36)3.5.5应用级参数 (36)3.5.6返回参数 (37)3.6电子面单追加子单接口 (37)3.6.1功能说明 (37)3.6.2基本信息 (37)3.6.3应用级参数 (38)3.6.4返回参数 (38)3.7获取电子面单文件接口 (39)3.7.1功能说明 (39)3.7.2基本信息 (39)3.7.3应用级参数 (39)3.7.4返回参数 (40)4轨迹查询类接口 (42)4.1即时查询接口 (42)4.1.1功能说明 (42)4.1.2基本信息 (42)4.1.3接口规则 (42)4.1.4支持情况 (42)4.1.5应用场景 (42)4.1.6应用级参数 (42)4.1.7返回参数 (43)4.2物流跟踪 (45)4.2.1轨迹订阅接口 (45)4.3单号识别接口 (64)4.3.1功能说明 (64)4.3.2基本信息 (64)4.3.3接口规则 (64)4.3.4应用级参数 (64)4.3.5返回参数 (65)5增值类接口 (66)5.1在途监控-国内版 (66)5.1.1即时查询接口(增值版) (66)5.1.2物流跟踪接口(增值版) (72)5.2快递查询接口 (78)5.2.1功能说明 (78)5.2.2基本信息 (78)5.2.3接口规则 (78)5.2.4支持情况 (78)5.2.5应用场景 (78)5.2.6应用级参数 (78)5.2.7返回参数 (79)5.3在途监控-国际版 (84)5.3.1物流跟踪接口(国际版) (84)5.4物流查询地图接口 (86)5.4.1即时查询接口(地图版) (87)5.4.2物流跟踪接口(地图版) (95)5.5短信服务 (100)5.5.1短信模板接口 (101)5.5.2短信发送接口 (103)5.5.3短信黑名单接口 (105)5.6智能地址解析接口 (106)5.6.1功能说明 (106)5.6.2基本信息 (106)5.6.3应用级参数 (106)5.6.4返回参数 (107)6附录 (109)6.1对接相关资料 (109)6.2电子面单模板规格 (109)6.3返回编码列表 (116)7技术支持 (117)1前言快递鸟API旨在为电商、电商平台、物流工具、打单工具、仓储系统、移动APP等系统提供专业、稳定、优质的API接口服务,满足不同用户的物流管理需求。
接口参数说明
1.获取飞行计划及放行单信息接口一、用途获取飞行计划及放行单信息。
二、接口详述接口类型:■读出□写入入口参数:<MgsRequest><MsgHeader><UserId></UserId><UserPwd></UserPwd><MessageType>FlightPlan</MessageType> 路由编号</MsgHeader><Parameter><DatopBTime>2008-05-03</DatopBTime> DATOP开始时间<DatopETime>2008-05-03</DatopETime> DATOP结束时间<StdDateBTime>2008-05-03</StdDateBTime> 航班日期开始时间 <StdDateETime>2008-05-03</StdDateETime> 航班日期结束时间 <FlightNo></FlightNo> 航班号<Depstn></Depstn> 起飞机场三字码<Arrstn></Arrstn> 到达机场三字码</Parameter></MgsRequest>返回值参数说明:(Rsp_FlightPlan.xml)cniDispatchID 表IDcndtdatop 航班日期cndtstdDate 航班号cnvcFlightNo 航班号cnvcDepstn 出发地cntContent 内容飞行计划cnvcRemark 备注cnvcBackupAirport 备降机场cntReport 签派放行单cnvcAccessory1 附件1cnvcAccessory2 附件2cnvcAccessory3 附件3cnvcAccessory4 附件4cnvcAccessory5 附件5cnvcAccessory6 附件6cnvcAccessory7 附件7cnvcAccessory8 附件8cnvcAccessory9 附件9cnvcAccessory10 附件10cnvcCompanyID 公司IDcniIsDelete 删除标示cnvcAdminEname 操作人账号cnvcAdminCname 操作人姓名cndtAdminTime 操作时间cndStdTime 计划起飞时2.获取放行数据记录信息接口一、用途获取放行数据记录。
VIM系列HTTP API手册说明书
12 June 17This manual explains how to use HTTP-based API of the VIM series. The HTTP-based interface supports the feature of setting internal values with a specific parameter.Features AddedThree new commands were added: Email Hold Time / Email Delay Time / Cancel All Emails.Special NotesThe default API credentials are admin / 1111. To change this, login into the camera using the API credentials, then go to Configuration > User Management. Check the box for the Admin account and choose “Modify Pwd”. Change the password to the current admin ac count (default is admin / admin).Once you have done this, the local admin and API admin accounts will be merged and you can use the same admin account to authorize login and API commands.Known LimitationsThe API port is hard-coded at 8090. This currently cannot be changed.Commands provided in this manual are currently not compatible with the NVRs.Snapshot StreamExample Syntax:http://ipaddress/snapshot.jpgENTRY DATA FORMAT DESCRIPTION COMMENTN/A N/A Provides a single staticJPG image Send command as-is, no additional entries neededRTSP StreamExample Syntax:rtsp://username:password@ipaddress:Port/1/StreamIDENTRY DATA FORMAT DESCRIPTION COMMENT Port 554 Default RTSP port, can bechanged by going toConfiguration > NetworkManagement > NetworkService > Other > RTSPPortMust be a numeric valueStreamID 1 ~ 3 1st Stream, 2nd Streamor 3rd Stream Must be a numeric valueVIM Series HTTP API ManualVCA EventsExample Syntax:http://username:password@ipaddress:8090/ISAPI/SystemEx/Video/inputs/channels/ChannelID/Rule/RuleID/sce nes/SceneID/VCA/ActionENTRY DATA FORMAT DESCRIPTION COMMENT ChannelID 1 ~ 3 Corresponds to the videochannel IDMust be a numeric valueRuleID 1 ~ 8 Corresponds to the RuleIDMust be a numeric valueSceneID 1 ~ 16 Corresponds to the SceneIDMust be a numeric valueAction enabled | disabled Either enables or disablesthe VCA eventVideo StreamsExample Syntax:http://username:password@ipaddress:8090/ISAPI/streamingEx/channels/ChannelID/ActionENTRY DATA FORMAT DESCRIPTION COMMENT ChannelID 1 ~ 3 Corresponds to the videochannel IDMust be a numeric valueAction enabled | disabled Enables or disables thevideo stream This disables ONVIF/RTSP, Web UI will still show videoDigital OutputExample Syntax:http://username:password@ipaddress:8090/ISAPI/SystemEx/Output/OutputID/ActionValid entriesENTRY DATA FORMAT DESCRIPTION COMMENTOutputID 1 ~ 3 Corresponds to the AlarmOutput Some models differ on the amount of outputs availableAction enabled | disabled Either enables or disablesthe Alarm OutputAudio InputExample Syntax:http://username:password@ipaddress:8090/ISAPI/SystemEx/Audio/1/ActionValid entriesENTRY DATA FORMAT DESCRIPTION COMMENT Action enabled | disabled Either enables or disablesthe Audio InputHTTP MJPEG StreamExample Syntax:http://username:password@ipaddress:8090/ISAPI/MjpegStream/1/StreamID ENTRY DATA FORMAT DESCRIPTION COMMENTStreamID 1 ~ 2 Corresponds to the 1stStream and 2nd Stream Video Encoding must be set to MotionJPEG for this to workSend PTZ to PresetExample Syntax:http://username:password@ipaddress:8090/PSIA/PTZCtrlEx/channels/1/presets/PresetID/gotoValid entriesENTRY DATA FORMAT DESCRIPTION COMMENT PresetID 1 ~ 60 Corresponds to thePreset number.Must be a numeric value.Send PTZ to SceneExample Syntax:http://username:password@ipaddress:8090/PSIA/PTZCtrlEx/channels/1/scenes/SceneID/gotoENTRY DATA FORMAT DESCRIPTION COMMENT SceneID 1 ~ 16 Corresponds to theScene.Must be a numeric value.PTZ MovementExample Syntax:http://username:password@ipaddress:8090/PSIA/PTZCtrlEx/channels/1/controls/ActionValid entriesENTRY DATA FORMAT DESCRIPTION COMMENT Action up Moves the PTZ upward Movement continues untilstop command is received.Action down Move the PTZ downward Movement continues untilstop command is received.Action Left Moves the PTZ to the left Movement continues untilstop command is received.Action Right Moves the PTZ to theright Movement continues until stop command is received.Action Leftup Moves the PTZ upwardtoward the left Movement continues until stop command is received.Action Rightup Moves the PTZ upwardtoward the right Movement continues until stop command is received.Action Leftdown Moves the PTZ downwardtoward the left Movement continues until stop command is received.Action Rightdown Moves the PTZ downwardtoward the right Movement continues until stop command is received.Action Zoomin Zooms the PTZ in Movement continues untilstopped or end is reached.Action Zoomout Zooms the PTZ out Movement continues untilstopped or end is reached.Action stop Stops all PTZ movementEmail Hold TimeExample Syntax:http://username:password@ipaddress:8090/ISAPI/SystemEx/Network/mailing/Holdonoff/channels/1/ti me/TimeValue/ActionValid entriesENTRY DATA FORMAT DESCRIPTION COMMENTTimeValue 0 ~ 300 Holds all VCAnotifications until thetime has expired Must be a numeric value. Time is in seconds.Action enabled | disabled Either enables or disablesthe Hold TimeEmail Delay TimeExample Syntax:http://username:password@ipaddress:8090/ISAPI/SystemEx/Network/mailing/Delayonoff/channels/1/ti me/TimeValue/ActionENTRY DATA FORMAT DESCRIPTION COMMENT TimeValue 0 ~ 300 Sends the first VCAnotification, and delaysall subsequentnotifications until timehas expired.Must be a numeric value.Action enabled | disabled Either enables or disablesthe Delay Time.Cancel All EmailsExample Syntax:http://username:password@ipaddress:8090/ISAPI/System/Network/mailing/DelayTimeResetENTRY DATA FORMAT DESCRIPTION COMMENTN/A N/A This command will cancelall pending emails andpurge from memory. Send command as-is, no additional entries needed.Success Response Example<ResponseStatus xmlns="/ver20/XMLSchema" version="2.0"> <requestURL>/ISAPI/streamingEx/channels/1/enabled</requestURL><statusCode>1</statusCode><statusString>OK</statusString><subStatusCode>ok</subStatusCode></ResponseStatus>。
Zoltar API 接口文档说明书
Package‘zoltr’October14,2022Title Interface to the'Zoltar'Forecast Repository APIVersion0.5.1Description'Zoltar'<https:///>is a website that provides a repository of model forecast resultsin a standardized format and a central location.It supports storing,retrieving,comparing,and an-alyzing timeseries forecasts for prediction challenges of interest to the modeling community.This pack-age provides functionsfor working with the'Zoltar'API,including connecting and authenticating,getting informa-tion about projects,models,and forecasts,deleting and uploading forecast data,and downloading scores.URL https:///reichlab/zoltr,http://reichlab.io/zoltr/BugReports https:///reichlab/zoltr/issuesLicense GPL-3Encoding UTF-8LazyData trueSuggests testthat,knitr,rmarkdownImports httr,jsonlite,readr,mockery,webmockr,base64url,dplyr,MMWRweek,utils,rlang,magrittrRoxygenNote7.1.0VignetteBuilder knitrNeedsCompilation noAuthor Matthew Cornell[aut,cre],Nicholas Reich[aut,cph]Maintainer Matthew Cornell<*****************>Repository CRANDate/Publication2020-04-1500:20:03UTC12create_model R topics documented:create_model (2)create_project (3)delete_forecast (4)delete_model (4)delete_project (5)download_forecast (6)forecasts (6)forecast_data_from_cdc_csv_file (7)forecast_data_from_cdc_data_frame (8)forecast_info (8)get_resource (9)models (9)model_info (10)new_connection (11)projects (11)project_info (12)scores (13)targets (13)target_info (14)timezeros (15)timezero_info (15)truth (16)unit_info (17)upload_forecast (17)upload_info (18)upload_info_forecast_url (19)zoltar_authenticate (20)zoltar_units (20)Index22 create_model Create a modelDescriptionCreates the model in the passed project using the passed list.Fails if a model with the passed name already exists.Usagecreate_model(zoltar_connection,project_url,model_config)create_project3Argumentszoltar_connectionA‘ZoltarConnection‘object as returned by new_connection project_url url of a project in zoltar_connection’s projects.this is the project the new model will be created inmodel_config A‘list‘containing a Zoltar model configuration.An example:example-model-config.json.Full documentation at https:///.Valuemodel_url of the newly-created modelExamples##Not run:new_model_url<-create_model(conn,"https:///project/9/",jsonlite::read_json("example-model-config.json"))##End(Not run)create_project Create a projectDescriptionCreates the project using the passed project configuration list.Fails if a project with the passed name already exists.Usagecreate_project(zoltar_connection,project_config)Argumentszoltar_connectionA‘ZoltarConnection‘object as returned by new_connection project_config A‘list‘containing a Zoltar project configuration.note that this list validated by the server and not here.An example:cdc-project.json Full documentation athttps:///.Valueproject_url of the newly-created project4delete_modelExamples##Not run:new_project_url<-create_project(conn,jsonlite::read_json("cdc-project.json"))##End(Not run)delete_forecast Delete a forecastDescriptionDeletes the forecast with the passed URL.This is permanent and cannot be undone.Usagedelete_forecast(zoltar_connection,forecast_url)Argumentszoltar_connectionA‘ZoltarConnection‘object as returned by new_connection forecast_url URL of a forecast in zoltar_connection’s forecastsValueNoneExamples##Not run:delete_forecast(conn,"/api/forecast/1/")##End(Not run)delete_model Delete a modelDescriptionDeletes the model with the passed ID.This is permanent and cannot be undone.Usagedelete_model(zoltar_connection,model_url)delete_project5Argumentszoltar_connectionA‘ZoltarConnection‘object as returned by new_connection model_url URL of a model in zoltar_connection’s modelsValueNoneExamples##Not run:delete_model(conn,"/api/model/1/")##End(Not run)delete_project Delete a projectDescriptionDeletes the project with the passed URL.This is permanent and cannot be undone.Usagedelete_project(zoltar_connection,project_url)Argumentszoltar_connectionA‘ZoltarConnection‘object as returned by new_connection project_url URL of a project in zoltar_connection’s projectsValueNoneExamples##Not run:delete_project(conn,"https:///project/9/")##End(Not run)6forecasts download_forecast Gets a forecast’s dataDescriptionGets a forecast’s dataUsagedownload_forecast(zoltar_connection,forecast_url)Argumentszoltar_connectionA‘ZoltarConnection‘object as returned by new_connection forecast_url URL of a forecast in zoltar_connection’s forecastsValueForecast data as a‘list‘in the Zoltar standard format.meta information is ignored.Full documen-tation at https:///.Examples##Not run:forecast_data<-download_forecast(conn,"/api/forecast/1/")##End(Not run)forecasts Get a model’s forecastsDescriptionGet a model’s forecastsUsageforecasts(zoltar_connection,model_url)Argumentszoltar_connectionA‘ZoltarConnection‘object as returned by new_connection model_url URL of a model in zoltar_connection’s modelsforecast_data_from_cdc_csv_file7 ValueA‘data.frame‘of forecast information for the passed modelExamples##Not run:the_forecasts<-forecasts(conn,"/api/model/1/")##End(Not run)forecast_data_from_cdc_csv_fileLoads and converts a CDC CSVfile to Zoltar’s native‘list‘formatDescriptionLoads and converts a CDC CSVfile to Zoltar’s native‘list‘formatUsageforecast_data_from_cdc_csv_file(season_start_year,cdc_csv_file)Argumentsseason_start_yearAn integer specifying the"season"that cdc_csv_file is ed to convert EWsto YYYY_MM_DD_DATE_FORMAT.zoltr uses week30as the season break-point,e.g.the"2016/2017season"starts withcdc_csv_file A CDC CSVfileValuecdc_csv_file’s data as Zoltar’s native‘list‘format,but only the"predictions"item,and not"meta"Examples##Not run:forecast_data<-forecast_data_from_cdc_csv_file(2016,"my_forecast.cdc.csv")##End(Not run)8forecast_infoforecast_data_from_cdc_data_frame‘forecast_data_from_cdc_csv_file()‘helperDescription‘forecast_data_from_cdc_csv_file()‘helperUsageforecast_data_from_cdc_data_frame(season_start_year,cdc_data_frame)Argumentsseason_start_yearas passed to‘forecast_data_from_cdc_csv_file()‘cdc_data_frame""Valuesame as‘forecast_data_from_cdc_csv_file()‘forecast_info Gets a forecast’s informationDescriptionGets a forecast’s informationUsageforecast_info(zoltar_connection,forecast_url)Argumentszoltar_connectionA‘ZoltarConnection‘object as returned by new_connection forecast_url URL of a forecast in zoltar_connection’s forecastsValueA‘list‘of forecast information for the passed forecast_urlget_resource9Examples##Not run:the_forecast_info<-forecast_info(conn,"/api/forecast/1/")##End(Not run)get_resource Get JSON for a resource(URL).Authenticates if necessaryDescriptionGet JSON for a resource(URL).Authenticates if necessaryUsageget_resource(zoltar_connection,url)Argumentszoltar_connectionA‘ZoltarConnection‘object as returned by new_connection url A string of the resource’s URLValueA‘list‘that contiains JSON information for the passed URLmodels Get a project’s modelsDescriptionGet a project’s modelsUsagemodels(zoltar_connection,project_url)Argumentszoltar_connectionA‘ZoltarConnection‘object as returned by new_connection project_url URL of a project in zoltar_connection’s projects10model_info ValueA‘data.frame‘of model contents for all models in the passed projectExamples##Not run:the_models<-models(conn,"https:///project/9/")##End(Not run)model_info Get information about a modelDescriptionGet information about a modelUsagemodel_info(zoltar_connection,model_url)Argumentszoltar_connectionA‘ZoltarConnection‘object as returned by new_connection model_url URL of a model in zoltar_connection’s modelsValueA‘list‘of model information for the passed model_urlExamples##Not run:the_model_info<-model_info(conn,"/api/model/1/")##End(Not run)new_connection11 new_connection Get a connection to a Zoltar hostDescriptionReturns a new connection object,which is the starting point for working with the Zoltar API.Once you have the connection you can call zoltar_authenticate on it,and then call projects to get a list of Project objects to start working with.Usagenew_connection(host="https://")Argumentshost The Zoltar site to connect to.Does*not*include a trailing slash(’/’).Defaults to https://DetailsA note on URLs:We require a trailing slash(’/’)on all URLs.The only exception is the hostarg passed to this function.This convention matches Django REST framework one,which is what Zoltar is written in.ValueA‘ZoltarConnection‘objectExamples##Not run:conn<-new_connection()##End(Not run)projects Get information about all projectsDescriptionGet information about all projectsUsageprojects(zoltar_connection)12project_infoArgumentszoltar_connectionA‘ZoltarConnection‘object as returned by new_connectionValueA‘data.frame‘of all projects’contentsExamples##Not run:the_projects<-projects(conn)##End(Not run)project_info Get information about a projectDescriptionGet information about a projectUsageproject_info(zoltar_connection,project_url)Argumentszoltar_connectionA‘ZoltarConnection‘object as returned by new_connection project_url URL of a project in zoltar_connection’s projectsValueA‘list‘of project information for the passed project_urlExamples##Not run:the_project_info<-project_info(conn,"https:///project/9/")##End(Not run)scores13 scores Get a project’s scoresDescriptionGet a project’s scoresUsagescores(zoltar_connection,project_url)Argumentszoltar_connectionA‘ZoltarConnection‘object as returned by new_connection project_url URL of a project in zoltar_connection’s projectsValueA‘data.frame‘of score data for all models in the passed project URLExamples##Not run:the_scores<-scores(conn,"https:///project/9/")##End(Not run)targets Get a project’s targetsDescriptionGet a project’s targetsUsagetargets(zoltar_connection,project_url)Argumentszoltar_connectionA‘ZoltarConnection‘object as returned by new_connection project_url URL of a project in zoltar_connection’s projects14target_info ValueA‘data.frame‘of target contents for the passed projectExamples##Not run:the_targets<-targets(conn,"https:///project/9/")##End(Not run)target_info Get information about a targetDescriptionGet information about a targetUsagetarget_info(zoltar_connection,target_url)Argumentszoltar_connectionA‘ZoltarConnection‘object as returned by new_connection target_url URL of a target in zoltar_connection’s targetsValueA‘list‘of target information for the passed target_urlExamples##Not run:the_target_info<-target_info(conn,"https:///target/3/")##End(Not run)timezeros15 timezeros Get a project’s timezerosDescriptionGet a project’s timezerosUsagetimezeros(zoltar_connection,project_url)Argumentszoltar_connectionA‘ZoltarConnection‘object as returned by new_connection project_url URL of a project in zoltar_connection’s projectsValueA‘data.frame‘of timezero contents for the passed projectExamples##Not run:the_timezeros<-timezeros(conn,"https:///project/9/")##End(Not run)timezero_info Get information about a timezeroDescriptionGet information about a timezeroUsagetimezero_info(zoltar_connection,timezero_url)Argumentszoltar_connectionA‘ZoltarConnection‘object as returned by new_connection timezero_url URL of a timezero in zoltar_connection’s timezeros16truth ValueA‘list‘of timezero information for the passed timezero_urlExamples##Not run:the_timezero_info<-timezero_info(conn,"https:///timezero/3/") ##End(Not run)truth Get a project’s truthDescriptionGet a project’s truthUsagetruth(zoltar_connection,project_url)Argumentszoltar_connectionA‘ZoltarConnection‘object as returned by new_connection project_url URL of a project in zoltar_connection’s projectsValueA‘data.frame‘of truth data for the passed project URLExamples##Not run:the_truth<-truth(conn,"https:///project/9/")##End(Not run)unit_info17 unit_info Get information about a unitDescriptionGet information about a unitUsageunit_info(zoltar_connection,unit_url)Argumentszoltar_connectionA‘ZoltarConnection‘object as returned by new_connection unit_url URL of a unit in zoltar_connection’s zoltar_unitsValueA‘list‘of unit information for the passed unit_urlExamples##Not run:the_unit_info<-unit_info(conn,"https:///unit/3/")##End(Not run)upload_forecast Upload a forecastDescriptionThis function submits forecast data to the server for uploading.Returns an UploadFileJob object that can be used to up,which depends on the number of current uploads in the queue.Zoltar tracks these via‘UploadFileJob‘objects.)Usageupload_forecast(zoltar_connection,model_url,timezero_date,forecast_data,notes="")18upload_infoArgumentszoltar_connectionA‘ZoltarConnection‘object as returned by new_connection model_url URL of a model in zoltar_connection’s projectstimezero_date The date of the project timezero you are uploading for.it is a string in format YYYYMMDDforecast_data Forecast data as a‘list‘in the Zoltar standard formatnotes Optional user notes for the new forecastValueAn UploadFileJob URL for the uploadExamples##Not run:forecast_data<-jsonlite::read_json("docs-predictions.json")upload_file_job_url<-upload_forecast(conn,"/api/model/1/","2017-01-17",forecast_data,"a mid-January forecast") ##End(Not run)upload_info Get an upload’s informationDescriptionGets an upload’s information that can be used to track the upload’s progress.(Uploads are processed in a queue,Usageupload_info(zoltar_connection,upload_file_job_url)Argumentszoltar_connectionA‘ZoltarConnection‘object as returned by new_connection upload_file_job_urlURL of a job in zoltar_connection that was uploaded via upload_forecastValueA‘list‘of upload information for the passed upload_file_job_url.it has these names:id,url,status, user,created_at,updated_at,failure_message,filename,input_json,output_jsonupload_info_forecast_url19 Examples##Not run:the_upload_info<-upload_info(conn,"/api/uploadfilejob/2/")##End(Not run)upload_info_forecast_urlGet a new forecast upload’s urlDescriptionA helper function that returns the URL of a newly-uploaded forecast from upload_info.Usageupload_info_forecast_url(zoltar_connection,the_upload_info)Argumentszoltar_connectionA‘ZoltarConnection‘object as returned by new_connectionthe_upload_infoa‘list‘object as returned by upload_infoValueA URL of the new forecastExamples##Not run:new_forecast_url<-upload_info_forecast_url(conn,"/api/uploadfilejob/2/") ##End(Not run)20zoltar_units zoltar_authenticate Log in to a Zoltar hostDescriptionReturns a new‘ZoltarConnection‘object,which is the starting point for working with the Zoltar API.Once you have the connection you can call zoltar_authenticate()on it,and call projects()to get a list of objects to start working with.Usagezoltar_authenticate(zoltar_connection,username,password)Argumentszoltar_connectionA‘ZoltarConnection‘object as returned by new_connection.username Username for the account to use on the connection’s hostpassword Password""ValueNoneExamples##Not run:zoltar_authenticate(conn,"USERNAME","PASSWORD")##End(Not run)zoltar_units Get a project’s zoltar_unitsDescriptionGet a project’s zoltar_unitsUsagezoltar_units(zoltar_connection,project_url)Argumentszoltar_connectionA‘ZoltarConnection‘object as returned by new_connection project_url URL of a project in zoltar_connection’s projectszoltar_units21ValueA‘data.frame‘of unit contents for the passed projectExamples##Not run:the_units<-zoltar_units(conn,"https:///project/9/")##End(Not run)Indexcreate_model,2create_project,3delete_forecast,4delete_model,4delete_project,5download_forecast,6forecast_data_from_cdc_csv_file,7forecast_data_from_cdc_data_frame,8 forecast_info,8forecasts,6get_resource,9model_info,10models,9new_connection,3–6,8–10,11,12–20project_info,12projects,11,11scores,13target_info,14targets,13timezero_info,15timezeros,15truth,16unit_info,17upload_forecast,17,18upload_info,18,19upload_info_forecast_url,19zoltar_authenticate,11,20zoltar_units,2022。
美团API接口
}
]
三.
错误
成功的话 'status':200
{'respond': {'status': 500, 'code':0,'msg':'success'}
错误的话 'status':500,'code'为错误代码
{'respond': {'status': 500, 'code': 10008, 'msg': '参数错误'}}
orders
订单id
subCategory_id
subcategory
小分类id
product_title
prouct
商品标题
product_price
prouct
商品价格
product_num
prouct
商品数目
product_notify
prouct
商品通知
product_new_notify
prouct
roduct表???应用软件product字段定义父级描述productidprouct商品idproductuserguizeprouctproductusetimeprouctproductguoqibackprouctproductsuishibackprouctproducttimeprouctmerchartidmerchart商家idproductoldpriceprouct商品原来价格productyuyueprouct商品是否预约categoryidcategory大分类idorderidorders订单idsubcategoryidsubcategory小分类idproducttitleprouct商品标题productpriceprouct商品价格productnumprouct商品数目productnotifyprouct商品通知productnewnotifyprouct商品最新通知productimagesprouct商品图片productisgroupbuyprouct商品是否团购productvalidtimeprouct商品有效期时间productistodayprouct商品是否是今天的productfreedateprouct8
API接口设计说明书
XXAPI接口设计说明书公司2016年11月25日文档管理信息表文档变更记录表目录文档变更记录表 ................................................................................................................................................. 错误!未指定书签。
目录 ..................................................................................................................................................................... 错误!未指定书签。
引言 ..................................................................................................................................................................... 错误!未指定书签。
编写目的错误!未指定书签。
背景错误!未指定书签。
定义错误!未指定书签。
参考资料错误!未指定书签。
综述 ..................................................................................................................................................................... 错误!未指定书签。
统一的输入输出参数错误!未指定书签。
必须登录才能访问的接口错误!未指定书签。
API参考
主要函数说明public static void POS_S_SetBarcode(String strCodedata, int nOrgx, int nType, int nWidthX, int nHeight, int nHriFontType, int nHriFontPosition) (3)public static void POS_S_SetQRcode(String strCodedata, int nWidthX,int nErrorCorrectionLevel) (6)public static void POS_S_TextOut(String pszString, int nOrgx, int nWidthTimes, int nHeightTimes, int nFontType, int nFontStyle) (7)public static void POS_FeedLine() (9)public static void POS_Reset() (10)public static void POS_SetLineSpacing(int nDistance) (12)public static void POS_SetRightSpacing(int nDistance) (13)public static void POS_S_SetAreaWidth(int nWidth) (14)public static void POS_SetCharSetAndCodePage(int nCharSet, int nCodePage) (15)public static void POS_SetKey(byte[] key) (17)public static void POS_PrintPicture(Bitmap mBitmap, int nWidth, int nMode)描述:将位图缩放至指定宽度并打印位图参数:mBitmap需要打印的位图nWidth需要缩放到的宽度,便携打印机最大为384像素。
商品API接口文档说明
产品接收服务端API 假如是wms推送过来的数据,编码格式:UTF-8WebService 采用Soap 方式其说明如下WebService地址http://192.168.1.100/api/soap/server.php一:推送商品。
function add_goods($goods=array())参数$goods = array()数组形式,如下:规则$goods = array('username' => 'sinoauwiner','password' => 'sinoauwiner1225128955','goods_name' => 'sinoauwiner','goods_title' => 'sinoauwiner','goods_sn' => 'A112-20220020020004','price' => '88.9','market_price' => '92.6','box_price' => '488.0','reco_price' => '75.0','brand' => 'sinoauwiner');username 双方协定用户名称password双方协定用户密码goods_name 商品名称goods_title 商品标题goods_sn 商品编号price 单价格market_price 销售、市场价格box_price 一箱价格reco_price 促销价格brand 品牌返回结果参数password_error 双方协定密码错误。
企业付款API接口说明文档_V2 (1)(1)
书密码默认为您的商户
用来标识和界定您
ID(如:10010000)
的身份
证书 pem 格式
从
PHP 等不能直 您也可以使用 openssl
(apiclient_cert.pem) apiclient_cert.p12 接使用 p12 文 命令来自己导出:
中导出证书部分的 件,而需要使用 openssl pkcs12
业务结果 result_code 是
String( SUCCESS/FAIL
16)
错误代码 err_code
否
String( 错误码信息
32)
错误代码 err_code_de 否
String( 结果信息描述
描述
s
128)
以下字段在 return_code 和 result_code 都为 SUCCESS 的时候有返回
内部文档,请勿外传
内部文档,请勿外传
用户微信 weinxin_id 可
号
选
校验用户 check_name 是
姓名选项
收款用户 re_user_na 可
姓名
me
选
金额
amount
是
企业付款 desc
是
描述信息
Ip 地址 spbill_creat 是
e_ip
weiweiVIP OPTION_CHE CK
马总
10099 理赔 192.168.0.1
1.2 接口介绍
业务流程 付款
接口 企业付款
简介 用于企业向微信用户个人付款 目前支持向指定微信用户的 openid 或微信号付 款。(获取 openid 参见微信公众平台开发者文 档: 网页授权获取用户基本信息,微信号需用户 主动告知)
描述api 参数范围
API参数范围是指在使用API时,传递给API的参数所允许的有效值范围。
这些参数可以是整数、浮点数、字符串等类型,具体的范围取决于API的要求和定义。
例如,如果API要求传递一个表示年龄的整数参数,那么参数范围可能是0到150之间的整数,因为年龄在这个范围内是合理的。
如果API要求传递一个表示经度的浮点数参数,那么参数范围可能是-180.0到180.0之间的浮点数,因为经度在这个范围内是有效的。
在API的文档或说明中,通常会明确指出每个参数的类型和范围,以及超出范围时API 的行为。
有些API可能会拒绝超出范围的参数并返回错误,而有些API则可能会自动将参数值截断或舍入到允许的范围内。
API接口参考指南(简单版)
API接口参考指南(简单版)概述该文档提供了对API接口的详细参考指南,以帮助开发人员快速了解和使用API接口。
API接口介绍API接口是用于应用程序之间进行通信和交互的一种机制。
通过使用API接口,应用程序可以请求其他应用程序提供的功能和数据,以实现更多的功能。
使用API接口的好处- 提高开发效率:使用API接口可以直接调用其他应用程序的功能,避免重复编写相同的代码。
- 扩展应用功能:能够通过API接口获取其他应用程序的数据,从而扩展自身应用的功能。
- 实现应用集成:通过使用API接口,不同的应用程序可以相互协作,实现更多的集成功能。
API接口的基本使用方法1. 注册访问权限:在开始使用API接口之前,一般需要注册一个开发者账号,并申请访问权限。
2. 获取API接口文档:通过开发者账号获取API接口的详细文档,其中包含接口的请求参数、响应数据等信息。
3. 构建请求URL:根据API接口文档中的要求,构建请求URL,并添加所需的参数。
5. 处理响应:接收到API接口的响应后,根据文档中的响应格式进行解析和处理。
常见的API接口类型1. 通信类API接口:用于网络通信相关功能,如发送短信、邮件、即时通信等。
2. 数据类API接口:用于获取和处理数据相关功能,如获取天气信息、股票行情等。
3. 服务类API接口:用于提供特定服务相关功能,如在线支付、地图导航等。
API接口的注意事项- 遵循API接口文档中的使用规范和限制。
- 确保使用的API接口有稳定可靠的服务器支持。
- 对敏感数据的处理要符合相关的安全和隐私规定。
- 定期更新和升级使用的API接口,以获得最新的功能和性能优化。
结论通过本文档,您可以更加深入地了解API接口的使用方法和好处。
请确保遵循API接口文档中的规范和限制,以实现更高效和安全的应用开发。
API数据服务接口开发指南
T a r g e t-S外部接口说明书上海四键信息技术Fourth Button, Inc.日期: 2016-05-19变更记录目录1 引言........................................................概述.................................................名词缩写及定义.......................................历史变更.............................................2开发规范....................................................通信方式.............................................接口说明.............................................返回参数..........................................通用返回码说明....................................3数据服务接口................................................importCustomerAndVHLData(FTP Monitor-TSS).......createLeads(TSS-TSM)............................leads 需要外部文件导入的,是修改leads状态码?....callTheCustomer(TSS-CCA)..........................fishTheCall(CCA-TSS)............................ 4附录........................................................数据结构描述.........................................customerVHLData...................................customerInfo......................................VHLInfo...........................................serviceStatus.....................................leadsInfo.........................................HTTP返回值处理策略...................................1引言1.1概述略1.2名词缩写及定义1.3历史变更2开发规范2.1通信方式1)业务请求是HTTP协议请求,客户端以POST方式发送到服务平台。
- 1、下载文档前请自行甄别文档内容的完整性,平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益,请联系客服反馈,我们会尽快为您处理(人工客服工作时间:9:00-18:30)。
4PX 物流接口参数说明深圳递四方速递2012-06版本信息版本最后修改日期修改人修改内容备注0.1 2012-6-27 陈宏波建立文档0.2 2012-11-14 陈宏波修改文档0.3 2016-04-11 缪金荣修改文档增加黄色底字段和1.11/1.120.4 2016-07-13 缪金荣增加投保类型为6P时的投保信息内容:InsurApplicant、InsurCardNo、InsurCargoName、InsurQuantityPack 增加1.1、1.3、1.4黄色底字段0.5 2017-07-29 吴中卫 1.修改了wsdl调用的url2.创建并预报接口修改为createAndPreAlertOrderServiceNew3.增加补充说明增加返回的参数fpxOrderNo 黄色底字段目录1. 概述 (5)1.1. 写作目的 (5)1.2. 本文读者 (5)1.3. 调用方式 (5)1.3.1.WSDL (5)1.3.2.API订单验证流程 (5)2API 接口参数 (6)2.1. 创建订单 (6)2.1.1.请求参数 (6)2.1.2.返回参数 (13)2.2. 预报订单 (14)2.2.1. 请求参数 (14)2.2.2. 返回参数 (15)2.3. 创建并预报订单 (16)2.3.1. 请求参数 (17)2.3.2. 返回参数 (23)2.4. 修改订单 (25)2.4.1. 请求参数 (25)2.4.2. 返回参数 (30)2.5. 删除订单 (32)2.5.1. 请求参数 (32)2.5.2. 返回参数 (33)2.6. 查询订单 (34)2.6.1. 请求参数 (34)2.6.2. 返回参数 (36)2.7. 运费试算 (41)2.7.1. 请求参数 (42)2.7.2. 返回参数 (44)2.8. 查询轨迹 (47)2.8.1. 请求参数 (47)2.8.2. 返回参数 (47)2.9. 申请拦截 (49)2.9.1. 请求参数 (50)2.9.2. 返回参数 (50)2.10. 查询跟踪号 (51)2.10.1. 请求参数 (52)2.10.2. 返回参数 (52)2.11.查询标签信息 (54)2.11.1 请求参数 (54)2.11.2 返回参数 (54)2.12.打印标签(获取标签图片字节流) (57)2.12.1 请求参数 (57)2.12.2 返回参数 (58)3补充说明 (59)3.1基础数据参照表 (59)3.2常用接口错误代码说明 (59)3.2.1创建并预报异常代码说明 (59)1. 概述1.1. 写作目的本文档是 4PX 提供的物流接口参数说明,以供开发人员和测试人员参考。
1.2. 本文读者本文主要读者为开发员和测试员。
1.3. 调用方式1.3.1.WSDL在线订单操作---生产环境::8058/OrderOnline/ws/OrderOnlineService.dll?wsdl在线订单工具---生产环境::8059/OrderOnlineTool/ws/OrderOnlineToolService.dll ?wsdl1.3.2.API订单验证流程第一步:申请/ 网站上的账号,获得token第二步:在API上传订单第三步:在/ 上查看上传的订单信息注:无论是 WSDL或SDK调用方式,如要上线,必需向我司申请正式WSDL或 SDK。
2API 接口参数2.1. 创建订单类型: 在线订单操作接口名称:createOrderService2.1.1.请求参数<?Xml Version="1.0" Encoding="Utf-8"?><Createorderservice><Authtoken>String</Authtoken><Createorderservicerequestarray><Createorderservicerequest><Buyerid>String</Buyerid><Cargocode>String</Cargocode><City>String</City><Consigneecompanyname>String</Consigneecompanyname><Consigneeemail>String</Consigneeemail><Consigneefax>String</Consigneefax><Consigneename>String</Consigneename><Consigneepostcode>String</Consigneepostcode><Consigneetelephone>String</Consigneetelephone><Customerweight>String</Customerweight><Destinationcountrycode>String</Destinationcountrycode><Hasbattery>String</Hasbattery><Initialcountrycode>String</Initialcountrycode><Insurtype>String</Insurtype><Insurvalue>String</Insurvalue><InsurApplicant>String</InsurApplicant><InsurCardNo>String</InsurCardNo><InsurCargoName>String</InsurCargoName><InsurQuantityPack>String</InsurQuantityPack><Mctcode>String</Mctcode><Needpod>String</Needpod><Orderno>String</Orderno><Ordernote>String</Ordernote><Paymentcode>String</Paymentcode><Pieces>String</Pieces><Prealertintegrationtype>String</Prealertintegrationtype> <Productcode>String</Productcode><Returnsign>String</Returnsign><Shipperaddress>String</Shipperaddress><City>String</City><Shippercompanyname>String</Shippercompanyname> <Shipperfax>String</Shipperfax><Shippername>String</Shippername><Shipperpostcode>String</Shipperpostcode><Shipperstateorprovince>String</Shipperstateorprovince> <Shippertelephone>String</Shippertelephone><Stateorprovince>String</Stateorprovince><Street>String</Street><Trackingnumber>String</Trackingnumber><Transactionid>String</Transactionid><Declareinvoice><Declarenote>String</Declarenote><Declarepieces>String</Declarepieces><Declareunitcode>String</Declareunitcode><Hscode>String</Hscode><Itemurl>String</Itemurl><Name>String</Name><Unitprice>String</Unitprice><Cname>String</Cname><Ename>String</Ename></Declareinvoice></Createorderservicerequest></Createorderservicerequestarray></Createorderservice>MeaningArgument Type Required1 AuthToken String √调用 API 唯一标识,由 4PX提供length = 322 CreateOrderRequest2.1 OrderNo String √客户订单号码,由客户自己定义length <=202.2 TrackingNumber String 服务商跟踪号码,由4PX提供,客户如果有相应服务商跟踪号,也可以提供,但我司会校验是否有效,无效则重新分配Length < =302.3 ProductCode String √产品代码,指DHL、新加坡小包挂号、联邮通挂号等,参照产品代码表Length = 22.4 CargoCode String 货物类型(默认:P),参照货物类型表Length = 12.5 PaymentCode String 付款类型(默认:P),参照付款类型表Length = 12.6 InitialCountryCode String 起运国家二字代码,参照国家代码表Length = 22.7 DestinationCountryCode String √目的国家二字代码,参照国家代码表Length = 22.8 Pieces String 货物件数(默认:1)0 < Amount <= 9992.9 InsurType String 保险类型,参照保险类型表Length = 22.1 0 InsurValue String 保险价值(单位:USD)0 < Amount <= [10,2]2.1 1 BuyerId String 买家 IDLength <= 302.1 2 ReturnSign String 小包退件标识Y: 发件人要求退回N: 无须退回(默认)Length = 12.1 3 CustomerWeight String 客户自己称的重量(单位:KG)0 < Amount <= [10,2]2.1 4 TransactionId String 交易 IDLength <= 302.1 5 ShipperCompanyNameString 发件人公司名称Length <= 602.1 6 ShipperName String 发件人姓名Length <= 602.1 7 ShipperAddress String 发件人地址Length <= 1802.1 8 ShipperTelephone String 发件人电话号码Length <= 302.1 9 ShipperFax String 发件人传真号码Length <= 302.2 0 ShipperPostCode String 发件人邮编Length <= 102.2 1 ConsigneeCompanyNameString 收件人公司名称Length <= 602.2 2 ConsigneeName String √收件人姓名Length <= 602.2 3 Street String √街道Length <= 602.2 4 City String √城市Length <= 602.2 5 StateOrProvince String √州 / 省Length <= 602.2 6 ConsigneeTelephoneString 收件人电话号码Length <= 302.2 7 ConsigneeFax String 收件人传真号码Length <= 302.2 8 ConsigneePostCodeString 收件人邮编Length <= 102.2 9 ConsigneeEmail String 收件人 EmailLength <= 502.3 0 orderNote String 订单备注信息Length <= 2562.3 7 InsurApplicant String 投保类型为6P时,投保人(个人名义时真实姓名,公司名义时公司全称)2.3 8 InsurCardNo String 投保类型为6P时,个人名义投保时投保人身份证号2.3 9 InsurCargoName String 投保类型为6P时,货物名称描述2.4 0 InsurQuantityPack String 投保类型为6P时,货物包装与数量描述2.31DeclareInvoice2.3 1.1 EName String √海关申报英文品名Length <= 2002.3 1.2 CName String 海关申报中文品名Length <= 2002.3 1.3 DeclareUnitCode String 申报单位类型代码(默认:PCE),参照申报单位类型代码表Length <= 32.3 1.4 DeclarePieces String 件数(默认: 1)0 < Amount <= 9992.3 1.5 UnitPrice String 单价0 < Amount <= [10,2]2.3 1.6 DeclareNote String 配货备注Length <= 2562.31.7Name String 配货名称2.31.8Hscode String 海关申报货物编号2.31.9Itemurl String 产品的Url2.32Hasbattery String 是否带电标识(Y:是,N:否) 2.33Mctcode String 内容类型,邮政货物种类代码2.3 4 Needpod String 是否需要POD(Y:是,N:否) 交付凭证,它一共分四联(也有五联、六联的),也可以指收件人的签名。