Recurly Extract Authentication Guide

Recurly Extract Authentication Guide


Overview

This is a step-by-step guide to acquiring credentials and authorising the Recurly Extract connector for use in Matillion ETL.

Important Information

  • The Recurly Extract connector uses an API token for third-party authentication.
  • While connector properties may differ between Cloud Data Warehouses, the authentication process remains the same.

Acquiring Third-Party Credentials

  1. Navigate to the Recurly website and click LOG IN in the top left of the screen. The browser will then redirect to a login screen. Enter valid login credentials to continue.

    Recurly homepage

    Recurly homepage

  2. Once logged in, click IntegrationsAPI Credentials on the sidebar on the left.

    Recurly dashboard

    Recurly dashboard

  3. In the API credentials window, click Add Private API Key (found either at the bottom of the window or on the top right and of the screen).

    API Credentials page

    API Credentials page

  4. Next, the Add Private API Key window will open. Provide a name for the API Key in the KEY NAME field, then click Save Changes.

    Add Private API Key

    Add Private API Key

  5. The browser will return to the API credentials window. The new API key should now be at the top of the window. Copy the API key from the list as it will be required in Authorising for use in Matillion ETL.

    Please Note

    When copying the API key, some browsers may add a space to the end of the code. Watch out for this as it will cause the credentials to fail.

    Create API key

    Copy the API key


Authorising for Use in Matillion ETL

  1. If a Recurly Extract connector has not already been dragged onto the job canvas, search "Recurly" using the Components panel search field, or find the Recurly Extract connector under OrchestrationLoad/UnloadFinance.

    Please Note

    An Orchestration Job must be open on the job canvas within Matillion ETL to ensure the Recurly Extract connector is searchable within the Components panel.

  2. Then, click and drag the Recurly Extract connector onto the job canvas.

    Search for Recurly Extract connector

    Search for Recurly Extract connector

  3. Click the connector icon on the job canvas to open the Properties panel at the bottom of the screen.

  4. Then, click ... next to the Api Key input.

    Open Recurly Extract connector properties

    Open Recurly Extract connector properties

  5. In the Api Key pop-up window, paste the API key (copied from the Recurly website earlier) into the Store in component field and click OK.

    Please Note

    Passwords and codes can also be saved using the Matillion ETL Password Manager. To learn how to do this, please refer to the Manager Passwords article.

    Paste the API Key

    Paste the API Key

  6. If the API Key is entered correctly, the connector should be authenticated and the status of the input will be displayed as OK.

    Connector successfully authenticated

    Connector successfully authenticated