1.概述

1. 请求数据约定

• HTTP Method: POST

• Content-Type: application/json
• 数据通过 Raw JSON 格式传输。

2. 答复数据约定

所有响应的接口数据均为 Json 格式

签名的生成过程如下：

1. 提取请求参数：
• 包含所有 GET 和 POST 参数、RAW JSON 参数。
• 仅使用参数的键名，不包括参数值。
2. 处理键名：
• 将所有参数的键名转换为小写。
• 对键名按照自然顺序（SORT_NATURAL）进行排序。
3. 拼接签名字符串：
• 将排序后的键名使用 & 连接，形成键名字符串。
• 在键名字符串后拼接请求的时间戳和密钥 secret_key

（secret_key 由 PartnerShare 发放和 product_key 一一对应）。
4. 生成签名：
• 使用 SHA256 算法对拼接后的字符串进行哈希处理，生成最终签名。

5. 签名方法参考：

PHP

/**
     * 生成请求签名
     * @param string $timestamp 请求时间戳
     * @param string $secretKey 密钥
     * @return string 返回生成的签名
     */
    private function generateSign( string $timestamp, string $secretKey ): string
    {
        // 合并 GET 和 POST 参数
        $params = $this->getAllParams();

        // 提取所有键名并转换为小写
        $lowercaseKeys = array_map( 'strtolower', array_keys( $params ) );

        // 按自然顺序对键名排序
        sort( $lowercaseKeys, SORT_NATURAL );

        // 拼接排序后的键名
        $keyString = implode( '&', $lowercaseKeys );

        // 拼接时间戳和密钥
        $signString = $keyString . $timestamp . $secretKey;

        // 生成签名 (使用 SHA256 算法)
        $sign = hash( 'sha256', $signString );

        return $sign;
    }

GO

package main

import (
	"crypto/sha256"
	"encoding/hex"
	"sort"
	"strings"
)

// GenerateSign 生成请求签名
func GenerateSign(params map[string]string, timestamp, secretKey string) string {
	// 提取所有键名并转换为小写
	var keys []string
	for key := range params {
		keys = append(keys, strings.ToLower(key))
	}

	// 按自然顺序对键名排序
	sort.Strings(keys)

	// 拼接排序后的键名
	keyString := strings.Join(keys, "&")

	// 拼接时间戳和密钥
	signString := keyString + timestamp + secretKey

	// 使用 SHA256 算法生成签名
	hash := sha256.New()
	hash.Write([]byte(signString))
	sign := hex.EncodeToString(hash.Sum(nil))

	return sign
}

在请求接口的时候，所有的签名校验的参数不直接携带到请求参数中，均通过 Header 参数传输，分别包括如下三个 Header 参数

测试环境域名：https://testing-api.partnershare.net

正式环境域名：https://api.partnershare.net

{{host}}/open/web/oauth/authorizeAndRedirect?product_key=K20xon3htdg&x-timestamp=1737538469&data=%20XE9Y0Ua2MM9GSu5wVVTXs_E5q9PegnwqMAqXSdtEezYB2ssVnEG70DEsr7ULXSzR6-PFUCo9gsKr9Acl9fbYoCkueZGcAjDUjoOdhz7VWfwGmbp9iO6Op2POWSsT-ctyNmYUL3PpN2HKbDekEP6i61y-jx9Z55WmzsngjOofknvTTLy5cm1A_bpLlywEfAnNReIsXjXUcLavpddIED2VmH-varlBwQV9f2qshFrd8T8SU3hN-qjQ7-bsoJMohZeVqlKHQQVD3LGTEWEiFTe7Op5DD29AmtxFZJLJKkEsIyCpXaFJWzAqLmR-HkgJM5-qoSD6fU2OUpbiqGaelMWumwslPcUc5iSHc_VdElD5wQTW5xdE9iUzhg9YlfnVOyUB5EPBMVEmN3-5FUHEvRmBiw&sign=23ee1028ca0e7f60f2002a11de3c3380f86e64f12b404c20ae000646acb956a9

class Encryptor
{
    private static $instance     = null; // 静态实例
    private        $secretKey;
    private        $cipherMethod = 'AES-256-CBC'; // 加密算法

    private function __construct()
    {
    }

    /**
     * 配置密钥
     * @param string $secretKey
     * @return Encryptor
     */
    public static function secret( string $secretKey ): Encryptor
    {
        if ( self::$instance === null ) {
            self::$instance = new self();
        }

        self::$instance->secretKey = hash( 'sha256', $secretKey, true ); // 生成32字节密钥
        return self::$instance;
    }

    /**
     * 加密参数
     * @param array $params 明文参数
     * @return string 加密后的字符串
     * @throws \Exception
     */
    public function encrypt( array $params ): string
    {
        $iv         = random_bytes( openssl_cipher_iv_length( $this->cipherMethod ) ); // 生成随机IV
        $plaintext  = json_encode( $params ); // 转换为JSON字符串
        $ciphertext = openssl_encrypt( $plaintext, $this->cipherMethod, $this->secretKey, OPENSSL_RAW_DATA, $iv );

        if ( $ciphertext === false ) {
            throw new BaseException( BaseException::PARAMS_ERROR,'Encryption failed.' );
        }

        return rtrim( strtr( base64_encode( $iv . $ciphertext ), '+/', '-_' ), '=' );
    }

    /**
     * 解密参数
     * @param string $encrypted 加密字符串
     * @return array 解密后的参数
     * @throws \Exception
     */
    public function decrypt( string $encrypted ): array
    {
        $data       = base64_decode( strtr( $encrypted, '-_', '+/' ) ); // 解码字符串
        $ivLength   = openssl_cipher_iv_length( $this->cipherMethod );
        $iv         = substr( $data, 0, $ivLength ); // 提取IV
        $ciphertext = substr( $data, $ivLength ); // 提取密文

        $plaintext = openssl_decrypt( $ciphertext, $this->cipherMethod, $this->secretKey, OPENSSL_RAW_DATA, $iv );

        if ( $plaintext === false ) {
            throw new BaseException( BaseException::PARAMS_ERROR,'Decryption failed.' );
        }

        return json_decode( $plaintext, true ); // 转换为数组
    }
}

{
    "product_key":"K20xon3htdg",
	"target_product_key":"jx30zoh0ooa",
    "user_id":"9927356",
    "extra":{
		"user_name":"平台优质用户",
		"user_logo":"dwadwaddwa",
        "email":"xxx@partnershare.net",
        "phone":"1552107xxxx",
		"locale":"zh"
    }
}

data 响应参数

响应参数完整示例

{
    "code": 0,
    "message": "success",
    "data": {
        "code": "2fwth3pfj8",
		"redirect_url":"https://xxx.saaslink.net/login/jx30zoh0ooa?x_auth_code=2fwth3pfj8"
    }
}

  3.被授权应用通过授权码读取授权信息

      若您方产品是作为被授权方，则您需要在品牌主后台设置中设置好默认的推广地址，默认的推广地址将是授权方推广的默认地址，授权方授权用户后通过PartnerShare的推广路由将直接重定向到您的推广地址并带上授权码,授权码参数名为x_auth_code

      示例:例如 https://www.baidu.com/login 是您方的推广目标地址，则跳转您方的目标推广地址的时候除了会带上ref邀请码等参数外l,会带上x_auth_code 授权码，该授权码5分钟有效，识别到请求中存在授权码后通过该接口可请求到授权用户信息，在您端内完成用户注册或登录，注册的用户需要关联上ref,以便做后续的数据回传。

eg:  https://www.baidu.com/login?ref=XPRUPY&snid=1736254248204743302_c2WD8F2q&custom_id=&x_auth_code=8fhgnbk0r3

接口地址：/open/api/oauth/getUserByAuthorizationCode

请求参数

请求参数完整示例

data 响应参数

接口地址：/open/api/tracer/relavanceOauthUser

请求参数

请求参数完整示例

{
    "user_key":"iwj76O11p2ou1dOPu6Rnihcj5iBd",
    "user_id":"8927125"
}

{
    "code": 0,
    "message": "success",
    "data": {
        "user_key": "Q7vKriNbn1rbx3flecZkYsihBq6g",
        "target_user_key": "lz3KA0y4usdsvkB3mlzhej81tmYl"
    }
}

5.获取调试授权码

接口地址：/open/api/oauth/getDebugAuthCode

请求参数

请求参数完整示例

{
    "source_product_key": "vKriNbn1rb",
    "product_key": "iriNbn1r2"
}

data 响应参数

响应参数完整示例

{
    "code": 0,
    "message": "success",
    "data": {
        "is_authorized": 0,
        "code": "zv1oqz75ul",
        "redirect_url": "https://demo.saaslink.net/login/jx30zoh0ooa?x_auth_code=2fwth3pfj8"
    }
}