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
- Log in to the DataArts Studio console.
- Click DataArts DataService.
- In the navigation pane, choose DataArts DataService Exclusive > SDKs.
- On the SDKs page, download the SDK package.
- 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 3a86f1ba249a00727db506e4075ec9630e6cf74f312bddf6c3901c9d0786f53e CertUtil: -hashfile command executed. 3a86f1ba249a00727db506e4075ec9630e6cf74f312bddf6c3901c9d0786f53e
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.
Table 1 SDK packages and the corresponding SHA-256 values Language
SHA-256 Value of the SDK Package
Java
3a86f1ba249a00727db506e4075ec9630e6cf74f312bddf6c3901c9d0786f53e
Go
23734867eae2e7ef61427c64aa33aa89512571946f2f43a1a5fef5e801e3129f
Python
57636d8bacc459cab9dc08c70d01ccc42391ace60e6960c4e947566da1dc5d26
C#
e5a3b677f75c28ba3f1e16645d8171f7b6f34a42143f8a32a68bb18719b5e65d
JavaScript
442ac2fcb41d84525dc0139ec3f05d190e4e337cdbcdfdfc82a09d79d2ecd25e
PHP
2cc76bd2ecd48f00899d18b0f76d05ce2623065180f111c3f70ac14ddf0506f3
C++
2a54c3f2486d562ea6af1384eca40b301918bdc02f98bbf2c114f282dc059c00
C
4957556c108e0174d55b4b8d720f296967a9367ca54010792b1b3de039b87363
Android
0fdcc6fd93a68dce5c3e1b8e6370cc9340429cabfb0f268c3f9e5ea05238ae96
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
- 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.
- Specify the key, secret, method, protocol, domain name, and URL. (Coded or plaintext AK and SK pose significant security risks. To ensure security, encrypt your AK and SK, store them in configuration files or environment variables, and decrypt them when needed.) This example uses the console input for demonstration:
1 2 3 4
Key=4f5f626b-073f-402f-a1e0-e52171c6100c Secret=****** Method=POST Url=https://{apig-endpoint}
- 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.
- 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 ""
- 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
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot