Skip to main content

API Key authentication in Klips

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:

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

Step 1: Write an API query

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.

To learn more about these requirements and how to write your query, refer to the service provider’s API documentation. Once you have a query, you will copy and paste it into Klips, when creating and saving your data source. See the following section for details.

Step 2: Create and save a data source

To create and save a data source:

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

    Note: If you don't see this option, click your Account Name at the bottom of the left navigation sidebar and select Data Sources instead. Then, in your data source library, click Create a New Data Source.
  2. On the Where is your data page, under Additional options, select REST/URL
  3. On the Configure your connection page, copy and paste the URL call from the REST/URL into the Query URL field.
  4. Choose the appropriate Data format (XML,CSV, Excel, or JSON).
  5. Expand the Authentication (OAuth, 2-Step, X-WSSE, or Basic) menu.
  6. Under Type, select the option None.
  7. Click Get data.
  8. Ensure this is the data you’re looking for and, optionally, select the checkbox to Model your data. Learn more about modelling your data source.
  9. Click Continue.
  10. Name, choose refresh settings, and, optionally, share your data source.
  11. Click Save.
 

Related articles