HTTP接口文档

合集下载

HTTP接口文档

HTTP接口文档

HTTP接口文档接口域名:一、工作方式....................................................................... 错误!未定义书签。

1.1 密码验证方式............................................................................... 错误!未定义书签。

二、字符编码....................................................................... 错误!未定义书签。

三、响应格式....................................................................... 错误!未定义书签。

四、短信发送(单条,多条发送)...................................... 错误!未定义书签。

五、接收状态报告................................................................ 错误!未定义书签。

5.1 主动获取状态............................................................................... 错误!未定义书签。

六、接收上行短信(回复)................................................. 错误!未定义书签。

6.1 主动接收上行短信(回复) ......................................................... 错误!未定义书签。

6.2 推送接收上行短信(回复) ......................................................... 错误!未定义书签。

一、接口HTTP协议

一、接口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协议详解(文档)

HTTP协议详解(文档)

HTTP协议详解(⽂档)⽬录引⾔ (3)⼀、HTTP 协议详解之URL 篇 (3)⼆、HTTP 协议详解之请求篇 (3)三、HTTP 协议详解之响应篇 (4)四、HTTP 协议详解之消息报头篇 (5)1、普通报头 (5)2、请求报头 (6)3、响应报头 (7)4、实体报头 (7)五、利⽤telnet 观察http 协议的通讯过程 (8)1、打开telnet (8)2、连接服务器并发送请求 (9)3、实验结果: (9)4、注意事项 (10)六、HTTP 协议相关技术补充 (10)1、基础 (10)2、协议分析的优势—HTTP 分析器检测⽹络攻击 (11)3、HTTP 协议Content Lenth 限制漏洞导致拒绝服务攻击 (11)4、利⽤HTTP 协议的特性进⾏拒绝服务攻击的⼀些构思 (11)5、Http 指纹识别技术 (11)6、其他 (12)HTTP协议详解引⾔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.⽆连接:⽆连接的含义是限制每次连接只处理⼀个请求。

服务器处理完客户的请求,并收到客户的应答后,即断开连接。

采⽤这种⽅式可以节省传输时间。

简版HTTP协议接口文档.20150407

