Obtain a token using an SDK

Background information

Prerequisites

• Obtain an AccessKey ID and an AccessKey Secret. For more information, see Get started.

• Before calling the API, configure environment variables for your access credentials. The environment variables for the AccessKey ID and AccessKey Secret of Intelligent Speech Interaction are ALIYUN_AK_ID and ALIYUN_AK_SECRET.

Obtain a token with the Intelligent Speech Interaction SDK

Example (Java)

Download the latest version of the SDK from the Maven repository, and download the demo source code ZIP package.

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

The following example shows how to obtain an access token in Java:

AccessToken accessToken = new AccessToken(System.getenv().get("ALIYUN_AK_ID"), System.getenv().get("ALIYUN_AK_SECRET"));
accessToken.apply();
String token = accessToken.getToken();
long expireTime = accessToken.getExpireTime();

• The token is allocated by the server. You can use this token until it expires. The token can be used concurrently on different machines, processes, or applications.

• The expireTime is a timestamp that indicates when the token expires, in seconds. For example, 1527592757 corresponds to 2018-05-29 19:19:17 (UTC+8). The token is valid until this time. After the token expires, you must obtain a new one.

Example (C++)

1. Download the C++ Token SDK.

2. Compile the demo.

   Assume that the demo files are extracted to the path/to directory. Run the following commands in sequence in a Linux terminal to compile and run the program.

   • If your development environment supports compilation with CMake:

     1. Make sure that CMake 2.4 or later is installed on your system.

     2. Change the directory: cd path/to/sdk/lib.

     3. Extract the file: tar -zxvpf linux.tar.gz.

     4. Change the directory: cd path/to/sdk.

     5. Run the build script: ./build.sh.

     6. Change the directory: cd path/to/sdk/demo.

     7. Run the token demo: ./tokenDemo <yourAccessKeySecret> <yourAccessKeyId>.

   • If your development environment does not support compilation with CMake:

     1. Change the directory: cd path/to/sdk/lib.

     2. Extract the file: tar -zxvpf linux.tar.gz.

     3. Change the directory: cd path/to/sdk/demo.

     4. Compile the demo program by using the g++ command: 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. Specify the library path: export LD_LIBRARY_PATH=path/to/sdk/lib/linux/.

     6. Run the token demo: ./tokenDemo <yourAccessKeySecret> <yourAccessKeyId>.

3. Call the service.

   The following example shows how to obtain an access token in C++:

   #include <iostream>
   #include "Token.h"
   using std::cout;
   using std::endl;
   using namespace AlibabaNlsCommon;
   // Obtain the access token.
   int getTokenId(const char* keySecret, const char* keyId) {
       NlsToken nlsTokenRequest;
       /* Set the AccessKey Secret of your Alibaba Cloud account. */
       nlsTokenRequest.setKeySecret(getenv("ALIYUN_AK_SECRET"));
       /* Set the AccessKey ID of your Alibaba Cloud account. */
       nlsTokenRequest.setAccessKeyId(getenv("ALIYUN_AK_ID"));
       /* Obtain the token. The method returns 0 on success and -1 on failure. */
       if (-1 == nlsTokenRequest.applyNlsToken()) {
           cout << "Failed: " << nlsTokenRequest.getErrorMsg() << endl; /* Get the error message. */
           return -1;
       } else {
           cout << "TokenId: " << nlsTokenRequest.getToken() << endl; /* Get the token. */
           cout << "TokenId expireTime: " << nlsTokenRequest.getExpireTime() << endl; /* Get the Unix timestamp (in seconds) for the token's expiration. */
           return 0;
       }
   }

Example (Java)

1. Add Java dependencies.

   Add the Alibaba Cloud SDK for Java core library (version 3.7.1) and the FastJSON library.

   <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. Call the service.

   The following example shows how to obtain an access token:

   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 {
       // Region ID
       private static final String REGIONID = "cn-shanghai";
       // Access domain name for the token service
       private static final String DOMAIN = "nls-meta.cn-shanghai.aliyuncs.com";
       // API version
       private static final String API_VERSION = "2019-02-28";
       // API name
       private static final String REQUEST_ACTION = "CreateToken";
       // Response parameters
       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 = System.getenv().get("ALIYUN_AK_ID");
           String accessKeySecret = System.getenv().get("ALIYUN_AK_SECRET");
           // Create and initialize a DefaultAcsClient instance.
           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("Obtained Token: " + token + ", ExpireTime (in seconds): " + expireTime);
               // Convert the 10-digit timestamp to UTC+8.
               String expireDate = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(new Date(expireTime * 1000));
               System.out.println("Token expiration time (UTC+8):" + expireDate);
           }
           else {
               System.out.println("Failed to obtain the token!");
           }
       }
   }

Example (Python)

Use pip to install the SDK.

1. Run the following command to install the Python SDK (version 2.15.1) by using pip.

   pip install aliyun-python-sdk-core==2.15.1 # Install the core library of the Alibaba Cloud SDK.

