文档

GetAuthToken - 获取 H5 认证授权 Token

更新时间:

获取授权token用于H5本机号码校验的鉴权,返回结果包括AccessToken和JwtToken。

接口说明

准备工作

请先完成阿里云账号注册、获取阿里云访问密钥、创建认证方案,更多信息,请参见 H5 本机号码校验使用流程

QPS 限制

本接口的单用户 QPS 限制为 1000 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dypns:GetAuthTokenWrite
  • 全部资源
    acs:dypns:*:{#accountId}:*

请求参数

名称类型必填描述示例值
Urlstring

请求网页地址。

https://www.aliyundoc.com/
Originstring

请求域名。

https://www.aliyundoc.com
SceneCodestring

方案号 CODE。

FC10000010643****

返回参数

名称类型描述示例值
object
Codestring

状态码。

OK
Messagestring

状态码的描述。

请求成功
RequestIdstring

请求 ID。

8906582E-6722
TokenInfoobject

结构体。

AccessTokenstring

业务鉴权 Token。

说明 AccessToken 有效期是 10 分钟,有效期内可以重复使用。
agag****
JwtTokenstring

API 鉴权 Token。

说明 JwtToken 有效期是 1 小时,有效期内可以重复使用。
aweghd****

示例

正常返回示例

JSON格式

{
  "Code": "OK",
  "Message": "请求成功",
  "RequestId": "8906582E-6722",
  "TokenInfo": {
    "AccessToken": "agag****",
    "JwtToken": "aweghd****"
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-12-29OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:SceneCode
2023-06-07API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用

Java SDK

您可以通过添加 Maven 依赖安装阿里云 Java SDK。SDK 版本会持续更新,具体版本请以 OpenAPI 页面为准。

JAVA SDK MAVEN 坐标

<dependency>
  <groupId>com.aliyun</groupId>
  <artifactId>dypnsapi20170525</artifactId>
  <version>1.0.6</version>
</dependency>
  • 本页导读 (1)
文档反馈