JavaScript
操作场景
使用JavaScript语言调用APP认证的API时,您需要先获取SDK,然后新建工程,最后参考API调用示例调用API。
本章节以IntelliJ IDEA 2018.3.5版本、搭建Node.js开发环境为例介绍。
准备环境
- 已获取API的域名、请求url、请求方法、AppKey和AppSecret等信息,具体参见认证前准备。
- 获取并安装Nodejs安装包,如果未安装,请至Nodejs官方网站下载。
Nodejs安装后,在命令行中,用npm安装“moment”和“moment-timezone”模块。
npm install moment --save npm install moment-timezone --save
- 获取并安装IntelliJ IDEA,如果未安装,请至IntelliJ IDEA官方网站下载。
- 已在IntelliJ IDEA中安装NodeJS插件,如果未安装,请按照图1所示安装。
获取SDK
- 登录DataArts Studio控制台。
- 单击“数据服务”模块。
- 单击左侧菜单“专享版 > SDK”。
- 单击SDK使用引导区域里对应语言的SDK,下载SDK包到本地。
- 进行SDK包完整性校验。Windows操作系统下,打开本地命令提示符框,输入如下命令,在本地生成已下载SDK包的SHA256值,其中,“D:\java-sdk.zip”为SDK包的本地存放路径和SDK包名,请根据实际情况修改。
certutil -hashfile D:\java-sdk.zip SHA256
命令执行结果示例,如下所示:
SHA256 的 D:\java-sdk.zip 哈希: 3a86f1ba249a00727db506e4075ec9630e6cf74f312bddf6c3901c9d0786f53e CertUtil: -hashfile 命令成功完成。 3a86f1ba249a00727db506e4075ec9630e6cf74f312bddf6c3901c9d0786f53e
对比所下载SDK包的SHA256值和下表中对应语言SDK包的SHA256值。如果一致,则表示下载过程不存在篡改和丢包。
表1 SDK包及对应的SHA256值 不同语言SDK包
SHA256值
Java
3a86f1ba249a00727db506e4075ec9630e6cf74f312bddf6c3901c9d0786f53e
Go
23734867eae2e7ef61427c64aa33aa89512571946f2f43a1a5fef5e801e3129f
Python
57636d8bacc459cab9dc08c70d01ccc42391ace60e6960c4e947566da1dc5d26
C#
e5a3b677f75c28ba3f1e16645d8171f7b6f34a42143f8a32a68bb18719b5e65d
JavaScript
442ac2fcb41d84525dc0139ec3f05d190e4e337cdbcdfdfc82a09d79d2ecd25e
PHP
2cc76bd2ecd48f00899d18b0f76d05ce2623065180f111c3f70ac14ddf0506f3
C++
2a54c3f2486d562ea6af1384eca40b301918bdc02f98bbf2c114f282dc059c00
C
4957556c108e0174d55b4b8d720f296967a9367ca54010792b1b3de039b87363
Android
0fdcc6fd93a68dce5c3e1b8e6370cc9340429cabfb0f268c3f9e5ea05238ae96
获取“ApiGateway-javascript-sdk.zip”压缩包,解压后目录结构如下:
名称 |
说明 |
---|---|
signer.js |
SDK代码 |
node_demo.js |
Nodejs示例代码 |
demo.html |
浏览器示例代码 |
demo_require.html |
浏览器示例代码(使用require加载) |
test.js |
测试用例 |
js\hmac-sha256.js |
依赖库 |
js\moment.min.js |
|
js\moment-timezone-with-data.min.js |
|
licenses\license-crypto-js |
第三方库license文件 |
licenses\license-moment |
|
licenses\license-moment-timezone |
|
licenses\license-node |
创建工程
- 打开IntelliJ IDEA,选择菜单“File > New > Project”。
弹出“New Project”对话框。选择“Static Web”,单击“Next”。
图2 New Project
- 单击“...”,在弹出的对话框中选择解压后的SDK路径,单击“Finish”。
图3 选择解压后的SDK路径
- 完成工程创建后,目录结构如下。
图4 新建工程的目录结构
- node_demo.js:Nodejs示例代码,请根据实际情况修改参数后使用。具体代码说明请参考调用API(Node.js)示例。
- 单击“Edit Configurations”,弹出“Run/Debug Configurations”对话框。
图5 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 4 5 6 7 8
// 认证用的ak和sk编码到代码中或者明文存储都有很大的安全风险,建议在配置文件或者环境变量中密文存放,使用时解密,确保安全; // 本示例以ak和sk保存在环境变量中来实现身份验证为例,运行本示例前请先在本地环境中设置环境变量SDK_AK和SDK_SK。 var ak = process.env.SDK_AK; var sk = process.env.SDK_SK; var sig = new signer.Signer(); sig.Key = ak; sig.Secret = sk;
- 生成一个Request对象,指定方法名、请求uri和body。
1 2
var r = new signer.HttpRequest("POST", "{apig-endpoint}/app1?a=1"); r.body = '{"a":1}'
- 给请求添加header头,内容为具体参数数据。如有需要,添加需要签名的其他头域。
1
r.headers = { "x-stage":"RELEASE", "name":"value"}
- 进行签名,执行此函数会生成请求参数,用于创建http(s)请求,请求参数中添加了用于签名的X-Sdk-Date头和Authorization头。然后为请求参数添加x-Authorization头,值与Authorization头相同。
1 2
var opt = sig.Sign(r) opt.headers["x-Authorization"] = opt.headers["Authorization"]
- 访问API,查看访问结果。如果使用https访问,则将“http.request”改为“https.request”。
1 2 3 4 5 6 7 8 9 10 11
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()