通过SDK获取Token

本文介绍如何通过SDK方式获取Token。

前提条件

已在阿里云RAM访问控制台获取AccessKey ID和AccessKey Secret,具体操作,请参见从这里开始

获取方式

通过SDK获取Token方式

说明

通过智能语音交互SDK获取Token

适用于通过智能语音交互SDK直接获取Token的场景, 建议您集成此SDK。

通过阿里云公共SDK获取Token

适用于当前智能语音交互尚未提供对应语言SDK来获取Token的场景。

通过智能语音交互SDK获取Token

调用示例(Java)

从Maven服务器下载最新版本SDK,下载demo源码ZIP包

<dependency>
    <groupId>com.alibaba.nls</groupId>
    <artifactId>nls-sdk-common</artifactId>
    <version>2.1.6</version>
</dependency>

Java代码获取访问令牌Token实现示例如下:

AccessToken accessToken = new AccessToken("your akID", "your akSecret");
accessToken.apply();
String token = accessToken.getToken();
long expireTime = accessToken.getExpireTime();
  • token为服务端分配的Token,在Token过期失效前,可以一直使用,也支持在不同机器、进程或应用上同时使用该Token。

  • expireTime为此令牌的有效期时间戳,单位:秒。例如,1527592757换算为北京时间为2018/5/29 19:19:17,即Token在该时间之前有效,过期需要重新获取。

说明

当前获取Token需要获取AccessKey ID和AccessKey Secret,为了安全起见,一般不建议在端侧操作,比如在移动端等环境下保存AccessKey ID和AccessKey Secret,建议您在安全可靠的环境中使用AccessKey ID和AccessKey Secret。

如果您的使用场景是移动端APP,可以考虑自行在服务端搭建一个Token生成器的服务,将AccessKey ID和AccessKey Secret放在服务端,APP调用语音识别前,先向您的服务端请求下发Token,之后通过此Token向智能语音服务发起调用。

调用示例(C++)

说明
  • Linux下安装工具要求如下:

    • Glibc 2.5及以上

    • Gcc4或Gcc5

  • Windows下:VS2013或VS2015,Windows平台需要您自己搭建工程。

  1. 下载 C++ Token SDK

  2. 编译示例。

    假设示例文件已解压至path/to路径下,在Linux终端依次执行如下命令编译运行程序。

    • 当您的开发环境支持通过CMake编译:

      1. 确认本地系统已安装Cmake2.4及以上版本。

      2. 切换目录:cd path/to/sdk/lib

      3. 解压缩文件:tar -zxvpf linux.tar.gz

      4. 切换目录:cd path/to/sdk

      5. 执行编译脚本:./build.sh

      6. 切换目录:cd path/to/sdk/demo

      7. 执行获取Token示例:./tokenDemo <yourAccessKeySecret> <yourAccessKeyId>

    • 当您的开发环境不支持通过CMake编译:

      1. 切换目录:cd path/to/sdk/lib

      2. 解压缩文件:tar -zxvpf linux.tar.gz

      3. 切换目录:cd path/to/sdk/demo

      4. 使用g++编译命令编译示例程序:g++ -o tokenDemo tokenDemo.cpp -I path/to/sdk/include/ -L path/to/sdk/lib/linux -ljsoncpp -lssl -lcrypto -lcurl -luuid -lnlsCommonSdk -D_GLIBCXX_USE_CXX11_ABI=0

      5. 指定库路径:export LD_LIBRARY_PATH=path/to/sdk/lib/linux/

      6. 执行获取Token示例:./tokenDemo <yourAccessKeySecret> <yourAccessKeyId>

  3. 调用服务。

    C++获取访问令牌Token的示例代码如下:

    #include <iostream>
    #include "Token.h"
    
    using std::cout;
    using std::endl;
    using namespace AlibabaNlsCommon;
    
    //获取访问令牌TokenId
    int getTokenId(const char* keySecret, const char* keyId) {
        NlsToken nlsTokenRequest;
    
        /*设置阿里云账号KeySecret*/
        nlsTokenRequest.setKeySecret(keySecret);
        /*设置阿里云账号KeyId*/
        nlsTokenRequest.setAccessKeyId(keyId);
    
        /*获取Token. 成功返回0, 失败返回-1*/
        if (-1 == nlsTokenRequest.applyNlsToken()) {
            cout << "Failed: " << nlsTokenRequest.getErrorMsg() << endl; /*获取失败原因*/
    
            return -1;
        } else {
            cout << "TokenId: " << nlsTokenRequest.getToken() << endl; /*获取TokenId*/
            cout << "TokenId expireTime: " << nlsTokenRequest.getExpireTime() << endl; /*获取Token有效期时间戳(秒)*/
    
            return 0;
        }
    }

