详细介绍

提供了一个简易的邀请码核销功能，主要方便集成第三方或者内部应用使用
提供了简易的代理登录及代理邀请码查看功能，实际上可以通过API接口，自行开发界面显示，集成任意系统
API做了基础的安全处理，集成轻量级应用可以直接使用

功能特性

提供API邀请码查询、核验、查询渠道等功能，可以快速集成现有系统
已制作应用内部接口，也可方便集成webman-admin现有应用（需要自行集成处理）

安装使用

用到缓存功能，使用插件需要安装Cache缓存
执行以下命令，如已安装可以忽略
composer require -W webman/cache

联系方式

QQ：29502954

注意事项

使用此插件请悉知

此插件只提供了基础的邀请码功能逻辑，并不能直接使用于业务，如邀请码打折，邀请码代理折扣，对你现有产品进行控制，而是通过邀请码核验返回核验结果，对于业务其它逻辑需要自行处理

故无论是集成webman应用还是第三方应用，都需要有一定技术能力，插件提供者不提供集成服务

API 接口对接文档

1. 概述

本文档描述了如何正确调用我们的 API 接口，包括请求参数、签名验证机制以及安全注意事项。

2. 请求参数

2.1 公共请求头

所有请求必须包含以下公共参数：

2.2 业务参数

除公共参数外的其他业务参数，根据具体接口而定。

3. 签名生成规则

3.1 获取密钥

1. 使用渠道代码(code)获取对应的密钥(secret)
2. 密钥使用AES加密存储，需要先解密

3.2 签名生成步骤

1. 移除请求参数中的sign字段
2. 将所有参数按字母顺序排序
3. 使用URL编码格式化参数字符串
4. 将参数字符串、解密后的密钥和时间戳拼接
5. 对拼接后的字符串进行MD5加密

3.3 示例代码（PHP）

$params = [
    'param1' => 'value1',
    'param2' => 'value2',
    // ... 其他业务参数
    'timestamp' => time(),
    'nonce' => 'random_string',
    'code' => 'your_channel_code'
];

// 移除sign字段（如果有）
unset($params['sign']);

// 参数排序
ksort($params);

// 生成参数字符串
$string = http_build_query($params);

// 获取解密后的密钥
$secret = Func::aesDecrypt($channel['secret']);

// 生成签名
$sign = md5($string . $secret . $timestamp);

4. 安全验证

4.1 时间戳验证

• 请求时间戳必须在当前时间的±5分钟内
• 超出时间范围的请求将被拒绝

4.2 签名验证

• 服务端会验证请求签名的正确性
• 签名不正确的请求将被拒绝

4.3 重复请求防护

• 使用sign+nonce的组合作为唯一标识
• 相同的标识在5分钟内只能使用一次
• 重复请求将被拒绝

5. 错误码说明

6. 注意事项

1. 所有请求必须使用HTTPS协议
2. 请妥善保管渠道密钥，避免泄露
3. nonce建议使用UUID等唯一性强的随机字符串
4. 时间戳请使用当前时间的秒级时间戳
5. 建议在客户端实现请求重试机制，但要注意避免重复请求

7. 示例请求

POST /api/endpoint
Content-Type: application/x-www-form-urlencoded

param1=value1&param2=value2&timestamp=1672531200&nonce=abc123&code=your_code&sign=generated_sign

如有任何疑问，请联系技术支持团队。