Browse Source

更新中文android ios文档

benson 6 years ago
parent
commit
e7371a3762
9 changed files with 203 additions and 56 deletions
  1. 1 2
      docs/zh/android/1.md
  2. 11 14
      docs/zh/android/3.md
  3. 34 7
      docs/zh/android/5.md
  4. 5 0
      docs/zh/android/6.md
  5. 5 3
      docs/zh/android/README.md
  6. 9 12
      docs/zh/ios/3.md
  7. 8 7
      docs/zh/ios/4.md
  8. 125 11
      docs/zh/ios/5.md
  9. 5 0
      docs/zh/ios/6.md

+ 1 - 2
docs/zh/android/1.md

@@ -1,3 +1,2 @@
-# 1.概述
-
+#### 1.概述
 AllPay 为基于移动端 APP 支付的客户提供接入插件(下文简称“SDK”),以帮助客户实 现快速、安全、集中式的接入支付渠道。

+ 11 - 14
docs/zh/android/3.md

@@ -10,7 +10,7 @@
 
 3.示例签名串
 
-```js
+```java
 acqID=99020344&backURL=https://www.baidu.com&charSet=UTF-8&frontURL=nil&goodsInfo=iPhone x&merID=800039253992510&merReserve=&orderAmount=1.00&orderCurrency=INR&orderNum=ap0180417163142&paymentSchema=EB&signType=MD5&transTime=20180417163142&transType=PURC&trxn_email_id=benson.zhang@allpayx.com&trxn_firstname=benson zhang&trxn_is_coupon_enabled=1&trxn_phone=15026528888&unique_id=abcde12345&version=VER000000002f3e0e436cd24430aa4aaaed597450f26 
 ```
 
@@ -31,7 +31,7 @@ acqID=99020344&backURL=https://www.baidu.com&charSet=UTF-8&frontURL=nil&goodsInf
 2.请求报文格式
 
 下面列举的字段为通用字段,每个渠道都需要上送,部分渠道有渠道专属字段,具体字段请到该渠道的专属渠到字段说明处查看
- 
+
   序号 |名称  |长度|类型|参数名称|备注 
  -----|-----|----|----|------|------
  1|版本号|12|文本|version |统一填写为“VER000000002” 
@@ -50,26 +50,24 @@ acqID=99020344&backURL=https://www.baidu.com&charSet=UTF-8&frontURL=nil&goodsInf
  14|交易时间    |14  |文本|transTime       |交易时间,格式:"yyyyMMddHHmmss" 
  15|签名类型     |3  |文本|signType        |MD5 
  16|签名      |32  |文本|signature         |采用 MD5 签名 
- 
+
 3. 响应报文格式
 
  序号 |名称  |长度|类型|参数名称|备注 
  -----|-----|----|----|------|------
-  1|应答码 |2|文本|code |应答码,00成功 
-  2|错误信息 |32|文本|msg |错误信息
-  3|交易流水号 |32|文本|tn |tn 作为调起 sdk 支付的参数,code等于"00"时返回该字段
-  
+  1|交易流水号 |32|文本|tn |tn 作为调起 sdk 支付的参数
+
 ## 3.4. 查询交易接口 
 
 
- 
+
 1. 接口说明
- 
+
  该接口为接入商家提供交易查询的功能。
 
 2. 请求报文格式 
 
-  
+
  序号 |名称  |长度|类型|参数名称|备注 
  -----|-----|----|----|------|------
  1|版本号|12|文本|version |统一填写为“VER000000002” 
@@ -87,7 +85,7 @@ acqID=99020344&backURL=https://www.baidu.com&charSet=UTF-8&frontURL=nil&goodsInf
 
 3. 响应报文格式
 
-  
+
   序号 |名称  |长度|类型|参数名称|备注 
  -----|-----|----|----|------|------
  1|版本号|12|文本|version |统一填写为“VER000000002” 
@@ -127,10 +125,10 @@ acqID=99020344&backURL=https://www.baidu.com&charSet=UTF-8&frontURL=nil&goodsInf
  11|交易时间    |14  |文本|transTime       |交易时间,格式:"yyyyMMddHHmmss" 
  12|签名类型     |3  |文本|signType        |MD5 
  13|签名      |32  |文本|signature         |采用 MD5 签名 
- 
+
 3.响应报文格式
 
-  
+
   序号 |名称  |长度|类型|参数名称|备注 
  -----|-----|----|----|------|------
  1|版本号|12|文本|version |统一填写为“VER000000002” 
@@ -146,4 +144,3 @@ acqID=99020344&backURL=https://www.baidu.com&charSet=UTF-8&frontURL=nil&goodsInf
  11|GW 处理时间 |14  |文本|GWTime |YYYYMMDDHHMMSS,为 GW 时间,目前为本地交易时间 
  12|签名类型     |3  |文本|signType        |MD5 
  13|签名      |32  |文本|signature         |采用 MD5 签名 
- 

+ 34 - 7
docs/zh/android/5.md

@@ -2,13 +2,40 @@
 
 ## 5.1 EB渠道
 
-* 消费接口专属字段
-	* 请求报文
-	
-	 序号 |名称  |长度|类型|参数名称|备注 
+ 消费接口专属字段
+
+* 请求报文
+
+序号 |名称  |长度|类型|参数名称|备注 
  -----|-----|----|----|------|------
-  1| 姓名     |32  |文本|trxn_firstname         |This is name of the customer who is doing the transaction. 
-  2| 邮箱     |40  |文本|trxn_email_id         |this is email id of the customer who is doing transaction.
+  |1| 姓名     |32  |文本|trxn_firstname|This is name of the customer who is doing the transaction. 
+  2| 邮箱     |40  |文本|trxn_email_id|this is email id of the customer who is doing transaction.
   3|电话 |20  |文本|trxn_phone|Phone number of the customer.
   4|优惠券选项 |1  |文本|trxn_is_coupon_enabled| If the value is 0 then customer will not be able to see the coupons. If the value is 1 then customer will be able see the coupons and able to select the coupons
-  5|客户id |10  |文本|unique_id|This is customer’s unique id.不能超过10位
+  5|客户id |10  |文本|unique_id|This is customer’s unique id.不能超过10位
+
+## 5.2 WX渠道
+* 渠道配置
+  
+  在主项目的AndroidManifest.xml文件中添加添加如下配置
+  
+```xml
+  
+  <!-- wpay sdk begin -->
+
+
+<activity
+    android:name="com.allpayx.sdk.wxapi.WXPayEntryActivity"
+    android:exported="true"
+    android:launchMode="singleTop" />
+
+
+<activity-alias
+    android:name=".wxapi.WXPayEntryActivity"
+    android:exported="true"
+    android:launchMode="singleTop"
+    android:targetActivity="com.allpayx.sdk.wxapi.WXPayEntryActivity" />
+
+<!-- wpay sdk end -->
+
+```

+ 5 - 0
docs/zh/android/6.md

@@ -0,0 +1,5 @@
+# 6.安卓SDK下载
+
+
+
+[Android Demo及SDK下载地址](https://git.allpayx.com/OpenAPI/b2c_android_sdk)

+ 5 - 3
docs/zh/android/README.md

@@ -1,6 +1,8 @@
-# Android端控件支付产品接口规范文档4.0.0
+# Android端控件支付产品接口规范文档4.0.2
 
 [上海偶可贝网络科技有限公司](https://www.allpayx.com)
 
-* 版本信息:中文 V4.0.0
-* 更新时间:2018 年5月
+* 版本信息:中文 V4.0.2
+* 更新时间:2018 年7 月
+
+# 

+ 9 - 12
docs/zh/ios/3.md

@@ -50,24 +50,22 @@ acqID=99020344&backURL=https://www.baidu.com&charSet=UTF-8&frontURL=nil&goodsInf
  14|交易时间    |14  |文本|transTime       |交易时间,格式:"yyyyMMddHHmmss" 
  15|签名类型     |3  |文本|signType        |MD5 
  16|签名      |32  |文本|signature         |采用 MD5 签名 
- 
+
 3. 响应报文格式
 
  序号 |名称  |长度|类型|参数名称|备注 
  -----|-----|----|----|------|------
-  1|应答码 |2|文本|code |应答码,00成功 
-  2|错误信息 |32|文本|msg |错误信息
-  3|交易流水号 |32|文本|tn |tn 作为调起 sdk 支付的参数,code等于"00"时返回该字段
-  
+  1|交易流水号 |32|文本|tn |tn 作为调起 sdk 支付的参数,code等于"00"时返回该字段
+
 ## 3.4. 查询交易接口
- 
+
 1. 接口说明
- 
+
  该接口为接入商家提供交易查询的功能。
 
 2. 请求报文格式 
 
-  
+
  序号 |名称  |长度|类型|参数名称|备注 
  -----|-----|----|----|------|------
  1|版本号|12|文本|version |统一填写为“VER000000002” 
@@ -85,7 +83,7 @@ acqID=99020344&backURL=https://www.baidu.com&charSet=UTF-8&frontURL=nil&goodsInf
 
 3. 响应报文格式
 
-  
+
   序号 |名称  |长度|类型|参数名称|备注 
  -----|-----|----|----|------|------
  1|版本号|12|文本|version |统一填写为“VER000000002” 
@@ -125,10 +123,10 @@ acqID=99020344&backURL=https://www.baidu.com&charSet=UTF-8&frontURL=nil&goodsInf
  11|交易时间    |14  |文本|transTime       |交易时间,格式:"yyyyMMddHHmmss" 
  12|签名类型     |3  |文本|signType        |MD5 
  13|签名      |32  |文本|signature         |采用 MD5 签名 
- 
+
 3.响应报文格式
 
-  
+
   序号 |名称  |长度|类型|参数名称|备注 
  -----|-----|----|----|------|------
  1|版本号|12|文本|version |统一填写为“VER000000002” 
@@ -144,4 +142,3 @@ acqID=99020344&backURL=https://www.baidu.com&charSet=UTF-8&frontURL=nil&goodsInf
  11|GW 处理时间 |14  |文本|GWTime |YYYYMMDDHHMMSS,为 GW 时间,目前为本地交易时间 
  12|签名类型     |3  |文本|signType        |MD5 
  13|签名      |32  |文本|signature         |采用 MD5 签名 
- 

+ 8 - 7
docs/zh/ios/4.md

@@ -11,9 +11,8 @@
 
 }];
 
-```
 