通过阿里云公共SDK获取Token

使用阿里云公共SDK获取Token,建议采用RPC风格的API调用。发起一次RPC风格的CommonAPI请求,需要提供以下参数:

参数名

参数值

说明

domain

nls-meta.cn-shanghai.aliyuncs.com

产品的通用访问域名,固定值。

region_id

cn-shanghai

服务的地域ID,固定值。

action

CreateToken

API的名称,固定值。

version

2019-02-28

API的版本号,固定值。

通过阿里云SDK获取Token时,如果成功调用,则会返回如下报文:

通过阿里云公共SDK获取Token

  • Id为本次分配的访问令牌Token,在Token过期失效前,可以一直使用,也支持在不同机器、进程或应用上同时使用该Token。

  • ExpireTime为此令牌的有效期时间戳,单位:秒。如,1527592757换算为北京时间为2018/5/29 19:19:17,即Token在该时间之前有效,过期需要重新获取。

调用示例(Java)

  1. 添加Java依赖。

    添加阿里云Java SDK的核心库(版本为3.7.1)和fastjson库。

    <dependency>
        <groupId>com.aliyun</groupId>
        <artifactId>aliyun-java-sdk-core</artifactId>
        <version>3.7.1</version>
    </dependency>
    
    <!-- http://mvnrepository.com/artifact/com.alibaba/fastjson -->
    <dependency>
        <groupId>com.alibaba</groupId>
        <artifactId>fastjson</artifactId>
        <version>1.2.83</version>
    </dependency>

  2. 调用服务。

    获取访问令牌的示例代码如下:

    import com.alibaba.fastjson.JSON;
    import com.alibaba.fastjson.JSONObject;
    import com.aliyuncs.CommonRequest;
    import com.aliyuncs.CommonResponse;
    import com.aliyuncs.DefaultAcsClient;
    import com.aliyuncs.IAcsClient;
    import com.aliyuncs.exceptions.ClientException;
    import com.aliyuncs.http.MethodType;
    import com.aliyuncs.http.ProtocolType;
    import com.aliyuncs.profile.DefaultProfile;
    
    import java.text.SimpleDateFormat;
    import java.util.Date;
    
    public class CreateTokenDemo {
    
        // 地域ID
        private static final String REGIONID = "cn-shanghai";
        // 获取Token服务域名
        private static final String DOMAIN = "nls-meta.cn-shanghai.aliyuncs.com";
        // API版本
        private static final String API_VERSION = "2019-02-28";
        // API名称
        private static final String REQUEST_ACTION = "CreateToken";
    
        // 响应参数
        private static final String KEY_TOKEN = "Token";
        private static final String KEY_ID = "Id";
        private static final String KEY_EXPIRETIME = "ExpireTime";
    
    
        public static void main(String args[]) throws ClientException {
    
            String accessKeyId = "此处填写您的AccessKey ID";
            String accessKeySecret = "此处填写您的AccessKey Secret";
    
            // 创建DefaultAcsClient实例并初始化
            DefaultProfile profile = DefaultProfile.getProfile(
                    REGIONID,
                    accessKeyId,
                    accessKeySecret);
    
            IAcsClient client = new DefaultAcsClient(profile);
            CommonRequest request = new CommonRequest();
            request.setDomain(DOMAIN);
            request.setVersion(API_VERSION);
            request.setAction(REQUEST_ACTION);
            request.setMethod(MethodType.POST);
            request.setProtocol(ProtocolType.HTTPS);
    
            CommonResponse response = client.getCommonResponse(request);
            System.out.println(response.getData());
            if (response.getHttpStatus() == 200) {
                JSONObject result = JSON.parseObject(response.getData());
                String token = result.getJSONObject(KEY_TOKEN).getString(KEY_ID);
                long expireTime = result.getJSONObject(KEY_TOKEN).getLongValue(KEY_EXPIRETIME);
                System.out.println("获取到的Token: " + token + ",有效期时间戳(单位:秒): " + expireTime);
                // 将10位数的时间戳转换为北京时间
                String expireDate = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(new Date(expireTime * 1000));
                System.out.println("Token有效期的北京时间:" + expireDate);
            }
            else {
                System.out.println("获取Token失败!");
            }
        }
    }

