README.md

Carbon Mapper Platform API Tutorials

Tutorials offer information for and examples of working with Carbon Mapper's platform API. Refer to the platform API documentation for technical API details.

Using the Tutorials

Installing Jupyter Notebook

Refer to Jupyter's official Installing Jupyter page for information about installing Jupyter Notebook. A virtual environment may be required before installation, depending on the platform Notebook is installed to. Refer to the official Python documentation for creating virtual environments.

Accessing the tutorials

From within the platform_public project root directory, run jupyter notebook:

# Activate the virtual environment if required
user@hostname:./platform_public$ source <venv_dir>/bin/activate
user@hostname:./platform_public$ jupyter notebook

API Authentication

Many platform API endpoints require authentication. Some endpoints may return different results depending on authentication status and the token's scopes. A platform account is required to obtain an API access token. Users without accounts are encouraged to register for an account. The tutorials are written with the assumption that the user has active platform account credentials.

Obtaining a Scoped Token Using the Platform Website

A scoped token can be generated by logging in to the platform application and visiting the API Tokens section of their Account page. The token will only be displayed to the user once, upon generation. If generating the token for future use, it should be stored securely and should not be committed to code repositories.

Obtaining a Scoped Token Using the Platform API

Refer to the scoped token tutorial.