2. Call the service.

   The following code provides an example:

   #! /usr/bin/env python
   # coding=utf-8
   import os
   import time
   import json
   from aliyunsdkcore.client import AcsClient
   from aliyunsdkcore.request import CommonRequest
   # Create an AcsClient instance.
   client = AcsClient(
      os.getenv('ALIYUN_AK_ID'),
      os.getenv('ALIYUN_AK_SECRET'),
      "cn-shanghai"
   )
   # Create a request and set the parameters.
   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 'Token' in jss and 'Id' in jss['Token']:
         token = jss['Token']['Id']
         expireTime = jss['Token']['ExpireTime']
         print("token = " + token)
         print("expireTime = " + str(expireTime))
   except Exception as e:
      print(e)

Example (Go)

Before you start, install alibaba-cloud-sdk-go. For more information, see Installation.

The following code provides an example:

package main
import (
    "fmt"
    "os"
    "encoding/json"
    "github.com/aliyun/alibaba-cloud-sdk-go/sdk"
    "github.com/aliyun/alibaba-cloud-sdk-go/sdk/requests"
    "github.com/aliyun/alibaba-cloud-sdk-go/sdk/credentials"
)
type TokenResult struct {
    ErrMsg string
    Token struct {
        UserId      string
        Id          string
        ExpireTime  int64
    }
  }
func main() {
    config := sdk.NewConfig()
    credential := credentials.NewAccessKeyCredential(os.Getenv("ALIYUN_AK_ID"), os.Getenv("ALIYUN_AK_SECRET"))
    client, err := sdk.NewClientWithOptions("cn-shanghai", config, credential)
    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
    err = json.Unmarshal([]byte(response.GetHttpContentString()), &tr)
    if err == nil {
        fmt.Println(tr.Token.Id)
        fmt.Println(tr.Token.ExpireTime)
    } else {
        fmt.Println(err)
    }
}

Example (PHP)

Make sure that your environment uses PHP 7.2 or later. For information about how to install the PHP SDK, see Install Alibaba Cloud SDK for PHP .

1. Create a global client.

2. Create an API request and set the parameters.

3. Send the request and process the response or exception.

The following code provides an example of how to obtain an access token in PHP:

<?php
require __DIR__ . '/vendor/autoload.php';
use AlibabaCloud\Client\AlibabaCloud;
use AlibabaCloud\Client\Exception\ClientException;
use AlibabaCloud\Client\Exception\ServerException;
/**
 * Step 1: Set a global client.
 * Use the AccessKey ID and AccessKey Secret of an Alibaba Cloud RAM account for authentication.
 */
AlibabaCloud::accessKeyClient(
            getenv('ALIYUN_AK_ID'),
            getenv('ALIYUN_AK_SECRET'))
            ->regionId("cn-shanghai")
            ->asDefaultClient();
try {
    $response = AlibabaCloud::nlsCloudMeta()
                            ->v20180518()
                            ->createToken()
                            ->request();
    print $response . "\n";
    $token = $response["Token"];
    if ($token != NULL) {
        print "Token obtained successfully:\n";
        print_r($token);
        print "The obtained token is: " . $token["Id"] ."\n";
        date_default_timezone_set('Asia/Shanghai');
        print "The token expires at: " . $token["ExpireTime"] . "\n";
    }
    else {
        print "Failed to obtain the token.\n";
    }
} catch (ClientException $exception) {
    // Obtain the error message.
    print_r($exception->getErrorMessage());
} catch (ServerException $exception) {
    // Obtain the error message.
    print_r($exception->getErrorMessage());
}

Example (Node.js)

1. Install the Node.js SDK.

   We recommend that you use npm to install the Node.js dependency modules. All official Alibaba Cloud Node.js SDKs are under @alicloud.

   Assume that the Node.js SDK is downloaded to the /path/to/aliyun-openapi-Node.js-sdk directory. When you develop based on the core SDK library, run the following command to install the @alicloud/pop-core module.

   The --save flag saves the module as a dependency in the application's package.json file.

    npm install @alicloud/pop-core --save

   Note

   You can also download the SDK from GitHub. For more information, see Download the SDK from GitHub.

2. Call the service.

   The following code provides an example:

   var RPCClient = require('@alicloud/pop-core').RPCClient;
   var client = new RPCClient({
     accessKeyId: process.env.ALIYUN_AK_ID,
     accessKeySecret: process.env.ALIYUN_AK_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)
   });

FAQ

You may encounter errors when obtaining a token. Use this procedure for general troubleshooting:

1. Use the error code and message to find solutions in the official Alibaba Cloud error code table. For example, if you call the service to obtain a token using a non-existent AccessKey ID, the following result may be returned:

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

   Search for keywords from the error message, such as InvalidAccessKeyId.NotFound and Specified access key is not found, in the error code table to find the details of the error code. The HTTP status code for this error is 404. To resolve this issue, check whether a valid AccessKey ID is passed in the call.

2. You can also find a solution by entering the error message on the Alibaba Cloud OpenAPI Diagnostic Center page.

   Take InvalidAccessKeyId.NotFound as an example. The diagnosis is a credential error. This error occurs because the API rejects the request due to an invalid or disabled client credential. To resolve this issue, check your credential for any spaces. Log on to the AccessKey Management page in the Alibaba Cloud console at https://usercenter.console.aliyun.com/#/manage/ak. Confirm that the AccessKey ID exists and is enabled. If the AccessKey ID is disabled, enable it. If it does not exist, create a new one.

Related documentation

You can also obtain a token using the following methods:

• Obtain a token using the console

• Obtain a token using OpenAPI Explorer