更新时间:2024-06-12 GMT+08:00

curl

操作场景

使用curl命令调用APP认证的API时,您需要先下载JavaScript SDK生成curl命令,然后将curl命令复制到命令行调用API。

前提条件

已获取API的域名、请求url、请求方法、AppKey和AppSecret等信息,具体参见认证前准备

获取SDK

  1. 登录DataArts Studio控制台。
  2. 单击“数据服务”模块。
  3. 单击左侧菜单“专享版 > SDK”。
  4. 单击SDK使用引导区域里对应语言的SDK,下载SDK包到本地。
  5. 进行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

调用API示例

  1. 使用JavaScript SDK生成curl命令。

    获取“ApiGateway-javascript-sdk.zip”压缩包并解压。在浏览器中打开demo.html,页面如下图所示。

  2. 填入Key、Secret、方法名、请求协议、域名和url(认证用的ak和sk编码到代码中或者明文存储都有很大的安全风险,建议在配置文件或者环境变量中密文存放,使用时解密,确保安全)。本示例从前端输入,仅用于演示,例如:

    1
    2
    3
    4
    Key=4f5f626b-073f-402f-a1e0-e52171c6100c
    Secret=******
    Method=POST
    Url=https://{apig-endpoint}
    

  3. 填入json格式的Query和Headers,填入Body。其中所访问API的ID为必填项,需要填入具体的ID信息,以参数"x-api-id"填入Headers中。
  4. 单击“Send request”,生成curl命令。

    $ curl -X POST "https://{apig-endpoint}/" -H "X-Sdk-Date: 20180530T115847Z" -H "Authorization: SDK-HMAC-SHA256 Access=071fe245-9cf6-4d75-822d-c29945a1e06a, SignedHeaders=host;x-sdk-date, Signature=9e5314bd156d517******dd3e5765fdde4" -d ""

  5. 为命令添加x-Authorization头,值与Authorization头相同。将curl命令复制到命令行,访问API。

    $ curl -X POST "https://{apig-endpoint}/" -H "X-Sdk-Date: 20180530T115847Z" -H "Authorization: SDK-HMAC-SHA256 Access=071fe245-9cf6-4d75-822d-c29945a1e06a, SignedHeaders=host;x-sdk-date, Signature=9e5314bd156d517******dd3e5765fdde4" -H "X-Authorization: SDK-HMAC-SHA256 Access=071fe245-9cf6-4d75-822d-c29945a1e06a, SignedHeaders=host;x-sdk-date, Signature=9e5314bd156d517******dd3e5765fdde4" -d ""
    Congratulations, sdk demo is running