Getting Started

To use the API7 Python SDK, first register at the API7 Developer Portal.

After registering, you can find your Developer Key on the Dashboard once you log in.

You will need your Developer Key to use this SDK.

Install requirements

With your Developer Key handy, you can simply pip install our SDK as shown below:

pip install API7

To facilitate RAD (Rapid Application Development), we highly recommend that you use Jupyter Notebooks while familarizing yourself with our APIs, and planning the UI for your own users.

To install Jupyter in your Python virtual environment, first activate your environment, and then install Jupyter

pip install jupyter

You can, then, follow along this tutorial by starting your notebook,

jupyter notebook

and entering the subsequent snippets in your notebook and executing them.

Import and initialize SDK

Since our SDK supports multiple regions, you need to initialize it with a BACKEND_URL indicating the region you would like to host your data in, and also with a DEVELOPER_KEY. To do so, enter this in a cell in your notebook, and execute it:

# Import the SDK
from API7 import API7

# Defined the region, and developer key
BACKEND_URL = "https://sg.api7cloud.com"
DEVELOPER_KEY = "8zt.......................................ZmQ2"

# Initialize the SDK
sdk = API7(BACKEND_URL, DEVELOPER_KEY)

Now we are ready to use the SDK to perform various operations.