神州专车开放平台

## 概述
本文档是针对用户调用神州专车H5服务，嵌入自有系统的说明文档，旨在帮助用户熟悉了解开放平台H5应用的功能、接入流程、企业用车及订单量获取。在手机浏览器中打开如下H5链接可查看H5页面效果。

```
https://commonwappre.10101111.com/join?
key=OWtUaDQ3VmFiTjdlXzEwb1NGZE92SmFRa1NkSXVzdUFGTHM5eVVwUHdXeW1PMm51bXBlVkxvcUNzOXRwYjBjX3dMaVduME55OTIyeXdKek5QOHRUVmRTckhCNkx5VEo3ejQ5V3BaTnBTSW89
```

备注：上述H5链接仅作为DEMO查看使用，不能作为真实的应用链接使用。

## 接入流程
<div class="text-center" style="display:none"><img src="#" id="html5-main" data-load-path="/img/h5-guide/01.png"><div class="text-center input-tips"></div></div>

#### （1）	在<a href="http://developer.10101111.com" target="_blank">开放平台</a>网站注册开发者账号

#### （2）在【应用管理】里创建应用
开始可以先创建测试应用，进行测试使用；如果要正式上线，需要创建正式应用。

#### （3）接入模式选择 H5

#### （4）选择用车模块
神州专车有6种用车模块，用户可依据情况选择至少一种用车模块

#### （5）H5链接地址
创建成功以后，在【应用管理】里点击“应用名称”，查看生成的H5应用地址

<div class="text-center" style="display:none"><img src="#" id="html5-main" data-load-path="/img/h5-guide/07.png"><div class="text-center input-tips"></div></div>
PS：参数中key值为客户端id和客户端秘钥加密生成，第三方无法解密，请不要随意修改，否则无法接入。

#### （6）在手机上打开该H5链接地址可以预览H5页面效果。

#### （7）关于微信支付
目前神州专车H5应用支持支付宝和微信支付，默认开通支付宝支付，如果在第三方APP里嵌入神州专车H5应用，实现微信支付需要完成以下操作：

（a）在app应用中增加weixin://协议，微信支付是微信app对webview发出的请求做了一次拦截, 它用了一个私有协议头"weixin://" ,weixin://协议与电话（tel://）和短信（sms://）的协议类似。

（b）提供APP应用（安卓和IOS版本的都需要）的ua（useragent）和schema（urlscheme）参数给神州专车对接人员。这些参数可以确保完成微信支付以后，再跳转到第三方app的神州h5页面里。

## 参数设置及免登录

#### （1）参数设置
系统自动生成的H5链接地址为默认的H5样式，传入一些参数可对H5的颜色样式、定位、登录等信息进行修改。在H5的url链接中增加参数，参数格式为：
q={"name":"value","name":"value","name":"value"}，`q参数设置值为标准json格式，参数名称和值需要使用英文双引号""。`目前支持参数如下：

<table>
    <tr>
        <th colspan=2>名称</th>
        <th>类型</th>
        <th>说明</th>
    </tr>
    <tr>
        <td rowspan=5>普通参数</td>
        <td>headerBg</td>
        <td>string</td>
        <td>头部及按钮背景颜色，16进制色码值，如FF6600，不带#。神州默认的H5颜色为金色，设置该参数可使H5主题颜色与渠道APP颜色一致。</td>
    </tr>
    <tr>
        <td>lat</td>
        <td>double</td>
        <td>第三方定位纬度（高德坐标）</td>
    </tr>
    <tr>
        <td>lng</td>
        <td>double</td>
        <td>第三方定位经度（高德坐标）</td>
    </tr>
    <tr>
        <td>mobile</td>
        <td>string</td>
        <td>订车人手机号码，传入后仅限该手机号可以登录</td>
    </tr>
    <tr>
        <td>companyId</td>
        <td>integer</td>
        <td>企业ID，开通神州企业账户时自动生成（该参数只针对企业内部用车H5）</td>
    </tr>
    <tr>
        <td rowspan=3>免登参数</td>
        <td>tpuid</td>
        <td>string</td>
        <td>第三方系统中用户唯一身份标识（必填）, 是第三方本地用户信息的唯一标识，可以理解为第三方用户信息数据库表的id。</td>
    </tr>
    <tr>
        <td>timestamp</td>
        <td>long</td>
        <td>当前服务器时间毫秒数（必填）</td>
    </tr>
    <tr>
        <td>signature</td>
        <td>string</td>
        <td>sha1签名值（必填）</td>
    </tr>
</table>

### （2）免登录配置
在H5链接后的q参数中增加免登参数，可以在用户第一次登录之后，后续实现免登录。H5链接q参数json格式中增加额外信息，JSON格式如下：
```
{
    "tpuid": "xxxxx",  // 第三方系统中用户唯一身份标识（必填）
    "timestamp": "1494576413387", // 当前服务器时间毫秒数（必填，当前服务器时间必须与标准时间匹配，不然会导致签名失败）
    "signature": "xxx" // sha1签名值（必填）
}
```

##### 参数说明：
signature：client_secret（神州开放平台管理->应用详情里查询），mobile，timestamp，tpuid做字典排序后，
其四者的值拼接字符串（`字典排序是按照name排序`，然后将对应的值拼接字符串），做sha1（hex格式输出）加密后的值，并将该值放入q参数signature。

##### 备注：
A、client_secret为保密信息，请一定不要在q参数中传递，此处仅仅用于生成signature签名。<br>
B：做签名后接入链接仅仅一次有效，以后每次接入都需要重新生成签名。<br>
C：第一次需要用户进行登录，登录后系统自动与tpuid绑定，第二次即可免登录。<br>
D：需申请tpuid权限，开通权限请联系神州专车产品研发人员。<br>

