Skip to content

Get Started

1. Creating an Account

Create an account in the SmartHQ ecosystem by selecting the following button:

Create an account

  1. After selecting this button, click Log in in the new tab.
  2. If you already have an account in SmartHQ, enter your login information. If not, click Sign up here and fill out the signup form.

2. Creating an App

Next, create a SmartHQ app via the Apps page by selecting the following button:

Create an app

  1. After selecting the button above, click Apps from the top menu option.
  2. Choose Add app.

  3. Enter a Machine name.

    Machine Name Recommendations
    • When the end-user logs in to SmartHQ to authorize your app, they will see the machine name as a way to identify your app.
    • The machine name cannot be changed later in the SmartHQ Developer Portal. To choose a new machine name, you would need to create a new app or contact us to change an existing app name.
    • The following image is what the end-user will see when authorizing your app if your machine name is "machine_name_example":

    Image showing the machine name showing up and the authorization screen that end-users will see

  4. Enter a Callback URL. This URL is part of the OAuth 2.0 authorization process. It is where the authorization server redirects the end-user after they approve or deny the authorization request to give your app access to their device. This URL is where your application will receive the authorization code, which can then be exchanged for an access token. Learn more about authorization.

    Tips

    Don't have a callback URL? Postman is a tool for quickly testing APIs without needing to build your own app. Use one of the callback URLs below to easily complete authorization in Postman.

    https://oauth.pstmn.io/v1/callback

    https://oauth.pstmn.io/v1/browser-callback

    Changing later: The Callback URL you choose can be changed later in the SmartHQ Developer Portal by going to the APIs page, selecting the "Apps" menu option, choosing your app, and clicking "Edit" next to the "Credentials" tab.

  5. Click the Add app button at the bottom of the screen to create the app.

3. (Optional) Send API Requests Through Postman

Don't have an application ready yet but want to call our APIs? This guide explains exactly how to set up Postman and complete authorization to call our APIs. Postman is a tool for testing APIs that allows you to send requests, receive responses, and complete authentication flows without building a full application.

The goal of this section is to obtain an access token, which you will use to authenticate future API requests.

Import Our API into Postman

  1. If you have not already, download Postman desktop application or access the web version through the same link.
  2. In the top left-hand corner, select Workspaces and click the Create Workspace button.
  3. The "Blank workspace" option should already be selected. Click Next.
  4. Name the workspace and choose the workspace type and access that best fits your needs. Then click Create.
  5. Go to the following API to download the spec. Click the Download Specs button towards the top of the page.
  6. Back on Postman's site in the workspace you just created, select Import and choose the JSON file you just downloaded.
  7. Once the import is complete, a "Choose how to import your Specification" pop up will appear. Ensure the Postman Collection option is selected.
  8. Click Import. You should see the "SmartHQ Digital Twin API" folder with the various endpoints inside.

Get an Access Token through Postman

  1. In Postman, click on the top-level folder you just imported.
  2. The "Overview" tab should be selected. Click Authorization to the right of "Overview."
  3. Under the "Auth Type" dropdown, select OAuth 2.0.

  4. Scroll down to the "Configure New Token" section in Postman and enter the following information:

    • Token Name: Enter a name for the token. This name is only for your reference to help you keep track of tokens and has no functional impact.
    • Grant type: Ensure Authorization Code is selected.

    • Callback URL: Use one of the following based on your use case:

      https://oauth.pstmn.io/v1/callback

      https://oauth.pstmn.io/v1/browser-callback

    • Auth URL: Copy this URL into the Auth URL textbox. 

      https://accounts.brillion.geappliances.com/oauth2/auth

    • Access Token URL: Copy this URL into the Access Token URL textbox. 
      https://accounts.brillion.geappliances.com/oauth2/token
    • Client ID: Enter the Client ID from the SmartHQ app you created in the Developer Portal. To get to your Client ID, go to the SmartHQ APIs Page , select Apps from the top navigation section, and select the app you would like to use. Copy the Client ID into the Client ID textbox in Postman.
    • Client Secret: Enter the Client Secret. This can be found under the Client ID in the SmartHQ Apps page.
    • Scope and State: These fields can be left blank.
    • Client Authentication: Select Send client credentials in body.

  5. Scroll to the bottom and click the Get New Access Token button.

  6. You will be redirected to the SmartHQ sign-in page. Log in with the same account you used to create the SmartHQ app. After logging in, you should see a "Authentication complete" message in Postman that will go away in a few seconds.
  7. Once that is complete, click the Use Token button in Postman.
  8. Scroll up to the "Current Token" section on the same page in Postman. Copy the token. This is the access token to authenticate API requests.

Send First API Request

  1. To make your first API call through Postman, expand the SmartHQ Digital Twin API folder in Postman. Expand the v2 folder as well.
  2. Open up the device folder and select the GET Get the list of devices for an account
  3. The "params" tab should be selected. Click Authorization to the right of it.
  4. A "Bearer Token" screen should be shown. Click the red "{{bearerToken}}" and paste the access token here.
  5. Click the Send button to make the API request.
  6. If you have no devices commissioned to your account, you should received a response link the following:
Example response with no devices in the account
{
    "perpage": 50,
    "total": 0,
    "devices": [],
    "kind": "device#list",
    "page": 1,
    "userId": "6cm89..."
}

Congratulations, you've successfully completed the OAuth 2.0 authorization process and made your first API request.

Next Steps

These next steps have been carefully crafted in a way to ensure you are off to a good start.

  • If your device list is empty like the response shown above, but you want to add a device to the account, or you are looking to understand the commissioning process, see Device Commissioning
  • Below are three common paths developers take when getting started with SmartHQ APIs. Please choose the one that best fits your goals:

  • Device Control and Monitoring

    Building an application and want to control and monitor devices (e.g., dishwasher, dryer) using SmartHQ APIs?

    See Documentation

  • Adding External Devices

    Have an external, non-GE Appliances device that is not in the SmartHQ Ecosystem that you would like to add?

    See Documentation

  • Property Management

    Looking to develop an application that leverages the SmartHQ Management APIs?

    See Documentation