http接口说明模板
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协议是无状态协议。
无状态是指协议对于事务处理没有记忆能力。
缺少状态意味着如果后续处理需要前面的信息,则它必须重传,这样可能导致每次连接传送的数据量增大。
另一方面,在服务器不需要先前信息时它的应答就较快。
Http协议规范
Http协议规范协议名称:HTTP协议规范背景介绍:HTTP(Hypertext Transfer Protocol)是一种用于传输超文本的应用层协议。
它是Web应用中最重要的协议之一,用于客户端和服务器之间的通信。
HTTP协议规范定义了请求和响应的格式、状态码、头部字段以及其他相关细节,确保了互联网上的信息交换的顺利进行。
一、协议版本HTTP协议目前有多个版本,包括HTTP/1.0、HTTP/1.1和HTTP/2等。
本协议遵循HTTP/1.1版本。
二、请求格式1. 请求行:请求行由请求方法、请求URI和协议版本组成,格式如下:```请求方法请求URI 协议版本```示例:GET /index.html HTTP/1.12. 请求头部:请求头部包含了请求的附加信息,格式为键值对,每个键值对占一行,以冒号分隔,示例如下:```键: 值```常见的请求头部字段有:- Host:指定请求的主机名和端口号- User-Agent:发送请求的用户代理信息- Accept:指定客户端可接受的MIME类型- Content-Type:指定请求体的MIME类型- Cookie:包含了客户端的Cookie信息3. 请求体:请求体是可选的,用于传输请求的数据,例如表单数据或上传的文件等。
三、响应格式1. 状态行:状态行由协议版本、状态码和状态描述组成,格式如下:```协议版本状态码状态描述```示例:HTTP/1.1 200 OK2. 响应头部:响应头部包含了响应的附加信息,格式同请求头部。
3. 响应体:响应体是服务器返回的实际内容,可以是HTML、JSON、图片等。
四、常见状态码1xx:信息性状态码,表示服务器接收到请求并继续处理。
2xx:成功状态码,表示服务器成功处理了请求。
3xx:重定向状态码,表示需要进一步操作以完成请求。
4xx:客户端错误状态码,表示客户端发送的请求有错误。
5xx:服务器错误状态码,表示服务器在处理请求时发生了错误。
HTTP协议报文格式
HTTP协议报文格式HTTP(Hypertext Transfer Protocol)是一种用于传输超文本的协议,它定义了客户端和服务器之间进行通信的规则。
在HTTP通信中,客户端发送请求报文给服务器,服务器接收请求并发送响应报文给客户端。
1.请求报文格式:-起始行:包含请求方法、请求URL和HTTP版本。
-首部字段:描述请求的附加信息,以键值对的形式出现。
-空行:用于分隔首部字段和实体主体。
-实体主体:请求的数据,可以为空。
示例:```GET /index.html HTTP/1.1Accept: text/html```2.响应报文格式:-起始行:包含HTTP版本、状态码和状态消息。
-首部字段:描述响应的附加信息,以键值对的形式出现。
-空行:用于分隔首部字段和实体主体。
-实体主体:响应的数据,可以为空。
示例:```HTTP/1.1200OKContent-Type: text/htmlContent-Length: 1234<html><body>...</body></html>```3.请求方法:-GET:获取资源。
-POST:提交数据。
-PUT:创建或更新资源。
-DELETE:删除资源。
-HEAD:获取请求资源的元数据。
-OPTIONS:获取服务器支持的HTTP方法。
4.状态码:- 1xx:信息性状态码,表示请求已被接受并且服务器正在处理。
- 2xx:成功状态码,表示请求已成功处理。
- 3xx:重定向状态码,表示需要进一步操作才能完成请求。
- 4xx:客户端错误状态码,表示请求包含语法错误或无法完成请求。
- 5xx:服务器错误状态码,表示服务器在处理请求时发生内部错误。
5.首部字段:。
短信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。
常用接口介绍范文
常用接口介绍范文常用接口是指在软件开发中经常使用到的一些接口,它们提供了一种标准化的方式来实现系统之间的通信和交互。
下面介绍几种常用的接口。
1.HTTP接口HTTP接口是一种基于HTTP协议的接口,它经常用来实现客户端和服务端之间的通信。
HTTP接口可以使用GET和POST等HTTP方法进行数据的传输,通常使用JSON或者XML格式来进行数据的序列化和反序列化。
在互联网应用中,几乎所有的Web服务都是基于HTTP接口来实现的。
2. RESTful接口RESTful接口是一种基于REST原则的接口设计风格,它通过统一资源标识符(URI)来表示资源,使用HTTP方法(GET、POST、PUT、DELETE 等)对资源进行操作。
RESTful接口通常使用JSON作为数据的序列化格式,具有简洁、灵活、可扩展等特点,在现代Web应用开发中广泛应用。
3.SOAP接口SOAP(Simple Object Access Protocol)接口是一种基于XML的协议,用于在网络中进行分布式计算。
SOAP接口使用XML来描述数据和方法调用,通常使用HTTP或者SMTP等传输协议进行通信。
SOAP接口包括服务描述(WSDL)、消息描述(SOAP)和服务寻址(UDDI)等多个部分。
4. GraphQL接口GraphQL接口是一种新型的数据查询和操作语言,它提供了一种灵活、高效的方式来定义数据的查询和响应。
GraphQL接口允许客户端精确地指定需要的数据,减少了不必要的数据传输,提高了性能。
它还支持多个查询的批处理和并发执行,适用于复杂的数据查询场景。
5.gRPC接口gRPC是一种高性能、通用的开源RPC框架,它基于ProtocolBuffers(protobuf)进行数据的序列化和反序列化。
gRPC接口使用HTTP/2作为传输协议,支持双向流、流控和拦截器等特性。
gRPC提供多种编程语言的支持,可用于跨语言的微服务架构。
HTTP开发接口70字
企信通接口开发文档
(HTTP接口版)
一、重要说明:
1、使用特点及开发难度:
在应用程序中调用URL语句来完成短信的功能。
开发难度简单,需要进行程序开发。
2、公司服务器地址:
3、在下面所有访问页面前面加上这个路径:
(接口服务器地址)+各接口短信文件
使用域名,防止当此机房故障时,自动转换到正常的机房中。
二、接口短信文件:
1、发送短信
(1)群发普通短信(/send/g70send.aspx):
(2)群发长短信(/send/longsend.aspx):
注:此功能仅限于移动106通道,请联系工作人员咨询。
2、接收短信:
①、主动接收短信:(/send/readsms.aspx):
(主动读取用户上行回复的短信,每次只能读取一条短信。
如果有多条未读短信,请重复调用本接口读取。
读取间隔请大于5秒/次。
)
②、被动接收短信:
3、获得用户信息及余额(/send/getfee.aspx):
4、修改用户密码(/send/cpwd.aspx):
三、错误号:
1、短信HTTP接口返回错误代码:
2、HTTP访问错误代码:。
Http请求的各参数详解
Http请求的各参数详解HTTP Request的Header信息1、HTTP请求⽅式如下表:说明:主要使⽤到“GET”和“POST”。
实例:POST /test/tupian/cm HTTP/1.1分成三部分:(1)POST:HTTP请求⽅式(2)/test/tupian/cm:请求Web服务器的⽬录地址(或者指令)(3)HTTP/1.1: URI(Uniform Resource Identifier,统⼀资源标识符)及其版本备注:在Ajax中,对应method属性设置。
2、Host说明:请求的web服务器域名地址3、User-Agent说明:HTTP客户端运⾏的浏览器类型的详细信息。
通过该头部信息,web服务器可以判断到当前HTTP请求的客户端浏览器类别。
实例:User-Agent: Mozilla/5.0 (Windows; U; Windows NT 5.1; zh-CN; rv:1.8.1.11) Gecko/20071127 Firefox/2.0.0.114、Accept说明:指定客户端能够接收的内容类型,内容类型中的先后次序表⽰客户端接收的先后次序。
例如:Accept:text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png, */* 常⽤;q=0.5备注:在Prototyp(1.5)的Ajax代码封装中,将Accept默认设置为“text/javascript, text/html, application/xml, text/xml, */*”。
这是因为Ajax默认获取服务器返回的Json数据模式。
在Ajax代码中,可以使⽤XMLHttpRequest 对象中setRequestHeader函数⽅法来动态设置这些Header信息。
5、Accept-Language说明:指定HTTP客户端浏览器⽤来展⽰返回信息所优先选择的语⾔。
HTTP协议格式详解
HTTP协议格式详解HTTP(Hypertext Transfer Protocol)是一种用于传输超文本的应用层协议。
它是Web通信的基础,通过在客户端和服务器之间传递请求和响应来实现数据交换。
本文将详细介绍HTTP协议的格式,包括请求消息和响应消息的结构以及各个字段的含义。
一、请求消息格式HTTP请求消息由三个部分组成:请求行、请求头和请求体。
1. 请求行请求行包含了请求的方法、URI和HTTP版本。
格式如下:```<方法> <URI> HTTP/<版本>```常见的HTTP方法有GET、POST、PUT、DELETE等,URI表示请求的资源路径,版本表示HTTP协议的版本号。
2. 请求头请求头包含了请求的各种信息,以键值对的形式表示。
常见的请求头字段有:- Host:表示请求的主机名。
- User-Agent:表示客户端的用户代理。
- Accept:表示客户端能够接受的响应内容类型。
- Content-Type:表示请求体的内容类型。
- Cookie:表示客户端的Cookie信息。
- Authorization:表示客户端的身份验证信息。
请求头字段可以根据具体需求进行添加和修改,以满足请求的要求。
3. 请求体请求体是可选的,用于传递请求的数据。
常见的请求体格式有:- application/x-www-form-urlencoded:用于提交表单数据。
- multipart/form-data:用于上传文件。
- application/json:用于提交JSON格式的数据。
二、响应消息格式HTTP响应消息也由三个部分组成:状态行、响应头和响应体。
1. 状态行状态行包含了响应的HTTP版本、状态码和状态描述。
格式如下:```HTTP/<版本> <状态码> <状态描述>```常见的状态码有200表示成功,404表示资源未找到,500表示服务器内部错误等。
http协议接口
http协议接口HTTP协议接口。
HTTP(Hypertext Transfer Protocol)是一种用于传输超文本的应用层协议,它是全球互联网最重要的协议之一。
HTTP协议接口指的是通过HTTP协议进行通信的接口,它是各种网络应用程序的基础。
本文将介绍HTTP协议接口的基本原理、使用方法和相关注意事项。
一、基本原理。
HTTP协议接口是通过客户端和服务器之间的请求-响应模式进行通信的。
客户端发送HTTP请求到服务器,服务器接收到请求后进行处理并返回HTTP响应给客户端。
HTTP协议接口的基本原理可以简单概括为,客户端发起请求,服务器响应请求。
二、使用方法。
1. 发起HTTP请求。
客户端通过各种网络应用程序(如浏览器、移动应用等)发起HTTP请求。
HTTP请求由请求行、请求头部、空行和请求数据四部分组成。
请求行包括请求方法(如GET、POST等)、请求的URL和协议版本;请求头部包括各种请求参数和信息;空行用于分隔请求头部和请求数据;请求数据可以是表单数据、上传文件等。
2. 处理HTTP请求。
服务器接收到HTTP请求后,根据请求的URL和参数进行相应的处理。
处理过程可能包括读取数据库、调用其他服务接口、生成动态内容等。
服务器处理完成后,将生成的HTTP响应返回给客户端。
3. 返回HTTP响应。
HTTP响应由状态行、响应头部、空行和响应数据四部分组成。
状态行包括协议版本、状态码和状态消息;响应头部包括各种响应参数和信息;空行用于分隔响应头部和响应数据;响应数据可以是HTML页面、JSON数据等。
三、相关注意事项。
1. 安全性。
在使用HTTP协议接口时,需要注意数据的安全性。
特别是在传输用户敏感信息(如用户名、密码等)时,应当使用HTTPS协议进行加密传输,以防止信息被窃取。
2. 性能优化。
对于频繁访问的接口,可以通过缓存、负载均衡、CDN等手段进行性能优化,提高接口的响应速度和稳定性。
3. 异常处理。
(完整版)接口说明文档
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
接口文档样例模板
接口文档样例模板#接口文档##1.版本历史版本号,修订日期,修订人,修订说明------,-----------,------,------------1.0,2024-01-01,张三,初始版本发布1.1,2024-02-01,李四,添加新功能1.2,2024-03-01,王五,修复缺陷##2.概述本文档为XXX系统的接口文档,旨在明确系统与外部系统或前端界面之间的接口规范,以便于不同系统之间的数据交换和信息传输。
接口包括系统对外提供的接口以及系统对外使用的接口。
##3.接口规范###3.1接口地址接口的地址为URL形式,例如:``````###3.2接口请求方法接口的请求方法为HTTP标准方法,包括GET、POST、PUT、DELETE等。
###3.3请求头部每次请求应包含以下头部信息:```Content-Type: application/jsonAuthorization: Bearer {token}```其中,`Content-Type`指定请求主体的数据格式,本文档中的示例使用JSON格式;`Authorization`用于身份验证,使用Bearer Token方式。
###3.4响应结构接口的响应以JSON格式返回,并包含以下字段:- `code`:表示接口调用的结果状态码,0表示成功,其他值表示失败。
- `message`:接口调用结果的描述信息。
- `data`:接口返回的具体数据,根据接口类型可能会有不同的字段。
示例:```json"code": 0,"message": "操作成功","data":"name": "张三","age": 20}```###3.5错误处理接口调用失败时,响应的状态码非0,同时会在`message`字段中返回错误信息。
(完整版)接口文档样例模板.doc
项目名称
项目信息(接口模块名称)
功能描述:
【获取项目基本信息(整个项目信息模块的接口功能描述)】
返回说明:(统一的接口返回方式)
参数名称类型描述
Code String 状态码:
200 成功
404 错误Msg String 信息描述Data 返回的数据
1.获取项目基本信息(/v1/project/get)
【对标题接口必须有序号,方便后期的维护和修改跟进】【接口功能描述】
1.1 、请求协议(https)
1.2 、请求方式(
1.3 、输入参数:
字段中文名
项目 ID GET)
英文名类型是否必填业务补充描述Project_id bigint Y
1.4 、返回信息:
字段中文名英文名类型业务补充描述项目 ID Id
楼盘 Code f_house_code
项目名prj_name
标签prj_tags
开发商developers
销售状态project_sale
经纬度project_location
project_sale 返回信息
字段中文名英文名类型业务补充描述
销售状态sale_status 在售、待售、售
完
project_location
字段中文名英文名类型业务补充描述
经度longitude
纬度latitude
1.5 、业务返回规则要求(业务方面的返回要求,比如查询结果按照时间排序之类的)
1、查询结果按照创建时间排序显示。
HTTP接口说明
SOMP短信平台接口说明(v2.0)2007年5月12日目录1. 通讯方式 (1)2. 接口说明 (1)2.1 接口功能 (1)2.2.1. 发送下行信息(MT) (1)2.2.2. 接收状态报告 (2)2.2.3. 接收上行信息(MO) (2)2.2 参数说明 (3)2.2.1. user 用户名 (3)2.2.2. pw密码 (3)2.2.3. sm 消息内容 (3)2.2.4. dc 消息编码 (3)2.2.5. da 目标地址 (3)2.2.6. sa 源地址 (3)2.2.7. rd 状态报告标记 (3)2.2.8. ec 消息类别 (3)2.2.9. xid 外部编号 (3)2.2.10. type 消息类型 (3)2.2.11. date 日期 (4)2.2.12. id 编号 (4)2.2.13. result 发送结果 (4)2.2.14. stat 发送结果描述 (4)2.2.15. subcode 错误子码 (4)3. 常见问题 (4)4. 杂项 (4)1.通讯方式客户端和服务器端采用HTTP协议进行通讯,注意本接口只适用GET方法,所有参数均为英文小写字母。
2.接口说明2.1 接口功能接口服务器相关信息如下:2.2.1.发送下行信息(MT)接口地址::9898/sms/mt参数说明:发送举例::9898/sms/mt?user=test&pw=123456&sm=abc&da=138123456 78服务器处理后将给出一个xml形式的反馈。
发送应答举例:<?xml version="1.0" encoding="GB2312" ?><sms-m t><result>0</result><id>9151675150905638912</id></sms-m t>2.2.2.接收状态报告状态报告由我方服务器以GET方式主动推送到客户方服务器,客户必须先将接口地址提供给我方。
http协议通信接口范文
http协议通信接口范文英文回答:HTTP (Hypertext Transfer Protocol) is an application protocol that allows communication between clients and servers over the internet. It is the foundation of data communication in the World Wide Web. HTTP follows a client-server model, where the client sends a request to the server, and the server responds with the requested data.HTTP requests are made up of several components, including the request method, URL, headers, and optional body. The request method indicates the action to be performed on the server, such as GET (retrieve a resource), POST (submit data to be processed), PUT (update a resource), DELETE (remove a resource), etc. The URL specifies the location of the resource on the server. Headers provide additional information about the request, such as the content type, authentication credentials, and caching instructions. The optional body contains data to be sent tothe server, typically used in POST or PUT requests.Once the server receives the request, it processes it and generates a response. The response includes a status code, headers, and an optional body. The status code indicates the outcome of the request, such as 200 OK (successful), 404 Not Found (resource not found), 500 Internal Server Error (server encountered an error), etc. Headers in the response provide information about the server, content type, caching instructions, etc. The optional body contains the requested data or an error message.HTTP is stateless, meaning that each request-response pair is independent and does not carry any information about previous requests or sessions. To maintain stateful interactions, cookies or session tokens are commonly used. Cookies are small pieces of data stored on the client's side, while session tokens are unique identifiers generated by the server and stored on the client's side.In addition to the basic HTTP methods, there are alsoother features and extensions available, such as HTTP caching, compression, authentication, and encryption. These features enhance the performance, security, andfunctionality of HTTP communication.中文回答:HTTP(超文本传输协议)是一种应用协议,允许客户端和服务器在互联网上进行通信。
https请求方法[HTTP客户请求的数据格式说明(转载)]
https请求方法[HTTP客户请求的数据格式说明(转载)]https请求方法[HTTP客户请求的数据格式说明(转载)] HTTP请求包括三部分:请求行(Request Line),头部(Headers)和数据体(Body)。
其中,请求行由请求方法(method),请求网址Request-URI和协议(Protocol)构成,而请求头包括多个属性,数据体则可以被认为是附加在请求之后的文本或二进制文件。
下面这个例子显示了一个HTTP请求的Header内容,这些数据是真正以网络HTTP协议从IE浏览器传递到Apache服务器上的。
GET /icwork/? search=product HTTP/1.1Accept:image/gif,image/x-xbitmap,image/jpeg,image/pjpeg,application/vnd.ms-powerpoint,application/vnd.ms-excel,application/msword,*.* Accept-Language:en-usAccept-Encoding:gzip,deflateUser-Agent:Mozilla/4.0(compatible;MSIE 5.01;Windows NT 5.0;DigExt)Host::8080Referer:https:///header.htmlConnection:Keep-Alive这段程序使用了6个Header,还有一些Header没有出现。
我们参考这个例子具体解释HTTP请求格式。
1.HTTP请求行:请求行格式为Method Request-URI Protocol。
在上面这个例子里,“GET /icwork/? search=pruduct HTTP/1.1”是请求行。
2.Accept:指浏览器或其他客户可以接爱的MIME文件格式。
Servlet可以根据它判断并返回适当的文件格式。
基于HTTP的API服务接口说明书
基于HTTP的API服务接口说明书HTTP协议与ScadaCloud通信说明书(V1.0.0.0)基于HTTP的API服务接口说明书(V1.0.0.0)MinP TechnologyAddress:深圳市龙岗区吉祥路风临国际A1404Tel:0755-********Fax:0755-********目录1. SCADACLOUD APP服务介绍 (3)1.1简介 (3)1.2请求参数 (3)1.3举例 (4)2. 服务详解 (5)2.1注册 (5)2.2登陆 (5)2.3读取数据点当前值 (5)2.4读取数据点历史数据 (6)2.5设置数据点 (7)2.6读取未确认事件 (7)2.7确认指定的事件 (8)2.8确认所有的事件 (8)2.9取最大的告警级别 (9)注意事项 (10)附录A: (11)1. ScadaCloud APP 服务介绍1.1 简介ScadaCloud 为终端提供基于HTTP 的接口:登陆,读取数据点的实时数据,读取数据点的历史数据,设置数据点,读取未确认事件,确认事件,确认所有未确认的事件,取当前最大告警级别。
设备ScadaCloud服务器HTTP 终端设备ScadaCloud M2M 与APP 通信模型参与ScadaCloud APP 服务的实体有两个:ScadaCloud 服务器,它提供基于HTTP 的APP 服务,链接为/doc/0c12773952.html,/ScadaCloud/api/e xt.jsp ;终端设备,如智能手机。
在本文档中,时间用距离1970年元月1日0时0分0秒的毫秒数来表示;二进制值用”true ”和”false ”来表示;多状态变量用由"0"~"9"组成的非负整数表示,如"0","21",分别表示状态0和状态21;数字量的值用由"-","0"~"9","."表示的浮点数,或科学计数法表示的浮点数。
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协议⼀、接⼝API: Application Programming Interface,应⽤程序可编程接⼝1)接⼝分类硬件接⼝:具有连接功能、适配。
两个硬件设备之间的连接⽅式(⽐如⿏标和电脑通过USB接⼝连接)软件接⼝:软件程序之间数据交互的通道(⽤户界⾯是软件接⼝)2)软件接⼝分类程序内部接⼝:是客户端与服务器的接⼝,⽤来实现客户端和服务器的数据传递外部接⼝:⽐如通过第三⽅登录,第三⽅⽀付,通过调⽤外部接⼝并返回当前的系统3)常见的接⼝协议webService接⼝:使⽤soup协议通过http传输,请求报⽂和返回报⽂都是xml格式的,常⽤测试⼯具有soupUIhttp协议接⼝:⽬前使⽤最⼴泛的,使⽤HTTP协议来传输数据,常见的请求⽅法有get、post等,常⽤测试⼯具有postman、jmeter dubbo、 websocket、 ws://...、 ftp://等协议。
4)接⼝测试本质是基于某种协议,发送⼀个请求给服务器,然后服务器返回⼀个响应,然后对响应数据进⾏分析,判断是否与我们预期的返回⼀致,从⽽验证功能是否正确。
⼆、HTTP协议解读1)http协议:超⽂本传输协议2)https:简单的来说,就是http的安全版,在http下加⼊了SSL层(SSL主要⽤户web的安全传输协议)3)http的默认端⼝号是:80 ,默认的端⼝在url可以不加 https的默认端⼝号是:443 ,默认的端⼝在url可以不加4)HTTP请求过程客户端:PC端的应⽤程序浏览器 APP ⼩程序HTTP通信:客户端发送给服务器的请求信息 服务器返回给客户端的响应信息客户端:前端----->主动请求。
能够发起对应的请求的客户端。
服务端:后端----->被动接受。
1.当⽤户在浏览器的地址栏中输⼊⼀个URL并按回车键后,浏览器会向HTTP服务器发送HTTP请求。
HTTP请求主要分为“Get”和“Post”两种⽅法。
简版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。
- 1、下载文档前请自行甄别文档内容的完整性,平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益,请联系客服反馈,我们会尽快为您处理(人工客服工作时间:9:00-18:30)。
一、查询菜品列表接口(DONE)
1、功能说明
接受提供的菜品
XXX画面XXX功能(比如人口查询画面-查询 | 人口查询画面-详细等)
2、接口调用说明
2.1获取地址
http://192.168.0.6:8080/FamilyServiceSystem/BookDinnerQueryAction?ope ration=queryServiceItem
2.2http请求方式
GET
2.3数据返回格式
JSON
2.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获取地址
http://192.168.0.6:8080/FamilyServiceSystem/BookDinnerQueryAction?ope ration=queryAdvertisePicture
2.2http请求方式
GET
2.3数据返回格式
JSON
2.4传递参数
2.5成功返回结果
{
"serverResponse":"Success",
“advertisePicture” : “0f736a68b929b0955b319ebc41336.jpg”}
2.6返回结果解释
三、查询订单列表接口(DONE)
1、功能说明
根据指定的客户id查询订单
2、接口调用说明
2.1获取地址
http://192.168.0.6:8080/FamilyServiceSystem/BookDinnerQueryAction?ope ration=queryServiceOrderList
2.2http请求方式
GET
2.3数据返回格式
JSON
2.4传递参数
参数说明
这个接口可以作为多种用途:
搜索正在进行中的订单:customerID和orderStatus
2.5成功返回结果
{
"serverResponse":"Success",
“data”:[
{
“orderNo” : “02135”
“orderTime” : “11:00”,
“orderStatus” : “评价完毕”,
“paidAmount” : “30”
}
……
]
}
2.6返回结果解释。