Setup OAuth for DPC API in Custom Connector

Matillion's API provides data engineers and architects with a structured interface to interact programmatically with the Matillion Data Productivity Cloud.

Following a RESTful architecture, the API employs a resource-based URL format and requires form-encoded data for interactions. All the API responses are in JSON format, and HTTP response codes are used to provide clear communication about request statuses.

This article describes how to connect to the Matillion Data Productivity Cloud API using a Custom Connector. This can help deal with authentication methods, including bearer tokens, to ensure secure access to the API and help streamline integration and operations within your data workflows.

Part 1: Setup OAuth for DPC API in Custom Connector

Create DPC API Credentials for the account

• Read the reference guide on authenticating to the Matillion API
• Follow Step 1 from the above document to generate new API Credentials and capture and save the Client ID and Client Secret

Create OAuth Entry for DPC API to use with Custom Connector

• Navigate to Custom Connectors from the Hub menu

• Go to the OAuth tab and click “Add OAuth”

• Fill in the values as below:
  • Grant Type: Client Credentials
  • Client ID: <enter the value captured when creating API Credentials>
  • Client Secret: <enter the value captured when creating API Credentials>
  • Access Token URL: https://id.core.matillion.com/oauth/dpc/token
  • Token Parameters: no change is needed

• Click on Authorize
• If the credentials are valid, the OAuth will be authorized successfully and show up in the list on the OAuth tab.

With OAuth set up, you have completed the first step toward connecting the Matillion API via Custom Connectors. This allows secure API access, paving the way for further integration with your data workflows. Check out part two, where we’ll explore setting up custom endpoints for the DPC API! 

Part Three: Setting up OAuth in Designer Project to use the DPC API Custom Connector Endpoints

Part Four: Pipeline Execution and Status Retrieval Framework