"## 接口信息\n\n**API Path**\n签名认证方式\n\n# 鉴权目标\n\n本鉴权目的在于为星河系统的鉴权做增强鉴权认证体系，为了系统提供更加高效安全的通信方式。\n\n# 调用地址\n\n公网域名：openapi.teleagi.cn\n端口：443\n接口地址：查看每个接口文档的头部连接地址\n\n请求地址：\n\nhttps://openapi.teleagi.cn:443/{接口地址}\n\nwss://openapi.teleagi.cn:443/{接口地址}\n\n# 请求头说明\n\n请求头Header传入如下字段，字段说明见下表格\n\n\n| 字段名 | 是否必填 | 字段说明 |\n| ------------- | -------- | ---------------- |\n| Authorization | 是 | 签名 |\n| X-APP-ID | 是 | 用户申请的账号ID |\n| OrderNum | 否 | 订单号 |\n\n## Authorization生成方式\n\n**使用快速生成工具** ： [https://www.teleai.com.cn/signature](https://www.teleai.com.cn/signature)\n\nAuthorization={originName}/{X-APP-ID}/{region}/{timestamp}/{expirationPeriodInSeconds}/{signedHeaders}/{signature}\n其中\n\n* originName 公网环境为：teleai-cloud-auth-v1\n* region 所请求服务资源所在的区域，可使用省份缩写拼音（见本文后面的省份列表）\n* timestamp 为10位的unix 时间戳例如：1728892448\n* expirationPeriodInSeconds签名有效期限从timestamp所指定的时间开始计算，单位为秒\n* signedHeaders：推荐默认值直接给【x-app-id】\n* signature： 256位签名的十六进制表示，由64个小写字母组成。它由SK(X-APP-KEY)和authStringPrefix哈希得到signingKey，再将canonicalRequest以signingKey为key进行哈希摘要生成，具体算法见下。\n\n### 1、signedHeaders规则\n\nHTTP请求头header根据自身情况进行赋值(推荐给默认值x-app-id)\n\n```\n比如当前请求的header中包含\nA：a\nA1：a\nA2：a\nA3：a\nX-APP-ID:XXX #这个header的值是必填的所以singnedHeaders 可以直接默认给x-app-id\n```\n\n以上边的hader为基础 signedHeaders 可以是 key的任意组合(推荐 x-app-id)\n\n```\neg: a;a1;a2\neg: a1;a2;x-app-id\neg: x-app-id\n```\n\n### 2、 signature规则\n\n* 下边提供了代码加密方法\n* 第一次加密：\n SigningKey =HMAC-SHA256-HEX(X-APP-KEY, authStringPrefix)\n (本段只解释原理，可以掠过)\n * X-APP-KEY (申请到的)\n authStringPrefix={originName}/{X-APP-ID}/{region}/{timestamp}/{expirationPeriodInSeconds}\n* 第二次加密：\n 得到最终签名Signature =HMAC-SHA256-HEX(SigningKey, CanonicalRequest)\n* (本段只解释原理，可以掠过)\n * SigningKey为上一次加密的结果\n * CanonicalRequest=HTTP Method + \"\\n\" + CanonicalURI + \"\\n\" + CanonicalQueryString + \"\\\\n\"+ CanonicalHeaders![17513405971751340596611.png](https://www.teleai.com.cn/aicloud-file/open-platform/open-platform-common/bdb1f7c94cf1898dca944a74b6d64984.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20260512T071202Z&X-Amz-SignedHeaders=host&X-Amz-Expires=604800&X-Amz-Credential=Q9D25PSR6TRHFDHRO0BR%2F20260512%2Fcn%2Fs3%2Faws4_request&X-Amz-Signature=2937a70001451986695b34e854640f36870a1d02b1be974a95438b0034117f9d)\n * * HTTP Method是你当前请求的requestMethod（WebSocket是get）\n * CanonicalURI 是你的请求的path 以 http://127.0.0.1:8080/aipaas/aipaas-web/yyyy\n 【/aipaas/aipaas-web/yyyy】这个是path\n 【http://127.0.0.1:8080】这个不是path\n * 提供工具加密方法\n https://www.lddgo.net/encrypt/hmac\n 第一次加密\n ![1.png](https://www.teleai.com.cn/aicloud-file/open-platform/open-platform-common/2f3fd756b9e51ca919bc533456b3d27a.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20260513T045919Z&X-Amz-SignedHeaders=host&X-Amz-Expires=604799&X-Amz-Credential=Q9D25PSR6TRHFDHRO0BR%2F20260513%2Fcn%2Fs3%2Faws4_request&X-Amz-Signature=005ce754d7fe8a3dbfb58b8e9b93a88db334762842c333e8d57e7e04f6914738)\n * 第二次加密\n ![2.png](https://www.teleai.com.cn/aicloud-file/open-platform/open-platform-common/cacfaf307a0659e2c88e685b52874d1d.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20260513T045919Z&X-Amz-SignedHeaders=host&X-Amz-Expires=604800&X-Amz-Credential=Q9D25PSR6TRHFDHRO0BR%2F20260513%2Fcn%2Fs3%2Faws4_request&X-Amz-Signature=dbc34f3d2bcbbad4e9452a48578a0c52f9184564ccd607397b09890586ac658e)\n\n# 附录：\n\n## 省份拼音缩写表\n\n\n| 编码 | 省市 | 缩写 |\n| ------ | ------ | ---- |\n| 000000 | 全国 | QG |\n| 110000 | 北京市 | BJ |\n| 120000 | 天津市 | TJ |\n| 130000 | 河北省 | HE |\n| 140000 | 山西省 | SX |\n| 150000 | 内蒙古 | NM |\n| 210000 | 辽宁省 | LN |\n| 220000 | 吉林省 | JL |\n| 230000 | 黑龙江 | HL |\n| 310000 | 上海市 | SH |\n| 320000 | 江苏省 | JS |\n| 330000 | 浙江省 | ZJ |\n| 340000 | 安徽省 | AH |\n| 350000 | 福建省 | FJ |\n| 360000 | 江西省 | JX |\n| 370000 | 山东省 | SD |\n| 410000 | 河南省 | HA |\n| 420000 | 湖北省 | HB |\n| 430000 | 湖南省 | HN |\n| 440000 | 广东省 | GD |\n| 450000 | 广西省 | GX |\n| 460000 | 海南省 | HI |\n| 500000 | 重庆市 | CQ |\n| 510000 | 四川省 | SC |\n| 520000 | 贵州省 | GZ |\n| 530000 | 云南省 | YN |\n| 540000 | 西藏 | XZ |\n| 610000 | 陕西省 | SN |\n| 620000 | 甘肃省 | GS |\n| 630000 | 青海省 | QH |\n| 640000 | 宁夏 | NX |\n| 650000 | 新疆 | XJ |\n| 710000 | 台湾省 | TW |\n| 810000 | 香港 | HK |\n| 820000 | 澳门 | MO |\n\n## 代码示例\n\n### java生成签名工具类(Java版本使用**JDK1.8** )\n\n```java\npackage cn.com.utils;\n\nimport cn.hutool.core.util.StrUtil;\nimport lombok.extern.slf4j.Slf4j;\nimport org.springframework.http.HttpHeaders;\nimport org.springframework.http.HttpMethod;\n\nimport javax.crypto.Mac;\nimport javax.crypto.spec.SecretKeySpec;\nimport java.io.UnsupportedEncodingException;\nimport java.net.URLEncoder;\nimport java.util.*;\n\n\n\n\n@Slf4j\npublic class SignUtils {\n\n\n\n String str ;\n\n // 授权字符串字段数\n public static final int AUTHORIZATION_ITEM_NUM = 7;\n // HMAC SHA256 算法常量\n private static final String HMAC_SHA256_ALGORITHM = \"HmacSHA256\";\n\n public static final List DEFAULT_HEADERS = Arrays.asList(\n HttpHeaders.HOST,\n HttpHeaders.CONTENT_TYPE,\n HttpHeaders.CONTENT_LENGTH,\n \"Content-Md5\");\n\n /**\n * 生成签名\n * @param signPrefix 签名前缀\n * @param appKey 应用密钥\n * @param method HTTP请求方法\n * @param path HTTP请求uri\n * @param params HTTP请求参数\n * @param headers HTTP请求headers\n * @return 生成的签名\n */\n public static String genSignature(String signPrefix,String appKey, HttpMethod method, String path,\n Map params, Map headers,String signedHeaders) {\n\n // 格式化基础签名信息\n String signingKey;\n try {\n // 生成签名密钥\n signingKey = generateHmacSHA256Hex(signPrefix, appKey);\n } catch (Exception e) {\n log.error(\"{signPrefix}/{X-APP-ID}/{region}/{timestamp}/{expirationPeriodInSeconds}签名错误\", e);\n throw new RuntimeException(e);\n }\n log.info(\"appKey:[{}] signingKey:[{}]\",appKey,signingKey);\n // 获取规范化的请求字符串\n String canonicalRequest = getCanonicalRequest(method, path, params, headers,signedHeaders);\n log.info(\"请求内容签名信息 canonicalRequest:\\n{}\",canonicalRequest);\n String signature;\n try {\n // 生成最终签名\n signature = generateHmacSHA256Hex(canonicalRequest, signingKey);\n } catch (Exception e) {\n log.error(\"canonicalRequest 签名错误\", e);\n throw new RuntimeException(e);\n }\n return signature;\n }\n\n /**\n * 获取规范化的请求字符串\n *\n * @param method HTTP请求方法\n * @param path HTTP请求uri\n * @param params HTTP请求参数\n * @param headers HTTP请求headers\n * @param signedHeaders 签名头\n * @return 规范化的请求字符串\n */\n private static String getCanonicalRequest(HttpMethod method, String path, Map params,\n Map headers, String signedHeaders) {\n // 构建规范化的请求字符串\n StringBuilder canonicalRequest = new StringBuilder();\n canonicalRequest.append(method).append(\"\\n\");\n String canonicalURI;\n try {\n // 规范化请求URI\n canonicalURI = URLEncoder.encode(path, \"utf-8\").replaceAll(\"%2F\", \"/\");\n } catch (UnsupportedEncodingException e) {\n log.error(\"url encode error\", e);\n throw new RuntimeException(e);\n }\n canonicalRequest.append(canonicalURI).append(\"\\n\");\n\n // 获取规范化查询字符串\n canonicalRequest.append(getCanonicalQueryString(params)).append(\"\\n\");\n\n // 获取规范化请求头\n String canonicalHeaders = getCanonicalHeaders(headers,signedHeaders);\n canonicalRequest.append(canonicalHeaders);\n return canonicalRequest.toString();\n }\n\n /**\n * 获取规范化的查询字符串\n *\n * @param paramMap 查询参数映射\n * @return 规范化的查询字符串\n */\n private static String getCanonicalQueryString(Map paramMap) {\n List params = new ArrayList();\n for (Map.Entry param : paramMap.entrySet()) {\n String key = param.getKey();\n String value = param.getValue();\n try {\n params.add(URLEncoder.encode(key, \"UTF-8\") + \"=\" + (StrUtil.isNotBlank(value) ? URLEncoder.encode(value, \"UTF-8\") : \"\"));\n } catch (UnsupportedEncodingException e) {\n log.error(\"params encode error\", e);\n throw new RuntimeException(e);\n }\n }\n // 按字母顺序排序查询参数\n// params.sort(String.CASE_INSENSITIVE_ORDER);\n Collections.sort(params);\n return StrUtil.join( \"&\",params);\n }\n\n /**\n * 获取规范化的请求头\n * @param headerMap 请求头映射\n * @param signedHeaders 签名头\n * @return 规范化的请求头字符串\n */\n private static String getCanonicalHeaders(Map headerMap, String signedHeaders) {\n if (headerMap.isEmpty()) {\n return \"\";\n }\n // 将请求头键名转换为小写\n Map lowerCaseHeaderMap = new HashMap();\n for (Map.Entry entry : headerMap.entrySet()) {\n lowerCaseHeaderMap.put(entry.getKey().toLowerCase(), entry.getValue());\n }\n\n List headerList = new ArrayList();\n List headerNames;\n if (StrUtil.isNotBlank(signedHeaders)) {\n headerNames = StrUtil.split(signedHeaders,\";\");\n } else {\n headerNames = DEFAULT_HEADERS;\n }\n for (String headerName : headerNames) {\n String lowerCaseHeaderName = headerName.trim().toLowerCase();\n String headerValue = lowerCaseHeaderMap.get(lowerCaseHeaderName);\n if (StrUtil.isNotBlank(headerValue)) {\n try {\n headerList.add(lowerCaseHeaderName + \":\" + StrUtil.trim(URLEncoder.encode(headerValue, \"UTF-8\")));\n } catch (UnsupportedEncodingException e) {\n log.error(\"headers encode error\", e);\n throw new RuntimeException(e);\n }\n }\n }\n // 按字母顺序排序请求头\n// headerList.sort(String.CASE_INSENSITIVE_ORDER);\n Collections.sort(headerList);\n return StrUtil.join(\"\\n\",headerList );\n }\n\n /**\n * 生成一个 HmacSHA256 哈希值。\n *\n * @param data 要进行哈希处理的数据。\n * @param key 用于哈希处理的密钥。\n * @return 生成的 HmacSHA256 哈希值，以十六进制编码表示。\n * @throws Exception 如果哈希处理失败，则抛出异常。\n */\n private static String generateHmacSHA256Hex(String data, String key) throws Exception {\n SecretKeySpec signingKey = new SecretKeySpec(key.getBytes(), HMAC_SHA256_ALGORITHM);\n Mac mac = Mac.getInstance(HMAC_SHA256_ALGORITHM);\n mac.init(signingKey);\n byte[] rawHmac = mac.doFinal(data.getBytes());\n return bytesToHex(rawHmac);\n }\n\n /**\n * 将字节数组转换为十六进制字符串。\n *\n * @param bytes 要转换的字节数组。\n * @return 字节数组的十六进制表示。\n */\n private static String bytesToHex(byte[] bytes) {\n StringBuilder hexString = new StringBuilder();\n for (byte b : bytes) {\n String hex = Integer.toHexString(0xff & b);\n if (hex.length() == 1) {\n hexString.append('0');\n }\n hexString.append(hex);\n }\n return hexString.toString();\n }\n\n public static void main(String[] args) {\n //特此声明里边的值需要根据需求进行替换\n //时间戳\n long l = System.currentTimeMillis() / 1000L;\n //这里因为没有引入Request 所以模拟header的map\n Map headerMap = new HashMap();\n //这里根据文档里的描述，这里需要根据实际需求进行修改（推荐使用 x-app-id）\n String signedheaders = \"x-app-id\";\n //如果signedheaders 有多个那么这里需要都塞进去同样的当你使用request的请求的时候你的signedheaders里的key在header都需要具备\n headerMap.put(\"X-APP-ID\", \"用户申请的账号ID\"); \n //根据文档进行替换,所请求服务资源所在的区域，可使用所在省份缩写（见本文后面的省份列表）\n String region=\"HN\";\n String appId=\"yourAPPID\";\n String basic = \"teleai-cloud-auth-v1/\"+appId+\"/\"+region+\"/\"+l+\"/180000\"; \n //这里是接口的param param指的是路径后缀使用?后面的参数同样的如果使用request的话使用了url拼接？key=value 那么加密必须使用\n //这里模拟的是不具备？的情况所以塞了一个空的map\n Map params = new HashMap();\n String sign = SignUtils.genSignature(\n basic,\n //X-APP-KEY,对应账号信息中的key值\n \"yourAPPKEY\",\n //请求的发送方式 POST GET 等 websocket 是GET，需要与算法的请求方式保持一致\n HttpMethod.POST,\n //请求路径的path\n \"/aipaas/cv/v1/image/cyclistsHelmetDetect\",\n params,\n headerMap,\n signedheaders);\n\n System.out.println(sign);\n //生成的就是 Authorization 注意生成的有斜杠进行拼接\n System.out.println(String.format(\"Authorization: %s/%s/%s\",basic,signedheaders,sign));\n }\n}\n```\n\n### shell脚本\n\n```\n#!/bin/bash\n\n# Function to URL encode a string\nurl_encode() {\n local string=\"${1}\"\n local strlen=${#string}\n local encoded=\"\"\n \n for (( pos=0; pos

大模型体验中心

开放能力

开发平台

应用产品

解决方案

关于TeleAI

热门搜索