-::: tip 参数说明
+参数说明
 tn: 是从服务器端获取的流水号; mode:测试环境:NO; 生产环境:YES。
 
 Scheme: 可以为任意值推荐填写成"com.xxx.xxx" 等形式, 有特殊配置的渠道会在渠道专属配置里面说明
@@ -21,7 +20,10 @@ Scheme: 可以为任意值推荐填写成"com.xxx.xxx" 等形式, 有特殊配
 ViewController: 调用 SDK 时的 ViewController;
 
 onResult: 接收同步结果通知
-:::
+```
+
+
+
 
 ## 4.2. 添加 SDK 包
 
@@ -58,27 +60,26 @@ onResult: 接收同步结果通知
   //此处处理同步支付结果
 
  }];
+ 
 ```
 
 resultDic,转为 json 字符串,格式如下:
 
-```text
 {
   "state": "cancel",
   "paymentSchema": "YL",
   "orderNum": "604337497032",
   "errorDetail": "user cancel operation"
 }
-```
 
-::: tip 报文说明
+报文说明
 
 - state: "success"代表成功, "cancel"代表用户取消操作, "fail"代表失败
 - paymentSchema: 支付渠道, 印度本地支付:"EB", "APMP"代表支付宝,  "WX"代表微信,"APP"代表ApplePay
 - orderNum: 订单号
 - errorDetail: 错误详情
 
