Help Center> DataArts Studio> SDK Reference> DataArts DataService SDK Reference> Preparations for Using an SDK
Updated on 2024-04-29 GMT+08:00
View PDF

Preparations for Using an SDK

  1. Download an SDK and import it to a local development tool.

    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 an SDK.
    5. Verify integrity of the SDK. In Windows, open the CLI and run the following command to generate the SHA-256 value of the downloaded SDK. In the command, D:\java-sdk.zip is an example local path and name of the SDK. 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 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

      Java

      becff4310645f3734344897ffdcabb1853d4b7d93b59a6ea187c5ae40543b36b

      Go

      bcf8cf19a21226e247195f2e584c8414da39b8d05840fb02948e1375d9bbb7e6

      Python

      c3da3b5814f828d6217963e856563d558d938b3da28993a8a13c8a7ebff5b95d

      C#

      a880b47e63ab35bfe216592e340a8135b866aef8f756ef7738fff3287885f33a

      JavaScript

      53261387f5fcf46e61d0bef5e890bea97952717f327c356412c3128389e848d6

      PHP

      29bf711144e77a4adaea1257cd6dedd2220e57b729a8fd000c51e68ccb42ad4b

      C++

      f604c6386c62cccb7c358007778037d5b15480987dc2860eef1b7bad37cb21d7

      C

      7086012c2d0569d5938830926b19fbea0d46682a983e04e52924978e8720c2f8

      Android

      89962b186707828b06b0c9f50c010b2f4cefd6a8e7ca9bdefb616bbbf6e739c8

  2. Prepare the parameters of the request message.

    Table 1 Parameters

    Type

    Description

    Example

    Path parameter

    The path parameter is part of the URL. Use it to replace the parameter in {} in the URL.

    Parameter: param = xxx

    Original URL: http://Domain name/p1/{param}/p2

    Actual URL: http://Domain name/p1/xxx/p2

    Query parameter

    The query parameter is a supplementary part of the URL.

    Parameter: param = xxx

    Parameter 2: param2 = xxx2

    Example 1:

    Add the query parameter to a method (use the SDK of each language as an example).

    Example: request.addQueryStringParam("param"," xxx");

    Example 2:

    Add a question mark (?) and the parameter to the end of the URL. If there are multiple parameters, separate them by ampersands (&).

    Original URL: http://Domain name/p1

    Actual URL: http://Domain name/p1?param=xxx&param2=xxx2

    Header parameter

    The header parameter is part of the request header. The parameter name is case insensitive.

    Parameter: param = xxx

    Add a header parameter to a method or add a header parameter when constructing a request (subject to the SDK of each language).

    Example: request.addHeader("param"," xxx");

    Body parameter

    The request body parameter is a JSON string in the SDK. This parameter is unavailable in earlier versions.

    "{}"

  3. Modify the SDK and obtain the signature parameter Authorization in the request header after the request is signed. In addition, add the x-Authorization parameter with the same value as Authorization. For details about how to obtain the Authorization parameter and add the x-Authorization parameter, see Preparation.