Overview

This section provides important information that is required to get started using the Oracle Utilities Opower Application Program Interface (API) system.

• Send Request Requirements and Supported Operations

• Prepare a Testing Environment

• Review Use Cases

• Review API Reference Material

Send Request Requirements and Supported Operations

The Oracle Utilities Opower API is based upon HTTP, and it has a RESTFul style. As such, all interaction is done as a series of HTTP requests against given URIs. Use the following guidelines when sending requests using the REST API.

URL Structure

You access and call the REST resources using the following URL structure:

https://domain.com/apis/service-version/utilitycode/resource             

An example URI for the utility account endpoint to retrieve all electric and gas utility accounts for a customer is provided below. The utilitycode is UTIL, which is a demo utility.

https://cxapi.opower.com/apis/customer-data-v2/UTIL/customers/123456/utility_accounts

Where:

• domain is the host name for the REST server. The production domain is cxapi.opower.com and is intended to be used for updates or retrievals from your production system that directly supports your customers. The stage domain cxapi-stage.opower.com and is intended for API call and feature testing.

• service-version is the service name and API endpoint version.

• utilitycode is three or four letter code created during Opower platform setup. Please contact your customer success representative if you are unsure of your utility code.

• resource-path is the relative path that defines the resource.

Obtain Account Information

The API endpoints use OAuth 2.0. See Using OAuth 2.0 Authentication to learn how to register your client application and obtain a client access token in support of completing API endpoint calls.

Supported Methods

You can perform basic CRUD operations (create, read, update, and delete) using standard HTTP method requests, as summarized in the following table.

HTTP Method	Description
GET	Retrieve information about the resource.
POST	Create, backup, or restore the resource.
PUT	Update the resource.
DELETE	Delete the resource.

Prepare a Testing Environment

Work with your Oracle Utilities Delivery Team to receive credentials for a testing environment which is used for all testing. See Testing the REST APIs for information on setting up third-party tools to use and test the REST resources. Guidance is provided for Postman and cURL.

Review Use Cases

Example use cases are provided to help get you started with using the API endpoints. See Use Cases for more information.

Review API Reference Material

See Reference for additional API reference material such as applicable status codes, JSON format requirements, and limitations.