5. wsbackend

• 5.1. Installation
  • 5.1.1. Install Prerequisites
  • 5.1.2. Clone the Repo
  • 5.1.3. Create a Virtual Environment
  • 5.1.4. Activate the Virtual Environment
  • 5.1.5. Install Dependencies
  • 5.1.6. Define Environment Variables
  • 5.1.7. Install Gunicorn
• 5.2. Environment Variables
  • 5.2.1. Host address
  • 5.2.2. Identity Provider
  • 5.2.3. Database
  • 5.2.4. Consumer API
  • 5.2.5. Admin API
• 5.3. Reference

class wsapiwrapper.ApiWrapper(baseurl: str, tokenstr: str)

Wraps calls to wsbackend APIs.

Uses the Requests HTTP library to call wsbackend web APIs.

__init__(baseurl: str, tokenstr: str)

Constructor for ApiWrapper.

Parameters

baseurl (str) – Websensor backend base URL.

auth_header(tokenstr)

Get a dictionary of headers. One contains an API access token. This is needed for some API requests to be authorized.

Parameters

tokenstr (str) – API access token

Returns

a dictionary containing two HTTP headers.

Return type

dict