Home Energy Scoring‎ > ‎API Definitions‎ > ‎API Methods‎ > ‎2017.2‎ > ‎

get_session_token

Starts a user session and returns a session token, which must be submitted with every other API request to identify the user making that request.  For security reasons, the destroy_session_token method should always be called when the user has ended their session.

Parameters

NameDescriptionTypeRequired
user_keyAPI key for accessstringYes
 user_name The user ID name of the user to log in  string Yes
 password The password of the user to log in string Yes



Response

ElementDescription
session_tokenContains the session token that is to be submitted with all further requests made by this user



Roles

For obvious reasons, this method can be accessed by anyone without restriction