API

RESTful Web Service

The Asset Score API is a RESTful style web service. For more information about REST, please visit: http://en.wikipedia.org/wiki/Representational_state_transfer

API Organization Token

In order to create an account to authenticate and utilize the API, users must first get an API Organization Token. The token must be passed along with the parameters used when creating a new account. Please send an email with the subject line "Request API Token" to: asset.score@ee.doe.gov

Once the organization token is received the API can be utilized to create a user account. A user account is used to obtain an API Access Token, described below. Follow the API documentation for details of the parameters needed: POST /api/v2/users

API Access Token

Once a user account has been created the user can authenticate against the API to generate a user-specific access token. All subsequent interactions with the API must include the authenticated user's API token. Follow the API documentation for details of authentication method: POST /api/v2/users/authenticate

The API Access Token is specific to an individual user, and is distinct from the API Organization Token. The API Organization Token is used only to create user accounts and to authenticate those accounts in order to receive the API Access Token.

To use your API access token, simply pass the key as a URL parameter when making requests. For example:

GET https://api.labworks.org/api/v2/preview_buildings?token=YOUR_UNIQUE_TOKEN

API Documentation

All API documentation can be found at: API Documentation

Summary of Steps

  1. Request an API Organization Token. Send email with subject line "Request API Token" to: asset.score@ee.doe.gov
  2. Use the API Organization Token to create a user account: POST /api/v2/users
  3. Authenticate the user account using the API Organization Token to receive an API Access Token: POST /api/v2/users/authenticate
  4. Use the API Access Token in further API requests.

Data Documentation

The help desk website help documentation provides detail into how the tool works and is recommended reading: Asset Score Help

See below for a high-level overview of the data model. For more detail, download a description of the data elements as described in: EnergyAssetScoreDataModel.v1.pdf

Notice

This material was prepared as an account of work sponsored by an agency of the United States Government. Neither the United States Government nor the United States Department of Energy, nor the Contractor, nor any or their employees, nor any jurisdiction or organization that has cooperated in the development of these materials, makes any warranty, express or implied, or assumes any legal liability or responsibility for the accuracy, completeness, or usefulness or any information, apparatus, product, software, or process disclosed, or represents that its use would not infringe privately owned rights.

Reference herein to any specific commercial product, process, or service by trade name, trademark, manufacturer, or otherwise does not necessarily constitute or imply its endorsement, recommendation, or favoring by the United States Government or any agency thereof, or Battelle Memorial Institute. The views and opinions of authors expressed herein do not necessarily state or reflect those of the United States Government or any agency thereof.

PACIFIC NORTHWEST NATIONAL LABORATORY
operated
BATTELLE
for the
UNITED STATES DEPARTMENT OF ENERGY
under Contract DE-AC05-76RL01830

ALL RIGHTS RESERVED