-:::
+
 | 参数        | 说明           |
 | ------------- |:-------------:|
 | state      | "success"代表成功, "cancel"代表用户取消操作, "fail"代表失败 |

+ 125 - 11
docs/zh/ios/5.md

@@ -1,29 +1,143 @@
 # 5.渠道专属配置
 ## 5.1 EB渠道
 * 渠道专属配置:
-  1.将allpaysdk/EBModule文件夹下的文件add到项目中
+
+  ```xml
+  
+  1.将allpaysdk/WXModule文件夹下的文件add到项目中
   
   2.Set Always embed swift standard libraries to YES from project build settings 
-  ```
+  
   ALWAYS_EMBED_SWIFT_STANDARD_LIBRARIES
-  ```
-
+  
   3.To simply disable ATS, you can follow this steps by open Info.plist, and add 	the following lines:
- 
- ```
     <key>NSAppTransportSecurity</key>
     <dict> <key>NSAllowsArbitraryLoads</key>
         <true/>
     </dict>
-```
+  ```
+
+
 * 消费接口专属字段
-	* 请求报文
-	
-	 序号 |名称  |长度|类型|参数名称|备注 
+
+请求报文
+
+​	
+
+ 序号 |名称  |长度|类型|参数名称|备注 
  -----|-----|----|----|------|------
   1| 姓名     |32  |文本|trxn_firstname         |This is name of the customer who is doing the transaction. 
   2| 邮箱     |40  |文本|trxn_email_id         |this is email id of the customer who is doing transaction.
   3|电话 |20  |文本|trxn_phone|Phone number of the customer.
   4|优惠券选项 |1  |文本|trxn_is_coupon_enabled| If the value is 0 then customer will not be able to see the coupons. If the value is 1 then customer will be able see the coupons and able to select the coupons
   5|客户id |10  |文本|unique_id|This is customer’s unique id.不能超过10位
