JavaScript SDK使用说明

操作场景

使用JavaScript语言调用APP认证的API时，您需要先获取SDK，然后新建工程，最后参考API调用示例调用API。

JavaScript SDK支持Node.js和浏览器两种运行环境。

本章节以IntelliJ IDEA 2018.3.5版本、搭建Node.js开发环境为例介绍。

准备环境

• 已获取API的域名、请求url、请求方法、集成应用的Key和Secret（或客户端的AppKey和AppSecret）等信息，具体参见认证前准备。
• 浏览器版本为chrome 89.0 或以上版本。
• 获取并安装15.10.0及以上版本的Nodejs安装包，如果未安装，请至Nodejs官方下载页面下载。

  Nodejs安装后，在命令行中，用npm安装“moment”和“moment-timezone”模块。

  npm install moment --save
  npm install moment-timezone --save

• 获取并安装2018.3.5或以上版本的IntelliJ IDEA，如果未安装，请至IntelliJ IDEA官方网站下载。
• 已在IntelliJ IDEA中安装NodeJS插件，如果未安装，请按照图1所示安装。
  图1 安装NodeJS插件
  

获取SDK

请登录ROMA Connect实例控制台，在“服务集成 APIC > API调用”页面中下载SDK。解压后目录结构如下：

创建工程

1. 打开IntelliJ IDEA，选择菜单“File > New > Project”。

   弹出“New Project”对话框。选择“Static Web”，单击“Next”。

   图2 New Project
   

2. 单击“...”，在弹出的对话框中选择解压后的SDK路径，单击“Finish”。
   图3 选择解压后的SDK路径
   

3. 完成工程创建后，目录结构如下。
   图4 新建工程的目录结构
   
   • node_demo.js：Nodejs示例代码，请根据实际情况修改参数后使用。具体代码说明请参考调用API（Node.js）示例。
   • demo.html：浏览器示例代码，请根据实际情况修改参数后使用。具体代码说明请参考调用API（浏览器）示例。

4. 单击“Edit Configurations”，弹出“Run/Debug Configurations”对话框。
   图5 Edit Configurations
   

5. 单击“+”，选择“Node.js”。
   图6 选择Node.js
   

6. “JavaScript file”选择“node_demo.js”，单击“OK”，完成配置。
   图7 选择node_demo.js
   

调用API（Node.js）示例

1. 在工程中引入signer.js。

   var signer = require('./signer')
   var https = require('https')

2. 生成一个新的Signer，填入AppKey和AppSecret。
   1. 本示例以AK和SK保存在环境变量中为例，运行本示例前请先在本地环境中设置环境变量CLOUD_SDK_AK和CLOUD_SDK_SK。以Linux系统为例在本地将已获取的AK/SK设置为环境变量。
      1. 打开终端，输入以下命令打开环境变量配置文件。

         vi ~/.bashrc

      2. 设置环境变量，保存文件并退出编辑器。

         export CLOUD_SDK_AK="已获取AK值" 
         export CLOUD_SDK_SK="已获取SK值" 

      3. 输入以下命令使配置文件生效。

         source ~/.bashrc

   2. 生成一个新的Signer，填入已设置的环境变量。

      var sig = new signer.Signer()
      sig.Key = process.env.CLOUD_SDK_AK
      sig.Secret = process.env.CLOUD_SDK_SK

3. 生成一个Request对象，指定方法名、请求uri和body。

   var r = new signer.HttpRequest("POST", "c967a237-cd6c-470e-906f-a8655461897e.apigw.exampleRegion.com/app1?a=1");
   r.body = '{"a":1}'

4. 给请求添加x-stage头，内容为环境名。如有需要，添加需要签名的其他头域。

   r.headers = { "x-stage":"RELEASE" }

5. 进行签名，执行此函数会生成请求参数，用于创建http(s)请求，请求参数中添加了用于签名的X-Sdk-Date头和Authorization头。

   var opts = sig.Sign(r)

6. 访问API，查看访问结果。如果使用https访问，则将“http.request”改为“https.request”。

   var req=http.request(opts, function(res){
           console.log(res.statusCode)  
           res.on("data",	function(chunk){
   		console.log(chunk.toString())
   	})
   })
   req.on("error",function(err){
   	console.log(err.message)
   })
   req.write(r.body)
   req.end()

调用API（浏览器）示例

使用浏览器访问API，需要注册支持OPTIONS方法的API，具体步骤请参见创建OPTIONS方式的API，且返回头中带有“Access-Control-Allow-*”相关访问控制头域，可在创建API时通过开启CORS来添加这些头域。

1. 由于浏览器限制从页面脚本内发起跨域请求，因此浏览器访问API前需要在API网关控制台上创建一个跨域共享策略，允许浏览器向跨域服务器发送XMLHttpRequest请求，并为跨域共享策略绑定API。
   创建策略请参考《API网关用户指南》的“跨域共享策略说明”章节，绑定API请参考《API网关用户指南》的“创建策略并绑定API”章节。

   图8 创建跨域共享策略示例
   

2. 使用浏览器访问API，需要创建支持OPTIONS方法的API，具体步骤请参见《API网关用户指南》的“开启跨域访问 ”章节创建OPTIONS方式的API。且返回头中带有“Access-Control-Allow-*”相关访问控制头域，可在创建API时通过开启CORS来添加这些头域。
3. 在html中引入signer.js及依赖。

   <script src="js/hmac-sha256.js"></script>
   <script src="js/moment.min.js"></script>
   <script src="js/moment-timezone-with-data.min.js"></script>
   <script src='signer.js'></script>

4. 进行签名和访问。
   1. 本示例以AK和SK保存在环境变量中为例，运行本示例前请先在本地环境中设置环境变量CLOUD_SDK_AK和CLOUD_SDK_SK。以Linux系统为例在本地将已获取的AK/SK设置为环境变量。
      1. 打开终端，输入以下命令打开环境变量配置文件。

         vi ~/.bashrc

      2. 设置环境变量，保存文件并退出编辑器。

         export CLOUD_SDK_AK="已获取AK值" 
         export CLOUD_SDK_SK="已获取SK值" 

      3. 输入以下命令使配置文件生效。

         source ~/.bashrc

   2. 填入已设置的环境变量，进行签名和访问。

      var sig = new signer.Signer()
      sig.Key = getenv('CLOUD_SDK_AK')
      sig.Secret = getenv('CLOUD_SDK_SK')
      var r= new signer.HttpRequest()
      r.host = "c967a237-cd6c-470e-906f-a8655461897e.apigw.exampleRegion.com"
      r.method = "POST"
      r.uri = "/app1"
      r.body = '{"a":1}'
      r.query = { "a":"1","b":"2" }
      r.headers = { "Content-Type":"application/json" }
      var opts = sig.Sign(r)
      var scheme = "https"
      $.ajax({
      	type: opts.method,
      	data: req.body,
      	processData: false,
      	url: scheme + "://" + opts.hostname + opts.path,
      	headers: opts.headers,
      	success: function (data) {
      		$('#status').html('200')
      		$('#recv').html(data)
      	},
      	error: function (resp) {
      		if (resp.readyState === 4) {
      			$('#status').html(resp.status)
      			$('#recv').html(resp.responseText)
      		} else {
      			$('#status').html(resp.state())
      		}
      	},
      	timeout: 1000
      });