For API syntax and tips, see the API Reference, which is generated from the Swagger specification.

This Getting Started guide covers:

Prerequisites

Top

Adding a Data Store

A Data Store holds data from an online service, a database, or another software application, so you can include that data in your groov operator interface and your groov users can interact with it.

You add a Data Store for each application that will connect with groov, and then add the tags you want the application to read or write to.

  1. In groov Build, select Configure > Devices and Tags.
  2. Click Add New Device and then select Data Store. Give the Data Store a name and click Create.

  3. Highlight the Data Store and click Configure Tags. Click the plus sign in the upper left.

  4. Enter the tag name and choose its data type. Optional: If the tag is an array, check the Table box and enter the table length. Table length can be whatever you need (within the limits of your system’s capacity).
  5. Click Save.

    IMPORTANT: When your tag appears in the list, note its Tag Id. You need the Id to access the tag.

Top

Setting up API users

Software clients that need to access data in groov must be added as users in groov Build, so their API keys can be generated.

  1. In groov Build, choose Configure > Accounts. Then click the Users tab.
  2. Click Create New User.

  3. For an API user, enter a username. Select a Role of Admin or Editor (Operator and Kiosk users cannot use the API, even though a key is shown for them). Enter a password and confirm it. The password is used only to set up the user initially.
  4. Click Create User.

The user appears in the list and its API key is automatically generated. You’ll need the API key to build your groov API request.

Next Step

Continue with Building your first groov API request

API: