{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"169d1216-493a-4bb8-9742-7725a7051d49","name":"API文档","description":"## 加密算法\n\n- 所有的请求都需要对请求体进行加密校验\n    \n- 所有请求必须包含app_id和app_key和sign\n    \n- app_id和app_key从用户后台获取\n    \n- sign通过下面的加密算法计算得出\n    \n\n### 加密原理\n\n#### 1、对PostData对象键进行排序\n\n- 对请求体进行字典序排序。这是因为生成签名时, 需要确保参数的顺序一致, 以防不同的顺序导致生成不同的签名值.\n    \n\n#### 2、拼接字符串\n\n- 遍历排序后的键，将每个键和对应的值拼接成字符串. 在拼接时, 如果键的值不为空（null或空字符串）, 则将键和值进行URL编码, 并用&连接.\n    \n\n#### 3、添加商户密钥\n\n- 在查询字符串的末尾加上&key=yourAppKey，其中yourAppKey是提前定义好的应用密钥。这一步是将应用密钥纳入签名的计算之中，提高签名的安全性\n    \n\n#### 4、计算请求体MD5值\n\n- 计算查询字符串的MD5哈希值，以生成签名。\n    \n\n#### 5、将计算到的值添加到请求体\n\n- 请求体添加 sign=md5值\n    \n\n### PHP加密算法\n\n``` PHP\n    /**\n     * 获取数据签名\n     * @param array $data\n     * @param string $appKey\n     * @return string\n     */\n    public static function generateSignature(array $data, $appKey): string\n    {\n        unset($data['sign']);\n        ksort($data);\n        foreach ($data as $key => $val) {\n            if ($val === '') {\n                unset($data[$key]);\n            }\n        }\n        return md5(urldecode(http_build_query($data) . \"&key=\" . (string)$appKey));\n    }\n\n ```\n\n### C#加密算法\n\n``` C#\n    public static class SignatureHelper\n    {\n        public static string GenerateSignature(Dictionary<string, string> data, string appKey)\n        {\n            if (data.ContainsKey(\"sign\"))\n            {\n                data.Remove(\"sign\");\n            }\n            var sortedData = data.OrderBy(pair => pair.Key);\n            var sanitizedData = new Dictionary<string, string>();\n            foreach (var pair in sortedData)\n            {\n                if (pair.Value != null && !string.IsNullOrEmpty(pair.Value.ToString()))\n                {\n                    sanitizedData.Add(pair.Key, pair.Value);\n                }\n            }\n            var queryString = string.Join(\"&\", sanitizedData.Select(pair => $\"{HttpUtility.UrlEncode(pair.Key)}={HttpUtility.UrlEncode(pair.Value.ToString())}\"));\n            queryString += $\"&key={appKey}\";\n            return CalculateMd5Hash(HttpUtility.UrlDecode(queryString));\n        }\n        private static string CalculateMd5Hash(string input)\n        {\n            using MD5 md5 = MD5.Create();\n            byte[] inputBytes = Encoding.UTF8.GetBytes(input);\n            byte[] hashBytes = md5.ComputeHash(inputBytes);\n            StringBuilder sb = new StringBuilder();\n            for (int i = 0; i < hashBytes.Length; i++)\n            {\n                sb.Append(hashBytes[i].ToString(\"X2\"));\n            }\n            return sb.ToString().ToLower();\n        }\n    }\n\n ```\n\n### PostMan Pre-request Script\n\n``` javascript\n// 初始化一个空对象来存储POST参数\nlet postData = {};\npm.request.body.urlencoded.each((param) => {\n    postData[param.key] = param.value;\n});\n// 检查app_key是否存在\nif (!postData.hasOwnProperty('app_key') || postData['app_key'] === '') {\n    throw new Error(\"app_key is missing from the POST parameters.\");\n}\nlet appKey = postData['app_key']; // 从POST参数中获取appKey\n// 删除sign键（如果存在）\nif (postData.hasOwnProperty('sign')) {\n    delete postData['sign'];\n}\n// 对postData的键进行排序并构建查询字符串\nlet sortedKeys = Object.keys(postData).sort();\nlet queryString = \"\";\nsortedKeys.forEach((key, index) => {\n    if (postData[key] !== null && postData[key] !== \"\") {\n        queryString += `${encodeURIComponent(key)}=${encodeURIComponent(postData[key])}${index < sortedKeys.length - 1 ? '&' : ''}`;\n    }\n});\n// 添加appKey\nqueryString += `&key=${appKey}`;\n// 计算MD5\nconst crypto = require('crypto-js');\nlet hash = crypto.MD5(decodeURIComponent(queryString)).toString(crypto.enc.Hex).toLowerCase();\nconsole.log(\"Generated Signature: \" + hash);\n// 将sign添加到POST参数中\npm.request.body.urlencoded.add({key: \"sign\", value: hash});\n\n ```","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"39427840","team":28149432,"collectionId":"169d1216-493a-4bb8-9742-7725a7051d49","publishedId":"2sAY4viP6a","public":true,"publicUrl":"https://documenter-api.postman.tech/view/39427840/2sAY4viP6a","privateUrl":"https://go.postman.co/documentation/39427840-169d1216-493a-4bb8-9742-7725a7051d49","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.12.6","publishDate":"2024-11-01T06:49:33.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/0bac42c28f9a942f60d293203d064002545ebd368eb1a2fa8bd683f0b0fce153","favicon":""},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/2sAY4viP6a"}