##### 字典排序示例：
字典排序前：[ 'tpuid', 'client_secret', 'timestamp', 'mobile' ]<br>
字典排序后：[ 'client_secret', 'mobile', 'timestamp', 'tpuid' ]<br>
备注：`字典排序是按照name排序`，然后将对应的值拼接字符串

##### SHA1结果示例
原文：https://commonwap.10101111.com/<br>
SHA1之后结果：c859ec1ff583b396e7db918b666301caa65841ac

##### Java原生SHA1哈希算法：
```
/**
 * Java原生SHA1散列
 * @param decript
 * @return
 */
public static String SHA1(String decript) {
    try {
        MessageDigest digest = java.security.MessageDigest
                .getInstance("SHA-1");
        digest.update(decript.getBytes());
        byte messageDigest[] = digest.digest();
        // Create Hex String
        StringBuffer hexString = new StringBuffer();
        // 字节数组转换为 十六进制 数
        for (int i = 0; i < messageDigest.length; i++) {
            String shaHex = Integer.toHexString(messageDigest[i] & 0xFF);
            if (shaHex.length() < 2) {
                hexString.append(0);
            }
            hexString.append(shaHex);
        }
        return hexString.toString();
    } catch (NoSuchAlgorithmException e) {
        e.printStackTrace();
    }
    return "";
}
```

##### Node原生SHA1哈希算法：
```
var crypto = require('crypto');
function (value) {
    var sha1 = crypto.createHash('sha1');
    sha1.update(value);
    return sha1.digest('hex');
}
```

##### PHP原生SHA1哈希算法：
```
<?php
$str = "Shanghai";
echo sha1($str);
?>
```

##  订单流程调试
为方便开发者能够走通整个订单流程，开放平台提供了订单调试接口和工具。

#### （1）订单调试接口
在开放平台网站—>接入指南—><a href="doc?r=guide/content#接口调试" target="_blank">API接入</a>

#### （2）订单调试工具
在开放平台网站—>应用管理模块，如下图：

点击调试，可以对该应用的订单进行调试，如下图：

订单状态请参考：<a href="doc?r=guide/content#状态定义" target="_blank">订单状态</a>

## 订单数据获取
获取H5应用的神州订单数据，有以下3种方法

##### （1）通过API接口同步数据:
通过客户端模式访问<a href="doc?r=api/content#获得所有订单数据" target="_blank">获取所有订单数据接口</a>，可以同步订单数据。
如果该接口不能满足需求，可联系神州产品研发人员。客户端ID及秘钥见H5应用详情，如下图。

##### （2）如果是企业内部用车，可通过<a href="https://my.10101111.com/company/index.do" target="_blank">企业管理后台</a>自助导出订单数据。

##### （3）线下方式：月底神州商务人员会发送电子对账单进行对账。

## 企业用车
如果您是企业内部用车，还需要以下流程：
#### （1）选择H5类型
在开放平台创建应用时，依据支付类型可以选择H5（企业支付）或H5（员工垫付），如下图：

#### （2）开通企业账户
如果是正式应用，需要在<a href="http://my.10101111.com/company/index.do" target="_blank">神州专车官网</a>上，申请开通神州企业账户，开通企业账户以后需要联系神州商务绑定开通的企业账户，具体可<a href="http://developer.10101111.com/resourceCenter/doc?r=faq/contact">联系神州商务</a>。

#### （3）H5地址参数参数
企业用车H5链接增加企业参数：`q={"companyId":"企业id"}`，如下：

https://commonwappre.10101111.com/join?key=OWtUaDQ3VmFiTjdlXzEwb1NGZE92TEdQYjlERGtGMmc5Z2trQTFMQVNOaW1PMm51bXBlVkxvc
        UNzOXRwYjBjX296c0ZqS2Y1Z01MNFlUZ2ktbmU1YVg0cVMtNXFPXy1aVGFlTnJvVENmQlU9&mobile=用户电话号码&q={"companyId":"企业id"}

如果是测试应用，企业支付，企业id=2421；

如果是测试应用，员工垫付，企业id=2832；

如果是正式应用，企业id使用上述步骤2中开通的企业id，具体可咨询贵方商务或神州商务人员。

#### （4）员工管理

员工使用企业账户用车，需要提前把员工的手机号加入到企业里面，加入方法有以下3种：

* A、登录企业<a href="http://my.10101111.com/company/index.do" target="_blank">管理后台</a>，点击“员工管理”按钮，添加员工，可以逐一新建，也可批量导入
<div class="text-center" style="display:none"><img src="#" id="html5-main" data-load-path="/img/h5-guide/10.png"><div class="text-center input-tips"></div></div>

* B、员工自行加入（通过匹配邮箱后缀自动加入企业），企业开通绑定邮箱功能后，员工通过2个入口自行加入企业。<br/><br/>
    在神州专车PC端入口，输入员工邮箱（邮箱后缀必须为公司邮箱后缀）；在神州专车APP-企业服务-加入企业。<br/><br/>
    <div class="row">
        <div class="col-md-6 text-center" style="display:none"><img src="#" id="html5-main" data-load-path="/img/h5-guide/11.png"><div class="text-center input-tips"></div></div>
        <div class="col-md-6 text-center" style="display:none"><img src="#" id="html5-order" data-load-path="/img/h5-guide/12.png"><div class="text-center input-tips"></div></div>
    </div>员工登录邮箱，查收验证邮件，并点击邮箱中链接，验证成功。

* C、通过开放平台API接口添加员工<br>
接口文档：<a href="doc?r=api/content#添加企业员工">添加企业员工</a>

加载中...

神州专车开放平台登录

邮箱
密码
验证码

验证码错误

记住账号忘记密码？