Authentication Methods

Authenticating via the API can be accomplished in two different ways:

  • Using a Session Token & Cookie
  • Using an API Key & Hash

API Key & Hash

This method requires that you have generated an API key with appropriate permissions prior to use. The API secret is utilized on each call to create a hash value of the query string.

Note: Using the API Key and hash will not log you out of the portal if you have an automated process that runs while you are navigating the portal.

A call to the /customer end point, would then look like this:

url = generate_full_endpoint('customer', key_secret='1-1111111')
r = request.get(url)

Your results would be available in r.json()

If you are curious about the function called in the previous example, see the Helpful Functions section.