http接口说明模板
HTTP接口文档
HTTP接口文档接口域名：一、工作方式....................................................................... 错误!未定义书签。
1.1 密码验证方式............................................................................... 错误!未定义书签。
二、字符编码....................................................................... 错误!未定义书签。
三、响应格式....................................................................... 错误!未定义书签。
四、短信发送（单条，多条发送）...................................... 错误!未定义书签。
五、接收状态报告................................................................ 错误!未定义书签。
5.1 主动获取状态............................................................................... 错误!未定义书签。
六、接收上行短信（回复）................................................. 错误!未定义书签。
6.1 主动接收上行短信（回复） ......................................................... 错误!未定义书签。
6.2 推送接收上行短信（回复） ......................................................... 错误!未定义书签。
Http协议说明
HTTP协议说明目录1.了解HTTP (4)1.1 HTTP简介 (4)1.2.HTTP1.0的会话方式 (4)1.4.HTTP请求消息 (5)1.5.HTTP响应消息 (5)1.6.HTTP消息 (5)1.7.HTTP消息头 (6)2.HTTP详细说明 (7)2.1．URL (7)2.2．HTTP协议之请求方法 (7)2.3．HTTP协议之响应状态 (8)2.4．HTTP协议之消息报头 (9)1.了解HTTP1.1 HTTP简介@ 用于定义web浏览器与web服务器之间交换数据的过程以及数据本身的格式。
@ HTTP协议的版本：http1.0、1.1。
HTTP是一个属于应用层的面向对象的协议，由于其简捷、快速的方式，适用于分布式超媒体信息系统。
它于1990年提出，经过几年的使用与发展，得到不断地完善和扩展。
目前在WWW中使用的是HTTP/1.0的第六版，HTTP/1.1的规范化工作正在进行之中，而且HTTP-NG(Next Generation of HTTP)的建议已经提出。
HTTP协议的主要特点可概括如下：1.支持客户/服务器模式。
2.简单快速：客户向服务器请求服务时，只需传送请求方法和路径。
请求方法常用的有GET、HEAD、POST。
每种方法规定了客户与服务器联系的类型不同。
由于HTTP协议简单，使得HTTP服务器的程序规模小，因而通信速度很快。
3.灵活：HTTP允许传输任意类型的数据对象。
正在传输的类型由Content-Type加以标记。
4.无连接：无连接的含义是限制每次连接只处理一个请求。
服务器处理完客户的请求，并收到客户的应答后，即断开连接。
采用这种方式可以节省传输时间。
5.无状态：HTTP协议是无状态协议。
无状态是指协议对于事务处理没有记忆能力。
缺少状态意味着如果后续处理需要前面的信息，则它必须重传，这样可能导致每次连接传送的数据量增大。
另一方面，在服务器不需要先前信息时它的应答就较快。
XXXX二次开发接口说明(HTTP)
XXX短信二次开发接口说明（HTTP接口）用户：XXX密码：XXXX更改密码ChangePassword输入参数输出参数：调用方式：http://XXXXX:8080/ChangePassword.asp?Account=***&Password=***&NewPassword=*** 查询余额GetBalance输入参数输出参数：调用方式：http://XXXX:8080/GetBalance.asp?Account=***&Password=***&Channel=*** Channel代码：1 - 106全网广告通道2 - 0713全网广告通道3 - 1069全网行业应用通道4 - 1065全网行业应用通道群发短信 SendSMS（返回状态报告ID）输入参数：输出参数：备注：这个功能执行成功返回的id号作为批号，记录后，使用GetReport功能可以获取到该发送批号和这批内的各手机号的状态报告。
调用方式：http://XXXX:8000/SendSms.asp?Account=***&Password=***&Phones=***&Content=***&Channel=***& SendTime=*Channel代码：1 - 106全网广告通道2 - 0713全网广告通道3 - 1069全网行业应用通道4 - 1065全网行业应用通道接收短信发送状态报告接口 GetReport输入参数输出参数：返回格式为：ID+'$$$$'+号码+''$$$$'+时间+'$$$$'+报告标志+'$$$$'+报告+'||||' ID+'$$$$'+号码+''$$$$'+时间+'$$$$'+报告标志+'$$$$'+报告+'||||'……调用方式：http://XXXX:8000/GetReport.asp?Account=***&Password=***接收短信 GetMessage输入参数输出参数：返回格式为：手机号$$$$上行内容$$$$发送时间||||手机号$$$$上行内容$$$$发送时间||||……调用方式：http://XXX:8000/GetMessage.asp?Account=***&Password=***。
简版HTTP协议接口文档.20150407
简版HTTP协议接口文档.20150407HTTP短信接口规范v1.22015年3月文档变更记录目录1概述 (5)1.1协议说明 (5)1.2适用范围 (5)1.3参考资料 (5)1.4缩略语 (6)2通信方式 (6)3协议报文定义 (9)3.1报文域属性说明 (6)3.2消息报文定义 (9)3.2.1下行短信提交MTSMSSUBMIT (9)3.2.2查询当前预付费用户余额QUERYAMTF (11) 3.2.3上行URL验证MOURLVERIFY (12)3.2.4上行短信推送MOSMSPUSH (13)3.2.5上行状态报告推送RPTPUSH (14)4附录-码表 (15)4.1认证返回码authstatus (15)4.2下行短信提交响应码mtrespcode (15)4.3查询余额响应码queryamtfrespcode (15)4.4上行接收响应码morespcode (16)4.5状态报告Stat (16)1概述1.1协议说明本短信API是使用HTTP并遵循REST原则设计的Web服务接口，可以使用几乎任何客户端和任何编程语言与REST API进行交互。
通过发送简单的HTTP POST请求就可以轻松接入使用。
1.1版本说明在作为CMPP变体的http协议chif1.0推出后，为了简化协议开发难度，对协议的下行和上行部分进行相应地修改，形成本简化协议，保留业务逻辑必要的核心字段，去掉扩展功能的若干字段（本接口不再具备发送数据短信能力）。
1.1与chif1.0的异同：1. 安全认证方式相同，仍然为报文头携带Authorization信息base64编码，URL携带MD5 token2. 下行MTSMSSubmit/上行MOSmsPush报文简化3. 状态报告推送方式保持不变4. MO/MT短信内容传递方式不使用Byte[],而是使用Base64编码的原始UTF-8字符串进行传递。
1.2适用范围1.3参考资料HTTP 1.01.4缩略语2通信方式通信支持HTTP / HTTPS。
短信HTTP接口说明文档
HTTP接口说明文档接口地址：http://203.171.227.208:9876/plan/Api/请先读这里:通过API提交参数时, 参数内容编码必须为GB2312, 且经过url编码例如:“您好”的url编码为“%C4%FA%BA%C3”API返回的内容是一些键值对的字符串集合，形式为:“k1=v1&k2=v2&k3=v3…”返回内容中的键值显示为url编码形式, 经过url解码后的键值是GB2312编码的字符串例如:返回内容“result=0&description=%B7%A2%CB%CD%B3%C9%B9%A6&faillist=”表示的实际内容为“result=0&description=发送成功&faillist=”1、发送短信功能描述：短信发送调用格式：http://203.171.227.208:9876/plan/Api/Send.aspx?username=用户名&password=密码&mobiles=手机号码&content=内容&f=1返回格式:result=&description=错误描述&faillist=失败号码列表注：faillist 列表中的号码间隔为英文”,”返回值:2、修改密码功能描述：修改密码调用格式：http://203.171.227.208:9876/plan/Api/ChgPwd.aspx?username=用户名&password=密码&newpwd=新密码返回格式:result=&description=错误描述参数说明：返回值:3、查询余额功能描述：查询余额调用格式：http://203.171.227.208:9876/plan/Api/Query.aspx?username=用户名&password=密码返回格式：result=返回值&balance=条数&description=错误描述注意: 当返回值为0时才同时返回条数参数说明：返回值:4.短信接收功能描述：收取回复的短信，账号需开通回复功能。
http接口文档模板
竭诚为您提供优质文档/双击可除http接口文档模板篇一：新http接口说明文档http接口文档接口域名：/api/一、密码验证方式................................................. . (1)二、字符编码................................................. .. (1)三、响应格式................................................. .. (2)四、短信发送（单条，多条发送）............................................... . (2)五、接收状态报告................................................. . (3)5.1主动获取状态................................................. ................................................... (3)六、接收上行短信（回复）............................................... (4)6.1主动接收上行短信（回复）............................................... . (4)七、取剩余短信条数................................................. (5)八、取已发送总条数................................................. (5)九、接口安全（绑定ip）............................................... (6)十、取发送记录................................................. . (6)一、密码验证方式接口密码使用“登录密码”与“用户名”拼接字符串后能过md5加密进行验证如登录密码是：123123如用户名是：test接口密码（pwd）=md5(登录密码+用户名)pwd=md5(123123test)pwd=b9887c5ebb23ebb294acab183ecf0769二、字符编码服务器接收数据可以是gbk或utF-8编码字符,默认接收数据是gbk编码,如提交的是utF-8编码字符,需要添加参数encode=utf8。
http接口说明模板
一、查询菜品列表接口(DONE)1、功能说明接受提供的菜品XXX画面XXX功能（比如人口查询画面-查询| 人口查询画面-详细等）2、接口调用说明2.1获取地址2.2http请求方式GET2.3数据返回格式JSON2.4传递参数2.5成功返回结果[“serverResponse”:”Success”,“totalRecords”:”52”,“page” : “10”,“pageSize” : “5”,“data”：{“id” : “123”,“itemName” : “皇堡”,“priceNow” : “10”,“pricePast” : “12”,“servicePicture” :”s9118668.jpg”,“serviceStars” : “3”},…….{“id” : “”,“itemName” : “”,“priceNow” : “”,“pricePast” : “”,“servicePicture” :” s9118668.jpg”,“serviceStars” : “3”}]2.6返回结果解释二、查询广告接口（DONE）1、功能说明接受广告图片，目前为一张2、接口调用说明2.1获取地址2.2http请求方式GET2.3数据返回格式JSON2.4传递参数2.5成功返回结果{"serverResponse":"Success",“advertisePicture” : “0f736a68b929b0955b319ebc41336.jpg”}2.6返回结果解释三、查询订单列表接口(DONE)1、功能说明根据指定的客户id查询订单2、接口调用说明2.1获取地址2.2http请求方式GET2.3数据返回格式JSON2.4传递参数参数说明这个接口可以作为多种用途：搜索正在进行中的订单：customerID和orderStatus 2.5成功返回结果{"serverResponse":"Success",“data”：[{“orderNo” : “02135”“orderTime” : “11:00”,“orderStatus” : “评价完毕”,“paidAmount” : “30”}……]}2.6返回结果解释。
HTTP协议格式详解
HTTP协议格式详解HTTP（Hypertext Transfer Protocol，超文本传输协议）是一种用于传输超媒体文档（例如HTML）的应用层协议。
在互联网中，HTTP是客户端和服务器之间进行通信的基础协议。
本文将详细介绍HTTP协议的格式。
1. HTTP请求格式HTTP请求由请求行、请求头和请求体三部份组成。
1.1 请求行请求行包含三个字段：请求方法、请求URL和HTTP协议版本。
请求方法指定请求的类型，常见的有GET、POST、PUT和DELETE等。
请求URL指定了请求的资源路径。
HTTP协议版本指定了使用的HTTP协议版本，如HTTP/1.1。
示例：GET /index.html HTTP/1.11.2 请求头请求头包含了关于请求的附加信息，每一个字段都以键值对的形式浮现，字段之间使用冒号分隔。
常见的请求头字段有：- Host：指定服务器的域名或者IP地址。
- User-Agent：指定客户端的用户代理，通常是浏览器的名称和版本。
- Accept：指定客户端可以接受的响应内容类型。
- Content-Type：指定请求体的内容类型。
示例：Host: exampleUser-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/58.0.3029.110 Safari/537.3Accept:text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,*/*;q=0.8Content-Type: application/x-www-form-urlencoded1.3 请求体请求体包含了请求的数据，通常在POST请求中使用。
请求体的格式取决于Content-Type字段的值。
示例：username=admin&password=1234562. HTTP响应格式HTTP响应由状态行、响应头和响应体三部份组成。
- 1、下载文档前请自行甄别文档内容的完整性，平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益，请联系客服反馈,我们会尽快为您处理(人工客服工作时间：9:00-18:30)。
一、查询菜品列表接口(DONE)
1、功能说明
接受提供的菜品
XXX画面XXX功能（比如人口查询画面-查询| 人口查询画面-详细等）2、接口调用说明
获取地址
请求方式
GET
数据返回格式
JSON
传递参数
成功返回结果
[
“serverResponse”:”Success”,
“totalRecords”:”52”,
“page” : “10”,
“pageSize” : “5”,
“data”：{
“id” : “123”,
“itemName” : “皇堡”,
“priceNow” : “10”,
“pricePast” : “12”,
“servicePicture” :””,
“serviceStars” : “3”
},
…….
{
“id” : “”,
“itemName” : “”,
“priceNow” : “”,
“pricePast” : “”,
“servicePicture” :” ”,
“serviceStars” : “3”
}
]
返回结果解释
二、查询广告接口（DONE）
1、功能说明
接受广告图片，目前为一张
2、接口调用说明
获取地址
请求方式
GET
数据返回格式
JSON
传递参数
成功返回结果
{
"serverResponse":"Success",
“advertisePicture” : “”
}
返回结果解释
三、查询订单列表接口(DONE)
1、功能说明
根据指定的客户id查询订单
2、接口调用说明
获取地址
请求方式
GET
数据返回格式
JSON
传递参数
参数说明
这个接口可以作为多种用途：
搜索正在进行中的订单：customerID和orderStatus 成功返回结果
{
"serverResponse":"Success",
“data”：[
{
“orderNo” : “02135”
“orderTime” : “11:00”,
“orderStatus” : “评价完毕”,
“paidAmount” : “30”
}
……
]
}
返回结果解释。