- 
+
+## 5.2 WX渠道
+* 渠道专属配置:
+1. 将allpaysdk/EBModule文件夹下的文件add到项目中
+2. 项目设置APPID
+商户在微信开放平台申请开发APP应用后,微信开放平台会生成APP的唯一标识APPID。在Xcode中打开项目,设置项目属性中的URL Schemes为您的APPID 如图标红位置所示
+
+![image](/ios_wx_01.jpg)
+3. 导入下面框架和链接库
+
+   ```objective-c
+   Security.framework
+   CoreTelephony.framework
+   SystemConfiguration.framework
+   libc++.tbd
+   libz.tbd
+   libsqlite3.tbd
+   ```
+
+4. 在“Info.plist”中将要使用的 URL Schemes 列为白名单 
+
+   ```xml
+   <key>LSApplicationQueriesSchemes</key>
+   <array>
+   <string>weixin</string>
+   </array>
+   <key>NSAppTransportSecurity</key>
+   <dict>
+   <key>NSAllowsArbitraryLoads</key>
+   <true/>
+   </dict>
+   
+   ```
+## 5.3 APMP渠道
+* 渠道专属配置:
+1. 将allpaysdk/AliModule文件夹下的文件add到项目中
+
+2. 在Build Phases选项卡的Link Binary With Libraries中,增加以下依赖:
+
+   ```objective-c
+   libc++.tbd
+   libz.tbd
+   SystemConfiguration.framework
+   CoreTelephony.framework
+   QuartzCore.framework
+   CoreText.framework
+   CoreGraphics.framework
+   CFNetwork.framework
+   CoreMotion. .framework    
+      
+   ```
+
+3. 点击项目名称,点击“Info”选项卡,在“URL Types”选项中,点击“+”,在“URL Schemes”中输入alipay, , 如图标红位置所示
+
+![image](/ios_wx_01.jpg)
+
+## 5.3 UP渠道
+* 渠道专属配置:
+
+1. 将allpaysdk/UPModule文件夹下的文件add到项目中
+
+2. 导入下面框架和链接库
+
+   ```objective-c
+   CFNetwork.framework
+   SystemConfiguration.framework
+   libz.tbd    
+   ```
+
+   
+
+3. 在工程info.plist设置中添加一个URL Types回调协议,用于在支付完成后返回商户客户端。请注意URL Schemes需要是唯一的,。 设置的Scheme的值要和支付接口中参数scheme的值相同。
+
+4. 需要在工程对应的plist文件中,添加LSApplicationQueriesSchemes  Array并加入uppaysdk、uppaywallet、uppayx1、uppayx2、uppayx3五个item 
+
+   ```xml
+   <key>LSApplicationQueriesSchemes</key> 
+   <array>
+   <string>uppaysdk</string> 
+       <string>uppaywallet</string>
+       <string>uppayx1</string> 
+       <string>uppayx2</string> 
+       <string>uppayx3</string> 
+   </array>
+   ```
+
+5. http请求设置(ats) 
+
+   在测试环境测试时,需要在工程对应的plist文件中添加NSAppTransportSecurity  Dictionary 并同时设置里面NSAllowsArbitraryLoads 属性值为 YES,发生产环境可删除此设置。向Apple发布正式版本时请删除此设置。
+
+## 5.4 Apple Pay渠道
+* 渠道专属配置:
+1. 将allpaysdk/AppleModule文件夹下的文件add到项目中
+2. xcode 打开 apple pay 功能,如下图
+   
+![image](/apple_pay_set.png)
+
+3. 用户 app 判断手机是否支持 Apple Pay 功能,以及是否已加载有可用的支付卡片 
+
+   ```objective-c
+   //判读方法为:
+   if([PKPaymentAuthorizationViewController canMakePaymentsUsingNetworks:@[PKPaymentNetworkChinaUnionPay]] )
+   {
+   // app 展示 apple pay 支付图标 
+   }
+   
+   
+   ```
+
+   

+ 5 - 0
docs/zh/ios/6.md

@@ -0,0 +1,5 @@
+# 6.iOS SDK下载
+
+
+
+[iOS Demo及SDK下载地址](https://git.allpayx.com/OpenAPI/b2c_ios_sdk)