Skip to main content

2-Step authentication in Klips

Updated

Highlights

Overview

The 2-step authentication method is used to securely connect to a REST/URL connector.
This method involves two steps:

  1. Submitting your credentials to a web service in order to generate a unique authentication key.
  2. Using the authentication key in the request URL in order to securely submit your request to that web service.

Required fields

Username Credentials that identify your account
Password Verifies the authenticity of the account
Response Select Text, XML, or JSON
Method Select GET or POST
Parameters For parameters, enter a Name, a Value, and select a Type - Query, Header or Cookie.
Auth URL This URL generates the authentication token or session key that allows you to access the API. This URL may require you to include email, password and api key parameters. For example:
https://pi.pardot.com/api/prospect/version/3/
Token Path This is a regular expression that allows Klips to retrieve the authentication or session key from the response received via the Auth URL. For example:
<api_key>(.*?)</api_key> 
Logout Method Select GET or POST.
Logout URL This is used if the resource features a lockout for having too many sessions open.
 

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 2-Step Authentication.
  7. Fill in the fields, as described above in the Required Fields table.
  8. Click Get data.
  9. 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.
  10. Click Continue.
  11. Name, choose refresh settings, and, optionally, share your data source.
  12. Click Save.
 

Related articles