佳弈考级接口对接

佳弈 考级 接口 API

协议规则:

API调用遵循以下规则:

• 传输方式: 采用HTTP传输
• 提交方式: 采用POST方法提交
• 数据格式: json
• 字符编码: 统一采用UTF-8字符编码

安全规范:

所有接口都需携带签名, 服务端会根据参数进行验签

签名算法:

• 在接口方获取合法的 client_key
• 设所有发送或者接收到的数据为集合M，将集合M内非空参数值的参数按照参数名ASCII码从小到大排序（字典序），使用URL键值对的格式（即key1value1key2value2…）拼接成字符串stringA。
• 在stringA头部和尾部都拼接上 client_key 得到stringSignTemp字符串，并对stringSignTemp进行MD5运算，得到 sign
• 注意以下重要规则：
  
  • 必传参数:
    
    • timestamp: 时间戳(秒级)
  • 接口参数: 各接口相关参数.
• 参数名ASCII码从小到大排序（字典序）；
• 如果参数的值为空不参与签名；
• 参数名区分大小写；
• 传送的sign参数不参与签名。

签名算法Demo(PHP版本):

测试客户端信息:

$client_key = '8fs0FsEcrsP627Plu1Do2VmCAj3OcrgV';

传送参数如下:

$data = [
    'timestamp' => '1573476875',   //时间戳(秒)
    'sn'        => 'CA20191111000101'      //准考证号码
];

第一步：对参数按照key=value的格式，并按照参数名ASCII字典序排序如下：

ksort($data);
$string = '';
foreach ($params as $key => $val) {
    $string .= $key . $val;
}
//$string="snCA20191111000101timestamp1573476875"

第二步：拼接API密钥：

$string = $client_key . $string . $client_key;  
$sign = md5($string);
//$sign = '74dba2456f739661d85301cde5feed47';

接口列表

接口请求 BaseUrl

• http://api.yihaihuiyuan.com/api

准考证查询接口

• 请求地址： /vendor/grade/sn
• 请求方法：POST
• 请求参数：

请求结果：

返回数据示例：

{
    "error": 0,
    "data": {
        "sn": "CA20191111000101",   // 准考证号
        "name": "张悦然",           // 考生姓名
        "organization": "湖州星星围棋体育俱乐部",  // 所属机构
        "apply_level": "2级",    // 申请等级
        "apply_level_id": 24,    // 申请等级 ID
        "status": "1"    // 准考证成绩上报状态：0 - 未考试 1 - 已上报一次 2 - 已上报两次
        "start_at" => 1585891726,  // 准考证有效开始时间
        "end_at" => 1586509870,   // 准考证有效截止时间
    },
    "message": "请求成功"
}

考试成绩上报接口

• 请求地址： /vendor/grade/result
• 请求方法：POST
• 请求参数：

机器授权码

• 请求地址： /vendor/machine/activation
• 请求方法：POST
• 请求参数：

请求结果：

{
    "error": 0,
    "data": {
        "sn": "8ccc8c51dc553d53a176d88967ba44b7",   // 授权码
    },
    "message": "验证成功"
}

验证失败时：

{
    "error": 1,
    "data": {
        "sn": "8ccc8c51dc553d53a176d88967ba44b7",   // 授权码
    },
    "message": "验证失败: 已使用"
}

错误信息列表

授权码流程:
白雪方提供授权码
佳弈方在程序中添加输入框
第一次使用软件时候, 输入授权码
通过接口向白雪方核验授权码
授权码核验通过后则永久授权此机器
PS: 授权码一机一码