Skip to main content

PowerMetrics: API Key authentication

Updated

Highlights

Overview API Key is an umbrella term that covers different methods for generating an authentication token in order to perform an API call. Typically, this method will require you to generate or request an API Key from a service provider to use in subsequent API calls. That API Key will need to be included as part of the request URL.
Format When the API key is retrieved from a service provider, it is used in the API call in a format as specified by that service. For example, you may be required to use the API key as a query parameter or as a username and password.

Connecting to your data using the REST/URL connector

To connect to your data using the REST/URL connector, you need to do the following:

  1. Write a query (request URL) by referring to the service provider's developer documentation.
  2. Create and save a data feed.

Step 1: Write an API query

Begin by going to the developer documentation for the service provider you would like to retrieve data from. Some API connection requests are free and open to the public, however, depending on the service provider, you may need to:

  • Have an account with the service provider.
  • Contact the service provider to grant you API request permissions.
  • Contact the service provider to receive an authentication token.
  • Pay an API access fee.

Step 2: Create and save a data feed

To create and save a data feed:

  1. Click the + button beside Data Feeds in the left navigation sidebar.

  1. Click Select data.
  2. On the Where is your data? page, select the REST/URL tile.

  1. On the Configure data service page, paste the URL call from the REST/URL into the Query URL field.
  2. Choose the appropriate Data format (XML, CSV, Excel, or JSON).
  3. Expand the Authentication (OAuth, 2-Step, X-WSSE, or Basic) menu.
  4. Under Type, select the option None.
  5. Click Get data and verify this is the data you're looking for.
  6. Click Continue.
  7. You're taken to the data feed editor, where you can either save the data as-is or modify it. If you want to edit the data feed, this article includes detailed editing information.
 

Related articles