文档首页 > > API签名指南> 签名SDK与demo> JavaScript

JavaScript

分享
更新时间: 2019/08/06 GMT+08:00

本节以IntelliJ IDEA工具为例,介绍如何在Js环境中集成API请求签名的SDK。您可以直接导入示例工程体验,然后参考调用说明部分将签名SDK集成到您的应用中。

我们以搭建Node.js开发环境为例介绍JavaScript的SDK集成。

准备环境

  • 获取并安装IntelliJ IDEA,可至IntelliJ IDEA官方网站下载。
  • 获取并安装Nodejs安装包,可至Nodejs官方下载页面下载。
    NodeJs安装后,在命令行中,用npm安装“moment”和“moment-timezone”模块。
    npm install moment --save
    npm install moment-timezone --save
  • 在IDEA中安装Nodejs插件,如下图所示。

获取SDK

请访问https://obs.cn-north-1.myhuaweicloud.com/apig-sdk/APIGW-javascript-sdk.zip下载SDK。

下载“APIGW-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

创建工程

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

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

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

  3. 完成工程创建后,目录结构如下。

  4. 在IDEA窗口右上方,单击“Edit Configurations”或“Add Configurations”。

  5. 单击“+”,选择“Node.js”。

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

API调用(Node.js)

  1. 在命令行中,用npm安装“moment”和“moment-timezone”模块。

    1
    2
    npm install moment --save
    npm install moment-timezone --save
    

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

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

  3. 生成一个新的Signer,填入“Key”和“Secret”。

    1
    2
    3
    var sig = new signer.Signer()
    sig.Key = "QTWAOYT*******QVKYUC"
    sig.Secret = "MFyfvK41ba2giqM7**********KGpownRZlmVmHc"
    

  4. 生成一个新的Request,指定域名、方法名、请求uri和body。

    1
    2
    3
    4
    5
    //The following example shows how to set the request URL and parameters to query a VPC list.
    var r = new signer.HttpRequest("GET", "service.region.example.com/v1/77b6a44cba5143ab91d13ab9a8ff44fd/vpcs?limie=1");
    
    //Add a body if you have specified the PUT or POST method. Special characters, such as the double quotation mark ("), contained in the body must be escaped.
    r.body = '';
    

  5. 添加需要签名的其他头域,或者其他用途的头域,如多项目场景中添加X-Project-Id,或者全局服务场景中添加X-Domain-Id。

    1
    2
    //Add header parameters, for example, X-Domain-Id for invoking a global service and X-Project-Id for invoking a project-level service.
    r.headers = {"Content-Type": "application/json"};
    

  6. 进行签名,执行此函数会生成请求参数,用于创建https请求,请求参数中添加了用于签名的X-Sdk-Date头和Authorization头。

    1
    var opt = sig.Sign(r)
    

  7. 访问API,查看访问结果。

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    var req = https.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()
    

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

跳转到云社区