调用示例(Python)

使用pip安装SDK。

  1. 执行以下命令,通过pip安装Python SDK,版本为2.13.3。

    pip install aliyun-python-sdk-core==2.13.3 # 安装阿里云SDK核心库
  2. 调用服务。

    示例代码如下:

    #! /usr/bin/env python
    # coding=utf-8
    import os
    import time
    import json
    from aliyunsdkcore.client import AcsClient
    from aliyunsdkcore.request import CommonRequest
    
    # 创建AcsClient实例
    client = AcsClient(
       "此处填写您的AccessKey ID",
       "此处填写您的AccessKey Secret",
       "cn-shanghai"
    );
    
    # 创建request,并设置参数。
    request = CommonRequest()
    request.set_method('POST')
    request.set_domain('nls-meta.cn-shanghai.aliyuncs.com')
    request.set_version('2019-02-28')
    request.set_action_name('CreateToken')
    
    try : 
       response = client.do_action_with_exception(request)
       print(response)
    
       jss = json.loads(response)
       if jss.has_key('Token') and jss['Token'].has_key('Id'):
          token = jss['Token']['Id']
          expireTime = jss['Token']['ExpireTime']
          print("token = " + token)
          print("expireTime = " + str(expireTime))
    except Exception as e:
       print(e)

调用示例(GO)

开发前请先安装alibaba-cloud-sdk-go,具体操作请参见安装操作

示例代码如下:

package main
import (
    "fmt"
    "encoding/json"
    "github.com/aliyun/alibaba-cloud-sdk-go/sdk"
    "github.com/aliyun/alibaba-cloud-sdk-go/sdk/requests"
)

type TokenResult struct {
    ErrMsg string
    Token struct {
        UserId      string
        Id          string
        ExpireTime  long
    }
  }

func main() {
    client, err := sdk.NewClientWithAccessKey("cn-shanghai", "此处填写您的AccessKey ID", "此处填写您的AccessKey Secret")
    if err != nil {
        panic(err)
    }
    request := requests.NewCommonRequest()
    request.Method = "POST"
    request.Domain = "nls-meta.cn-shanghai.aliyuncs.com"
    request.ApiName = "CreateToken"
    request.Version = "2019-02-28"
    response, err := client.ProcessCommonRequest(request)
    if err != nil {
        panic(err)
    }
    fmt.Print(response.GetHttpStatus())
    fmt.Print(response.GetHttpContentString())

    var tr TokenResult
    no, err = json.Unmarshal([]byte(response.GetHttpContentString()), &tr)
    if err == nil {
        fmt.Println(tr.Token.Id)
        fmt.Println(tr.Token.ExpireTime)
    } else {
        fmt.Println(err)
    }
}

调用示例(PHP)

安装前请确保环境使用的是PHP 5.5及以上版本,PHP SDK安装方式请参见安装Alibaba Cloud SDK for PHP 

  1. 创建一个全局客户端。

  2. 创建API请求,设置参数。

  3. 发起请求,处理应答或异常。

PHP代码获取访问令牌Token代码示例如下:

<?php
require __DIR__ . '/vendor/autoload.php';
use AlibabaCloud\Client\AlibabaCloud;
use AlibabaCloud\Client\Exception\ClientException;
use AlibabaCloud\Client\Exception\ServerException;
/**
 * 第一步:设置一个全局客户端
 * 使用阿里云RAM账号的AccessKey ID和AccessKey Secret进行鉴权。
 */
AlibabaCloud::accessKeyClient(
            "此处填写您的AccessKey ID",
            "此处填写您的AccessKey Secret")
            ->regionId("cn-shanghai")
            ->asDefaultClient();
try {
    $response = AlibabaCloud::nlsCloudMeta()
                            ->v20180518()
                            ->createToken()
                            ->request();
    print $response . "\n";
    $token = $response["Token"];
    if ($token != NULL) {
        print "Token 获取成功:\n";
        print_r($token);
        print "获取到的token是:" . $token["Id"] ."\n";
        date_default_timezone_set('Asia/Shanghai');
        print "获取到的token过期时间是:" . $token["ExpireTime"] . "\n";
    }
    else {
        print "token 获取失败\n";
    }
} catch (ClientException $exception) {
    // 获取错误消息
    print_r($exception->getErrorMessage());
} catch (ServerException $exception) {
    // 获取错误消息
    print_r($exception->getErrorMessage());
}
说明

