Help Center/ DataArts Studio/ SDK Reference/ DataArts DataService SDK Reference/ Calling APIs Through App Authentication/ curl
Updated on 2023-05-24 GMT+08:00
View PDF

curl

Scenarios

To use the curl command to call an API through App authentication, download the JavaScript SDK to generate the curl command, and copy the command to the CLI to call the API.

Prerequisites

You have obtained the domain name, request URL, and request method of the API to be called, and the AppKey and AppSecret of the App for calling the API. For more information, see Preparation.

Obtaining the SDK

  1. Log in to the DataArts Studio console.
  2. Click DataArts DataService.
  3. In the navigation pane, choose DataArts DataService Exclusive > SDKs.
  4. On the SDKs page, download the SDK package.
  5. Verify integrity of the SDK package. In Windows, open the CLI and run the following command to generate the SHA-256 value of the downloaded SDK package. In the command, D:\java-sdk.zip is an example local path and name of the SDK package. Replace it with the actual value. 

    certutil -hashfile D:\java-sdk.zip SHA256

    The following is an example command output:

    SHA-256 hash value of D:\java-sdk.zip
a7c0195ebf297f29ab0065da16d7e84f14911de177e6e0c8dbadf3464d12b75f
CertUtil: -hashfile command executed.

    Compare the SHA-256 value of the downloaded SDK package with that provided in the following table. If they are the same, no tampering or packet loss occurred during the package download.

    Language

    SHA-256 Value of the SDK Package

    Java

    a7c0195ebf297f29ab0065da16d7e84f14911de177e6e0c8dbadf3464d12b75f

    Go

    caf22350181a4ecd49dc0d3f56097b10c1794792adae407140950be4ed9b6771

    Python

    c80b9ef282fc88d3fb16db4cb9d7525d3db71f7989782ed0b636920ea2fadb93

    C#

    b0e69ef60a561c54c1b86c3447ca855088a1fa2a672fbfba618aaf56b2841e8a

    JavaScript

    c64e595651de079766e446ce2c3262013256f81683bb9434bee27bed3a4caf01

    PHP

    e2eba2cae72aea794edb4057ed8eb7cb82f0dbaccabf9c5539694a7a7a9f3c89

    C++

    c173f59d816aba53f47750cf5ffdc65cc345b1613974b3d2a545ace48787f577

    C

    e4f22beb7b132fe6e57c9de79f596c3ff830228cd7221b02ca96198e501c642c

    Android

    d6c3032801ac88cf8cbc51f64d42457174447c8d159f34a187c036913b31ea2b

Obtain the ApiGateway-javascript-sdk.zip package. The following table shows the files decompressed from the package.

Name

Description

signer.js

SDK code

node_demo.js

Node.js sample code

demo.html

Browser sample code

demo_require.html

Browser sample code (loaded using require)

test.js

Test cases

js\hmac-sha256.js

Dependency libraries

js\moment.min.js

js\moment-timezone-with-data.min.js

licenses\license-crypto-js

Third-party library license files

licenses\license-moment

licenses\license-moment-timezone

licenses\license-node

API Calling Example

  1. Use the JavaScript SDK to generate the curl command.

    Obtain and decompress ApiGateway-javascript-sdk.zip. Open demo.html in a browser. The following figure shows the demo page.

  2. Specify the key, secret, method, protocol, domain name, and URL. For example: 

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

  3. Specify query and header parameters in JSON format, and set the request body. The ID of the accessed API is required. You need to enter the specific ID information. The x-api-id parameter is used in Headers.
  4. Click Send request to generate a curl command. 

    $ 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. Then, add the x-Authorization header to the command. The value of the x-Authorization header is the same as that of the Authorization header. Copy the curl command to the CLI to access the 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