Updated on 2025-05-27 GMT+08:00

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
      96fced412700cf9b863cb2d867e6f4edf76480bc679416efab88a9e1912503b9
      CertUtil: -hashfile command executed.

      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.

      Table 1 SDK packages and the corresponding SHA-256 values

      Language

      SHA-256 Value of the SDK

      Java

      96fced412700cf9b863cb2d867e6f4edf76480bc679416efab88a9e1912503b9

      Go

      f448645da65b4f765d9569fc97ca45dc3e8f1ce4f79d70c5c43934318521d767

      Python

      54b4984d91db641d2b1b0e77064c162850cb2511a587f95e2f8b8340e7afa128

      C#

      b66caf856ffccb61fe758872aac08876aa33fb0cf5f4790e3bec163593b2cbae

      JavaScript

      43da0b54d6b04d1f5ed7f278c2918c2a63a1ddb8048e2d1c5db60baafb17663c

      PHP

      394c068420a3817f32d5d88b6c1632978f573f2a685e4a1d10c2f698e0f6786e

      C++

      abae5473d47594f88dcd5eaa0902dc12cd6f1e3bd63c0b82d9d1fab8b4351f54

      C

      a376573fe8aa3a636a6d123926ddc3dca11748b289b8c2c16a5056830a095acb

      Android

      c19175d736f05b1945dab4675df19311834ede0d9b1978b11b50c86687baf85c

  2. Prepare the parameters of the request message.

    Table 2 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.