suitespotauth 0.1.1

Easy SuiteSpot authentication.

SuiteSpot Auth

Introduction

This package is a light wrapper for the SuiteSpot authentication API to provide easy generation of an access token to be used in SuiteSpot data API calls.

Suitespot data API requests require Bearer Authorization including an access token. This package provides an abstraction layer to easily generate an access token.

Installation

$ pip install suitespotauth

Usage

1. Set your SuiteSpot credentials (username and password)

$ suitespotauth-configure

2. In your Python program, import the authenticator class

from suitespotauth import SuiteSpotAuth

3. Create a class instance

auth = SuiteSpotAuth()

# Optionally, provide a name variable, which is stored in the SuiteSpot API token object
auth = SuiteSpotAuth("My Company")

4. Use the access_token attribute in your data API request header

"Authorization": f"Bearer {auth.access_token}"

Official SuiteSpot data API docs should be retrieved directly from your SuiteSpot representative.

Configuration

You must have a SuiteSpot username and password to use this package. When you run suitespotauth-configure from the command line, your credentials will be securely stored on your computer using keyring.

Disclaimer

• This package is unofficial and is not affiliated with SuiteSpot. The official SuiteSpot authentication API docs can be found at: https://auth.suitespot.io/api#/
• The SuiteSpot authentication API may change at any time, which can cause breaking changes to this package. Please contact