Authenticate to the Energy Asset Score application to receive a token for use in future API requests. In order to authenticate a user account and organization token are also required. Contact asset.score@ee.doe.gov to request an organization token. Use the organization token to create a user account. Follow the API documentation for user accounts: buildingenergyscore.energy.gov/apidoc/v2/users.html

Supported Formats

json, xml

Errors

Code Description
404 Unsupported operation
500 Unspecified error on server.
401 Request must contain username, password and organization token
401 Invalid email or password.
401 Invalid username, password or organization token

Examples

(json) POST https://buildingenergyscore.energy.gov/api/v2/users/authenticate?email=test@test.org&password=passw0rd&organization_token=1234TokenGoesHere
(json) Response:  {"user_id": 30, "token":"xzysuLdC2hiJfRGgMkAv"}

Params

Param name Description
email
required

Email address of the existing user

Validations:

  • Must be a String

password
required

Password for the existing account

Validations:

  • Must be a String

organization_token
required

Unique token required to generate a user token for future API calls.

Validations:

  • Must be a String