Python

Scenarios

To use Python to call an API through App authentication, obtain the Python SDK, create a project, and then call the API by referring to the API calling example.

This section uses IntelliJ IDEA 2018.3.5 as an example.

Preparing the Environment

• 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.
• You have installed Python 2.7.9 or 3.X. If not, download the Python installation package from the official Python website and install it.

  After Python is installed, run the pip command to install the requests library.

  pip install requests

  

  If a certificate error occurs during the installation, download the get-pip.py file to upgrade the pip environment, and try again.

• You have installed IntelliJ IDEA. If not, download IntelliJ IDEA from the official IntelliJ IDEA website and install it.
• You have installed the Python plug-in on IntelliJ IDEA. If not, install the Python plug-in according to Figure 1.
  Figure 1 Installing the Python plug-in
  

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
   96fced412700cf9b863cb2d867e6f4edf76480bc679416efab88a9e1912503b9
   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.

   Table 1 SDK packages and the corresponding SHA-256 values

   Language	SHA-256 Value of the SDK Package
   Java	96fced412700cf9b863cb2d867e6f4edf76480bc679416efab88a9e1912503b9
   Go	f448645da65b4f765d9569fc97ca45dc3e8f1ce4f79d70c5c43934318521d767
   Python	54b4984d91db641d2b1b0e77064c162850cb2511a587f95e2f8b8340e7afa128
   C#	b66caf856ffccb61fe758872aac08876aa33fb0cf5f4790e3bec163593b2cbae
   JavaScript	43da0b54d6b04d1f5ed7f278c2918c2a63a1ddb8048e2d1c5db60baafb17663c
   PHP	394c068420a3817f32d5d88b6c1632978f573f2a685e4a1d10c2f698e0f6786e
   C++	abae5473d47594f88dcd5eaa0902dc12cd6f1e3bd63c0b82d9d1fab8b4351f54
   C	a376573fe8aa3a636a6d123926ddc3dca11748b289b8c2c16a5056830a095acb
   Android	c19175d736f05b1945dab4675df19311834ede0d9b1978b11b50c86687baf85c

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

Creating a Project

1. Start IDEA and choose File > New > Project.

   On the displayed New Project page, choose Python and click Next.

   Figure 2 New Project
   

2. Click Next. Click ..., select the directory where the SDK is decompressed, and click Finish.
   Figure 3 Selecting the SDK directory after decompression
   

3. View the directory structure shown in the following figure.
   Figure 4 Directory structure of the new project
   

   Modify the parameters in sample code main.py as required. For details about the sample code, see API Calling Example.

API Calling Example

1. Import apig_sdk to the project.

   1 2 3

   from apig_sdk import signer import requests import os

2. Generate a new signer and enter the AppKey and AppSecret.

   1 2 3 4 5 6 7 8

   # 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. # In this example, the AK and SK stored in the environment variables are used for identity authentication. Before running this example, configure environment variables SDK_AK and SDK_SK in the local environment. ak = os.environ("SDK_AK"); sk = os.environ("SDK_SK"); sig = signer.Signer() sig.Key = ak sig.Secret = sk

3. Generate a request, and specify the method, request URI, header, and request body.

   1 2 3 4

   r = signer.HttpRequest("POST", "https://{apig-endpoint}/app1?a=1", {"x-stage": "RELEASE", "name": "value"}, "body")

4. Execute the following function to add the X-Sdk-Date and Authorization headers for signing: Then, add the x-Authorization header to the request. The value of the x-Authorization header is the same as that of the Authorization header.

   1 2	sig.Sign(r) r.headers["x-Authorization"] = r.headers["Authorization"]

5. Access the API and view the access result.

   1 2 3

   resp = requests.request(r.method, r.scheme + "://" + r.host + r.uri, headers=r.headers, data=r.body) print(resp.status_code, resp.reason) print(resp.content)