Getting started

Registering on the public grid connect portal

1. In order to get started, you must first register as a customer on our portal.
2. Generate the Bearer token by utilizing the API key feature on our portal. This functionality is essential as it authenticates the requester, providing access to the relevant data.

Make your First API request to fetch account details using the account API

Prerequisites

Before you begin, make sure you have the necessary credentials and parameters ready. Specifically, ensure you have an active account on the Connect platform. If you don't have an account yet, you can easily create one by completing the sign-up process.

Step 1 : Getting the Access Token.

To acquire the Bearer Token, log in to the Connect platform and generate a new token using the API keys feature available on the platform.

Step 2 : Sending request to get-account.

Once you have the bearer access token, use it as an authorization header in the request. The guide provides cURL examples but you can use Postman or any other tools used for making http requests as well to make the requests.

Create Get request

To initiate the request, perform a GET request to the designated endpoint "https://dev.onepublicgrid.dev/accounts":

curl "https://dev.onepublicgrid.dev/accounts/{accountId}" \
-X GET \
-H "Authorization: Bearer {YOUR_ACCESS_TOKEN} " \
-H "Content-Type: application/json"

 

Replace "YOUR_ACCESS_TOKEN" with the token generated in step 1.

Response

Upon making the above request, you'll receive the following response:

{
   {
  "customerId": "{customerId}",
  "utilityAccounts": [
    {
      "electricAccountId": "{electricAccountId}",
      "utilityAccountNumber": "{electricAccountNumber}",
      "utilityProvider": "{utilityProvider}",
      "address": {
        "street": "{street}",
        "city": "{city}",
        "state": "{state}",
        "zip": "{zip}"
      },
      "customerId": "{customerId}"
    }
  ]
}
}

This response contains details of the account with respect to the account ID.

All Done!

Using the above steps, you have successfully made your first call to the get-account API.