简版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接口说明文档接口地址: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接⼝调⽤⽰例教程介绍HttpClient库的使⽤前,先介绍jdk⾥HttpURLConnection,因为HttpClient是开源的第三⽅库,使⽤⽅便,不过jdk⾥的都是⽐较基本的,有时候没有HttpClient的时候也可以使⽤jdk⾥的HttpURLConnection,HttpURLConnection都是调jdk 库的,下⾯给出实例代码:import sun.misc.BASE64Encoder;import java.io.*;import .HttpURLConnection;import .URL;import .URLConnection;public class Main {public static void main(String[] args) throws Exception {String url = "https:///ocr_service?app_key=%s";String appKey = "xxxxxx"; // your app_keyString appSecret = "xxxxxx"; // your app_secreturl = String.format(url, appKey);OutputStreamWriter out = null;BufferedReader in = null;String result = "";try {String imgData = imageToBase64("example.jpg");String param="{\"app_secret\":\"%s\",\"image_data\":\"%s\"}";param=String.format(param,appSecret,imgData);URL realUrl = new URL(url);HttpURLConnection conn = (HttpURLConnection) realUrl.openConnection();conn.setRequestProperty("accept", "*/*");conn.setRequestProperty("connection", "Keep-Alive");conn.setRequestProperty("user-agent", "Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1;SV1)");conn.setDoOutput(true);conn.setDoInput(true);conn.setRequestMethod("POST"); // 设置请求⽅式conn.setRequestProperty("Content-Type", "application/json"); // 设置发送数据的conn.connect();out = new OutputStreamWriter(conn.getOutputStream(), "UTF-8");out.append(param);out.flush();out.close();in = new BufferedReader(new InputStreamReader(conn.getInputStream()));String line;while ((line = in.readLine()) != null) {result += line;}} catch (Exception e) {System.out.println("发送 POST 请求出现异常!" + e);e.printStackTrace();}finally {try {if (out != null) {out.close();}if (in != null) {in.close();}} catch (IOException ex) {ex.printStackTrace();}}System.out.println(result);}public static String imageToBase64(String path){String imgFile = path;InputStream in = null;byte[] data = null;try{in = new FileInputStream(imgFile);data = new byte[in.available()];in.read(data);in.close();}catch (IOException e){e.printStackTrace();}BASE64Encoder encoder = new BASE64Encoder();return encoder.encode(data);}}然后介绍⼀下HttpClient,只给出实例代码,不封装成⼯具类,因为理解基本⽤法后,⾃⼰封装⼯具类也是很容易的HttpClient的GET请求CloseableHttpClient httpClient = HttpClients.createDefault();//https:///search?utf8=%E2%9C%93&q=jeeplatform&type=URIBuilder uriBuilder = new URIBuilder("https:///search");uriBuilder.addParameter("q","jeeplatform");HttpGet httpGet = new HttpGet(uriBuilder.build());CloseableHttpResponse httpResponse = httpClient.execute(httpGet);int statusCode = httpResponse.getStatusLine().getStatusCode();if(statusCode==200){HttpEntity entity = httpResponse.getEntity();System.out.println(EntityUtils.toString(entity,"UTF-8"));}httpClient.close();httpResponse.close();HttpClient的POST请求,与GET请求类似CloseableHttpClient httpClient = HttpClients.createDefault();//https:///sie?query=%E8%8A%B1%E5%8D%83%E9%AA%A8&hdq=AQ7CZ&ekv=3&ie=utf8&String uri = "https:///sie";List<NameValuePair> params= new ArrayList<NameValuePair>();params.add(new BasicNameValuePair("query","花千⾻"));StringEntity entity = new UrlEncodedFormEntity(params,"UTF-8");HttpPost httpPost = new HttpPost(uri);httpPost.setEntity(entity);CloseableHttpResponse httpResponse = httpClient.execute(httpPost);int statusCode = httpResponse.getStatusLine().getStatusCode();if(statusCode == 200){System.out.println(EntityUtils.toString(httpResponse.getEntity()));}httpClient.close();httpResponse.close();上⾯例⼦是可以⽀持访问签名要求没那么⾼的接⼝,然后访问⾃签名https的站点,那就要建⽴⼀个⾃定义的SSLContext对象,该对象要有可以存储信任密钥的容器,还要有判断当前连接是否受信任的策略,以及在SSL连接⼯⼚中取消对所有主机名的验证,如果还是使⽤默认的HttpClient是会有下⾯的异常:PKIX path building failed: sun.security.provider.certpath.SunCertPathBuilderException: unable to find valid certification path to requested target给出解决⽅法:public static CloseableHttpClient getClient() {RegistryBuilder<ConnectionSocketFactory> registryBuilder = RegistryBuilder.create();ConnectionSocketFactory plainSF = new PlainConnectionSocketFactory();registryBuilder.register("http", plainSF);// 指定信任密钥存储对象和连接套接字⼯⼚try {KeyStore trustStore = KeyStore.getInstance(KeyStore.getDefaultType());// 信任任何链接TrustStrategy anyTrustStrategy = new TrustStrategy() {@Overridepublic boolean isTrusted(X509Certificate[] x509Certificates, String s) throws CertificateException {return true;}};SSLContext sslContext = SSLContexts.custom().useTLS().loadTrustMaterial(trustStore, anyTrustStrategy).build();LayeredConnectionSocketFactory sslSF = new SSLConnectionSocketFactory(sslContext, SSLConnectionSocketFactory.ALLOW_ALL_HOSTNAME_VERIFIER);registryBuilder.register("https", sslSF);} catch (KeyStoreException e) {throw new RuntimeException(e);} catch (KeyManagementException e) {throw new RuntimeException(e);} catch (NoSuchAlgorithmException e) {throw new RuntimeException(e);}Registry<ConnectionSocketFactory> registry = registryBuilder.build();// 设置连接管理器PoolingHttpClientConnectionManager connManager = new PoolingHttpClientConnectionManager(registry);RequestConfig requestConfig = RequestConfig.custom().setSocketTimeout(TIMEOUT_SECONDS * 1000).setConnectTimeout(TIMEOUT_SECONDS * 1000).build();return HttpClientBuilder.create().setConnectionManager(connManager).setMaxConnTotal(POOL_SIZE).setMaxConnPerRoute(POOL_SIZE).setDefaultRequestConfig(requestConfig).build(); }然后CloseableHttpClient httpClient = getClient()就可以然后HttpClient语法相对⽐较繁杂?如果觉得⽐较⿇烦,可以⽤Spring框架的RestTemplate,这⾥要创建⼀个⾃定义的bean,根据需要创建,代码⽰例://访问⾃签名https的要点HttpComponentsClientHttpRequestFactory requestFactory =new HttpComponentsClientHttpRequestFactory(HttpClientUtil.getClient());RestTemplate restTemplate = new RestTemplate(requestFactory);*/Bean result= restTemplate.getForObject(digitalgdOauthUrl, Bean.class);。

HTTP开发接口70字

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协议通信接口范文英文回答: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(超文本传输协议)是一种应用协议,允许客户端和服务器在互联网上进行通信。

基于HTTP的API服务接口说明书

基于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","."表示的浮点数,或科学计数法表示的浮点数。

接口文档样例模板

接口文档样例模板

接口文档样例模板#接口文档##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

(完整版)接口文档样例模板.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接口说明

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方式主动推送到客户方服务器,客户必须先将接口地址提供给我方。

HTTPAPI响应数据规范整理

HTTPAPI响应数据规范整理
<code></code> <datum>
<id></id> <name></name> <age></age>
<sex></sex> </datum> </result>
示例
<?xml version="1.0" encoding="utf-8"?> <result>
<code>1</code> <datum>
}
XML格式
参考
<?xml version="1.0" encoding="utf-8"?> <result>
<code></code> <message></message> </result>
Query(R)
单项数据查询
JSON
参考
{ "code": "value", "datum": { }
}
<id>3</id> <name>jennifer</name> <age>23</age> <sex>female</sex> </datum> </result>
列表数据查询
Json格 式
参考
{ "code": "value", //响应结果码,必需。 "data": [{ //数据列表,数组 },{ }]

拉卡拉HTTP对账接口文档

拉卡拉HTTP对账接口文档

拉卡拉(中国)电子支付技术服务有限公司账单平台商户对账接口拉卡拉(中国)电子支付技术服务有限公司版权所有未经许可严禁外泄1.1概述 (4)1.2 技术支持 (4)1.3 文档适用对象 (4)1.4 商户对帐 (4) (5)1.4.2 响应 (5)附录: (6)1.1概述拉卡拉(中国)电子支付技术信息服务有限公司是一家创新的电子支付领导企业,是国内首家提供Lakala NetPOS全支付系统解决方案的互联网企业,以创新的“帐单+刷卡”方式,让中国的电子商务真正“可”支付。

拉卡拉支付平台是一个综合性的互联网支付应用服务平台,与中国银联创设的“刷卡电话”银行卡支付转接系统独家对接,利用遍布全国的固网,为各类网络商务应用提供帐务传递和线下刷卡支付服务。

1.2 技术支持有关拉卡拉支付对账开发、设计、集成、调试、运行中的任何问题,请与拉卡拉公司技术部联系:地址:北京朝阳区北苑路170号凯旋城D座6-7层邮编:100101电话:-1.3 文档适用对象本文档主要适用于开发对账接口商户的技术及商户维护人员。

1.4 商户对帐【功能描述】商户定期发送HTTP请求到支付平台,并读取支付平台交易文件数据。

备注:如果accountDate 是空值文件取的就是系统前一天的文件。

1.4.2 请求参数1.4.3 响应说明平台每天都为商户生成前一天的明细交易文件,文件格式如下:商户编号_年月日.txt例如:3E0_.txt件内容:首行:商户编号|日期|笔数|用户输入金额|用户支付金额明细行:拉卡拉账单号(MIN+ 商户订单号)|流水号(拉卡拉交易流水号)|流水号(商户流水号)|用户输入金额|用户支付金额|用户的支付时间|支付人手机号每一笔交易都对应唯一的拉卡拉交易流水号,唯一第三方流水号。

附录:RSA :签名的顺序:accountDate= accountDate值& macType= macType值& merId= merId值& random= random值& ver= ver值MD5:签名的顺序:accountDate= accountDate值& macType= macType值& merId= merId值& random= random值& ver= ver值macKey的值。

文档管理系统Http接口

文档管理系统Http接口
&groupidFra bibliotek=101 返回:
成功:返回值= 1 错误:返回 X:错误信息
8. 显示组(在文档管中显示)
输入: / orgInterface?opr= showGroup&hash= HASH 密码& groupid=组名称 例如:
http://127.0.0.1/orgInterface?opr=showGroup&hash=1001_DE66464BD71B0A37C81AC175A9C48 &groupid =101 返回: 成功:返回值= 1 错误:返回 X:错误信息
97 = 禁止文件列表 96 = 禁止文件预览 95 = 禁止文件上传 94 = 禁止文件下载 93 = 禁止文件修改 92 = 禁止文件删除 91 = 禁止文件审核 90 = 禁止文件发布 89 = 禁止文件打印
例如: http://127.0.0.1/orgInterface?opr=addGroupUser&hash=1001_DE66464BD71B0A37C81AC175A9 C48& groupid=101&membered=00004&powers=21_22_31_32
注意:删除用户,其私人文档也将一起被删除
13. 增加组成员
输入:/orgInterface?opr= addGroupUser&hash= HASH 密码& groupid=组 Id & membered=用户 Id& powers=权限 说明:
powers 为设置的权限, 权限中间用 ”_”连接 //权限明细如下; 0 = 无权限 , 相当于只增加用户到一个组中, 不设置任何权限

蜂助手流量HTTP接口文档(V1.2.0)

蜂助手流量HTTP接口文档(V1.2.0)

fzsFlow系统http接口协议(V1.2.0) 本版本最后修订日期:2015年7月30日版本号日期说明作者1.0 2015-06-15 文档初始版本徐李洁1.0.1 2015-07-29 增加版本号字段,SP接入密码修改为徐李洁账户密码的MD5值1.0.6 2015-10-21 增加限制13~15 李锦华1.0.8 2015-11-16 查询接口,细节更新李锦华1.1.0 2015-11-24 响应码归类李锦华说明本文档供SP和本项目的后续开发维护人员使用,为了业务系统的安全,请严格不泄露本协议接口。

在这个接口协议中,蜂助手作为内容供应商,我们称之为CP,调用我们接口的商户作为一个业务点,我们称之为SP。

通过接口SP能够根据需要从CP实时获得需要的商品信息,可以提取对用户手机号进行实时充值。

本接口的业务逻辑基于蜂助手流量充值接口,SP使用该接口之前必须注册成渠道商,提供SP服务器IP地址,通知蜂助手工作人员开通Http接口功能,蜂助手为你分配相应功能模块和MD5 key值,你的登陆密码不能设置的太简单,请不要向任何人,包括蜂助手工作人员泄露你的流量系统登陆密码。

关于接口的另外几点说明:1.该接口使用HTTP协议,请求数据传输格式如下:【接口URL】?【参数名称1】=【参数值1】&【参数名称2】=【参数值2】……如:http://183.237.4.11:8097/fzsFlow/api/external/flowOrderApi/flowOrderApi?userId=1234&p assword=1234& version=1.0这里userId 由蜂助手分配获得。

2.所有接口的应答在HTTP包体中将以XML形式返回;3.所有的接口请求通过后台调用;4. 蜂助手服务器是放在移动机房。

5.其中文档提到的“+”是连接字符的意思。

6.接口调用出现超时或其它错误时,需联系我们客服,或者主动到蜂助手管理后台进行核实。

  1. 1、下载文档前请自行甄别文档内容的完整性,平台不提供额外的编辑、内容补充、找答案等附加服务。
  2. 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
  3. 3、如文档侵犯您的权益,请联系客服反馈,我们会尽快为您处理(人工客服工作时间:9:00-18:30)。

HTTP接口文档
接口域名:
一、工作方式....................................................................... 错误!未定义书签。

1.1 密码验证方式............................................................................... 错误!未定义书签。

二、字符编码....................................................................... 错误!未定义书签。

三、响应格式....................................................................... 错误!未定义书签。

四、短信发送(单条,多条发送)...................................... 错误!未定义书签。

五、接收状态报告................................................................ 错误!未定义书签。

5.1 主动获取状态............................................................................... 错误!未定义书签。

六、接收上行短信(回复)................................................. 错误!未定义书签。

6.1 主动接收上行短信(回复) ......................................................... 错误!未定义书签。

6.2 推送接收上行短信(回复) ......................................................... 错误!未定义书签。

七、取剩余短信条数............................................................ 错误!未定义书签。

八、取已发送总条数............................................................ 错误!未定义书签。

九、接口安全(绑定IP).................................................... 错误!未定义书签。

十、取发送记录 ................................................................... 错误!未定义书签。

一、工作方式
双方通过HTTP方式交互数据,第三方可以简单的“name=value”方式发送提交内容或响应请求内容。

即通过HTTP的GET/POST方式交换。

另外双方需要保证数据传输的完整性和安全性,每次发送请求都有响应(响应返回格式为纯文本),安全验证目前采用用户名、密码和IP绑定的方式。

1.1 密码验证方式
接口密码使用“登录密码”与“用户名”拼接字符串后能过md5加密进行验证
如登录密码是:123123
如用户名是:test
接口密码(pwd)=md5(登录密码+用户名)
pwd=md5(123123test)
pwd=b9887c5ebb23ebb294acab183ecf0769
二、字符编码
服务器接收数据可以是GBK或UTF-8编码字符,默认接收数据是GBK编码,如提交的是UT F-8编码字符,需要添加参数encode=utf8。

请求响应返回内容是GBK编码。

三、响应格式
所为响应即每次向服务器提交请求后返回值
响应值格式为纯文本
四、短信发送(单条,多条发送)
GET/POST操作格式:
/?uid=用户账号&pwd=MD532位密码&mobile=号码&mobileids=消息编号&cont ent=内容
接口参数说明:
接收号:,1390000test,
发送内容:发送测试
/?uid=test&pwd=b9887c5ebb23ebb294acab183ecf0769&mobile=,1390000test,&mo bileids=888,1390000test,666&content=%B7%A2%CB%CD%B2%E2%CA%D4
发成功时响应状态码值:
sms&stat=100&message=发送成功
stat 状态码
message 状态说明
返回发送的状态码
状态码说明
100 发送成功
101 验证失败
102 短信不足
103 操作失败
104 非法字符
105 内容过多
106 号码过多
107 频率过快
108 号码内容空
109 账号冻结
110 禁止频繁单条发送
112 号码错误
113 定时时间格式不对
114 账号被锁,10分钟后登录
116 禁止接口发送
117 绑定IP不正确
120 系统升级
五、接收状态报告
5.1 主动获取状态
GET/POST操作格式:
/?uid=用户账号&pwd=MD532位密码
例:
/?uid=test&pwd=b9887c5ebb23ebb294acab183ecf0769 响应返回值:
,100,556789,2011-03-11 11:22:11
,100,556311,2011-03-11 11:28:22
说明:
手机号,状态,发送唯一编号,状态返回时间+换行
每条状态记录以换行分隔,一行一条状态记录
六、接收上行短信(回复)
6.1 主动接收上行短信(回复)
操作的格式:
/?uid=用户账号&pwd=MD532位密码
注:提取的回复短信不能在重复提取
接口参数说明:
例:
/?uid=test&pwd=b9887c5ebb23ebb294acab183ecf0769
响应结果为纯文本,每次可接收多条回复信息:
状态码{&}回复号码||回复内容||回复时间||回复网关号{&}回复号码||回复内容||回复时间||回复网关号…….
例响应结果值:
100{&}||短信测试回复||2008-05-27 12:10:11||27282{&}||短信测试回复2||2009-05-2 7 13:11:11||1068
返回发送的状态码
无回复内容时返回空
注:对回复的内容中有||会自动转成全角||字符串
6.2 推送接收上行短信(回复)
使用说明:由服务器平台发送上行回复短信到您的接口程序上,使用Http协议GET和PO ST方式发送,您需要提交一个http接口地址来接收如下格式参数值
操作的格式:
接口参数说明:
七、取剩余短信条数
操作格式:
/?uid=用户账号&pwd=MD5位32密码
接口参数说明:
例:
/?uid=test&pwd=fa246d0262c3925617b0c72bb20eeb1d
响应结果为纯文本:
sms&stat=状态码&remain=剩余可发短信
例响应结果值:
sms&stat=100&remain=100
八、取已发送总条数
操作格式:
/?uid=用户账号&pwd=MD5位32密码&cmd=send
接口参数说明:
例:
/?uid=test&pwd=fa246d0262c3925617b0c72bb20eeb1d&cmd=send
响应结果为纯文本:
sms&stat=状态码&remain=已发短信
例响应结果值:
sms&stat=100&remain=100
九、接口安全(绑定IP)
为了接口更加的安全,请登录WEB平台在“系统设置”中绑定你服务器的IP地址,可绑定1 0个固定IP,绑定IP后只有通过你的服务器来发送短信,防止他人使用
十、取发送记录
操作的格式:
/?uid=用户账号&pwd=MD532位密码&page=1
接口参数说明:每次最多取50条记录,可以根据页数依次取完
例:
/?uid=test&pwd=b9887c5ebb23ebb294acab183ecf0769
响应结果为纯文本,每记录用“|#|”隔开,每个字段之间用“||”;
返回如下格式:
总记录数||当前记录数||总页数|#|发送时间||号码||内容||状态|#|发送时间||号码||内容| |状态|#|…….
无回复内容时返回空。

相关文档
最新文档