文档首页 > > 开发指南> 使用APP认证调用API> JavaScript

JavaScript

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

操作场景

使用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

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

创建工程

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

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

    图2 New Project

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

    图3 选择解压后的SDK路径

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

    图4 新建工程的目录结构

  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。

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

  2. 生成一个新的Signer,填入AppKey和AppSecret。

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

  3. 生成一个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}'
    

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

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

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

    1
    var opt = sig.Sign(r)
    

  6. 访问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()
    

调用API(浏览器)示例

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

  1. 在html中引入signer.js及依赖。

    1
    2
    3
    4
    <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>
    

  2. 进行签名和访问。

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    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
    });
    

调用API(微信小程序)示例

  1. 下载微信小程序示例工程
  2. 下载微信开发者工具,使用开发工具打开示例工程,如下图所示。

  3. 示例工程中详细说明了微信小程序中签名的使用方法,下面是其中的关键代码。

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    var req = new signer.HttpRequest("POST", "https://30030113-3657-4fb6-a7ef-90764239b038.apigw.exampleRegion.com/app1?a=1", {}, "body")
    var sig = new signer.Signer();
    sig.Key = "071fe245-9cf6-4d75-822d-c29945a1e06a"
    sig.Secret = "******"
    var opts = sig.Sign(req);
    wx.request({
        url: "https://" + opts.hostname + opts.path,
        data: req.body,
        header: opts.headers,
        method: opts.method,
        success: function (res) {
           console.log(res)
        }
    })
    

分享:

    相关文档

    相关产品

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

提交成功!非常感谢您的反馈,我们会继续努力做到更好!
反馈提交失败,请稍后再试!

*必选

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

字符长度不能超过200

提交反馈 取消

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

智能客服提问云社区提问