JavaScript

操作场景

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

JavaScript SDK支持Node.js、浏览器等运行环境。

关于开发环境搭建，本章节以IntelliJ IDEA 2018.3.5版本、搭建Node.js环境为例。浏览器等，只提供代码示例说明。

准备环境

已获取API的域名、请求url、请求方法、AppKey和AppSecret等信息，具体参见认证前准备。
获取并安装Nodejs安装包，如果未安装，请至Nodejs官方下载页面下载。
获取并安装IntelliJ IDEA，如果未安装，请至IntelliJ IDEA官方网站下载。
已在IntelliJ IDEA中安装NodeJS插件，如果未安装，请按照图1所示安装。
图1 安装NodeJS插件

获取SDK

请登录API网关控制台，参考《用户指南》的“SDK”章节，进入SDK页面并下载SDK。

获取“ApiGateway-javascript-sdk.zip”压缩包，解压后目录结构如下：

名称	说明
signer.js	SDK代码
node_demo.js	Nodejs示例代码
demo.html	浏览器示例代码
demo_require.html	浏览器示例代码（使用require加载）
test.js	测试用例
js\hmac-sha256.js	依赖库
licenses\license-crypto-js	第三方库license文件
licenses\license-node	第三方库license文件

创建工程

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

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

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

图3 选择解压后JavaScript的SDK路径
完成工程创建后，目录结构如下。

图4 新建工程JavaScript的目录结构
- node_demo.js：Nodejs示例代码，请根据实际情况修改参数后使用。具体代码说明请参考调用API（Node.js）示例。
- demo.html：浏览器示例代码，请根据实际情况修改参数后使用。具体代码说明请参考调用API（浏览器）示例。
单击“Edit Configurations”，弹出“Run/Debug Configurations”对话框。

图5 Click Edit Configurations
单击“+”，选择“Node.js”。

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

图7 选择node_demo.js

调用API（Node.js）示例

在工程中引入signer.js。

1 2	var signer = require('./signer') var http = require('http')

生成一个新的Signer，填入AppKey和AppSecret。

1
2
3

var sig = new signer.Signer()
sig.Key = "4f5f626b-073f-402f-a1e0-e52171c6100c"
sig.Secret = "******"

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

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

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

r.headers = { "x-stage":"RELEASE" }
进行签名，执行此函数会生成请求参数，用于创建http(s)请求，请求参数中添加了用于签名的X-Sdk-Date头和Authorization头。
1

var opt = sig.Sign(r)

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

var req=http.request(opt, 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，具体步骤请参见《API网关用户指南》的“开启跨域访问 ”章节创建OPTIONS方式的API，且返回头中带有“Access-Control-Allow-*”相关访问控制头域，可在创建API时通过开启CORS来添加这些头域。

在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>

进行签名和访问。

var sig = new signer.Signer()
sig.Key = "4f5f626b-073f-402f-a1e0-e52171c6100c"
sig.Secret = "******"
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 opt = 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
});