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 becff4310645f3734344897ffdcabb1853d4b7d93b59a6ea187c5ae40543b36b CertUtil: -hashfile command executed. becff4310645f3734344897ffdcabb1853d4b7d93b59a6ea187c5ae40543b36b
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
becff4310645f3734344897ffdcabb1853d4b7d93b59a6ea187c5ae40543b36b
Go
bcf8cf19a21226e247195f2e584c8414da39b8d05840fb02948e1375d9bbb7e6
Python
c3da3b5814f828d6217963e856563d558d938b3da28993a8a13c8a7ebff5b95d
C#
a880b47e63ab35bfe216592e340a8135b866aef8f756ef7738fff3287885f33a
JavaScript
53261387f5fcf46e61d0bef5e890bea97952717f327c356412c3128389e848d6
PHP
29bf711144e77a4adaea1257cd6dedd2220e57b729a8fd000c51e68ccb42ad4b
C++
f604c6386c62cccb7c358007778037d5b15480987dc2860eef1b7bad37cb21d7
C
7086012c2d0569d5938830926b19fbea0d46682a983e04e52924978e8720c2f8
Android
89962b186707828b06b0c9f50c010b2f4cefd6a8e7ca9bdefb616bbbf6e739c8
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