/
How to generate VSS API access token using Python

How to generate VSS API access token using Python

Owned by JM Lopez
Last updated: Dec 06, 2022
1 min read

This quick how-to was written with python 3.10.8 and requests 2.28.0

PyVSS is now the supported and recommended method to interact with the VSS API.

Step-by-step guide

The following steps demonstrate how to get an access token:

  1. Import requests, sys, getpass and requests.auth.HTTPBasicAuth to handle endpoint authentication.

    import getpass import sys import requests from requests.auth import HTTPBasicAuth



  2. Get user from input and password via getpass.getpass() so it's not prompted.

    # input argument usr = sys.argv[1] # Prompt the user for a password without echoing. pwd = getpass.getpass()



  3. Set the authentication endpoint

    token_endpoint = 'https://vss-api.eis.utoronto.ca/auth/request-token'



  4. Make a POST request to token_request and create a new HTTPBasicAuth object initializing it with usr and pwd

    # NO MFA r = requests.post(url=token_endpoint, auth=HTTPBasicAuth(usr, pwd)) # With MFA r = requests.post(url=token_endpoint, auth=HTTPBasicAuth(usr, pwd), json={'otp': '00000'})

  5. Get JSON response body

    data = r.json()

  6. Print Error if any or the token if succeeded:

    if r.ok: print(f"TOKEN={data['token']}") else: print(f"ERROR: {r.status_code} {data['type']}: {data['message']}")

Script

Full python script is showing below:

#!/usr/bin/env python # importing modules import getpass import sys import requests from requests.auth import HTTPBasicAuth # input argument usr = sys.argv[1] # Prompt the user for a password without echoing. pwd = getpass.getpass() # authentication endpoint token_endpoint = 'https://vss-api.eis.utoronto.ca/auth/request-token' # making post request r = requests.post(url=token_endpoint, auth=HTTPBasicAuth(usr, pwd)) data = r.json() # getting token or printing error if r.ok: print(f"TOKEN={data['token']}") else: print(f"ERROR: {r.status_code} {data['type']}: {data['message']}")

Related articles



Related content