Help Center> IoT Device Access> SDK Reference> Old SDKs> Application Python SDK API Reference> SDK Usage Guide
View PDF

SDK Usage Guide

Non-China Unicom users can view the IoT Device Access (IoTDA) Developer Guide.

SDK Demo Architecture

  • The demo code is the sample code used for calling SDK APIs, including initializing and calling each API. The demo code is for your reference only.
  • The Python SDK uses Python methods to call platform APIs to communicate with the IoT platform.
  • The message push callback uses Python code to implement the callback API, which is called by the platform to push messages to applications. An application inherits the PushMessageReceiver class and overrides the methods in the class to receive the content of a push message.
  • The test API tests whether the basic functions between the SDK and platform are available and generates test results. During the test, the internal test certificate and the certificate set by developers are used.

Methods of the NorthApiClient Class

The methods of the NorthApiClient class are used to create an application instance. They are the prerequisites for calling other SDK APIs. The table below describes the main method.

Method

Description

def invokeAPI(httpMethod, url, headers, payload, clientInfo)

The API calling methods and the returned data vary according to the input parameters.

Methods of the ClientInfo Class

The methods of the ClientInfo class are used to set the basic information about the interconnection. The table below describes the main methods.

Method

Description

platformIp

Indicates the IP address of the platform.

platformPort

Indicates the port of the platform, for example, 8743.

appId

Identifies an application. This parameter is set to the ID allocated by the platform for the partner's server.

accessToken

This parameter is set to the value of the accessToken obtained by calling the Authentication API.