上述示例代码是基于阿里云新版PHP SDK进行示例,请参见Alibaba Cloud SDK for PHP。如果您已接入阿里云旧版PHP SDK,参见aliyun-openapi-php-sdk,仍然可以继续使用或者更新到新版SDK。

调用示例(Node.js)

  1. 安装Node.js SDK。

    建议使用npm完成Node.js依赖模块的安装,所有阿里官方的Node.js SDK都位于@alicloud下。

    假设Node.js SDK下载后的路径为/path/to/aliyun-openapi-Node.js-sdk。当基于SDK核心库进行开发时,请执行以下命令安装@alicloud/pop-core模块。

    命令中的--save会将模块写入应用的package.json文件中,作为依赖模块。

     npm install @alicloud/pop-core --save
    说明

    您也可以从GitHub上下载SDK,请参见GitHub下载SDK

  2. 调用服务。

    示例代码如下:

    var RPCClient = require('@alicloud/pop-core').RPCClient;
    
    var client = new RPCClient({
      accessKeyId: '此处填写您的AccessKey ID',
      accessKeySecret: '此处填写您的AccessKey Secret',
      endpoint: 'http://nls-meta.cn-shanghai.aliyuncs.com',
      apiVersion: '2019-02-28'
    });
    
    // => returns Promise
    // => request(Action, params, options)
    client.request('CreateToken').then((result) => {
        console.log(result.Token)
        console.log("token = " + result.Token.Id)
        console.log("expireTime = " + result.Token.ExpireTime)
    });

调用示例(.NET)

  1. 安装.NET SDK。

    获取Token的.NET示例使用了阿里云.NET SDK的CommonRequest用来提交获取Token的请求,采用的是RPC风格的POP API调用。阿里云.NET SDK的详细介绍请参见使用.NET SDK

    .NET SDK CommonRequest的使用方法,请参见使用CommonRequest进行调用

    您只需安装阿里云.NET SDK的核心库。可以选择添加DLL引用或者项目引入任一种方式安装.NET SDK,详细操作步骤请参见使用.NET SDK

  2. 调用服务。

    示例代码如下:

    using System;
    using Aliyun.Acs.Core;
    using Aliyun.Acs.Core.Exceptions;
    using Aliyun.Acs.Core.Profile;
    class Sample
    {
        static void Main(string[] args)
        {
            // 构建一个客户端实例,用于发起请求。
            IClientProfile profile = DefaultProfile.GetProfile(
                "cn-shanghai",
                "<yourAccessKey Id>",
                "<yourAccessKey Secret>");
            DefaultAcsClient client = new DefaultAcsClient(profile);
    
            try
            {
                // 构造请求
                CommonRequest request = new CommonRequest();
                request.Domain = "nls-meta.cn-shanghai.aliyuncs.com";
                request.Version = "2019-02-28";
    
                // 因为是RPC风格接口,需指定ApiName(Action)。
                request.Action = "CreateToken";
    
                // 发起请求,并得到响应。
                CommonResponse response = client.GetCommonResponse(request);
                System.Console.WriteLine(response.Data);
            }
            catch (ServerException ex)
            {
                System.Console.WriteLine(ex.ToString());
            }
            catch (ClientException ex)
            {
                System.Console.WriteLine(ex.ToString());
            }
        }
    }

常见问题

在获取Token过程中,可能会出现各种异常问题,整体的排查思路如下:

  1. 您可以根据错误码以及错误信息在阿里云官方的错误代码表中找到对应错误含义及解决方案。例如,使用一个不存在的AccessKeyId调用服务获取Token时,可能返回如下结果:

    {
      "RequestId":"F5805076-38C5-5093-B5BD-9176ECD9CBBD",
      "Message":"Specified access key is not found.",
      "Recommend":"https://next.api.aliyun.com/troubleshoot?q=InvalidAccessKeyId.NotFound&amp;product=nls-cloud-meta",
      "HostId":"nls-meta.cn-shanghai.aliyuncs.com",
      "Code":"InvalidAccessKeyId.NotFound"
    }

    错误代码表搜索该段代码中错误信息的关键字,例如,InvalidAccessKeyId.NotFoundSpecified access key is not found,可以获取相关错误码详情。错误码

  2. 您也可以在阿里云OpenAPI诊断中心页面输入错误信息,查找解决方案。

    api诊断

阿里云首页 智能语音交互 相关技术圈