Create a custom connector with Maia

You can use Maia to create a custom connector for any API that has a publicly viewable documentation page. For best results, the documentation should be a static HTML page that clearly lists the available endpoints, methods, and parameters.

When you provide a link to the documentation, Maia reads the content of that page as well as any directly linked sub-pages under the same path. For example, if you provide a link such as https://api.com/docs, Maia will also access related pages like https://api.com/docs/endpoints, but it won't follow links outside that documentation path (such as https://api.com/blog or https://api.com/other).

Maia also detects whether the API requires authentication. If authentication is required, Maia prompts you to choose the appropriate method (such as API Key, Basic Auth, Bearer Token, or OAuth) and to enter the required credentials.

---

How to create a custom connector with Maia

This how-to guide show the steps to create a custom connector using Maia in the Data Productivity Cloud. The process is straightforward and requires no coding skills. The API used in this example is a Matillion GreenWave API, which requires an API Key for authentication.

1. Log in to the Data Productivity Cloud.
2. In the left navigation, click the Custom Connectors icon and then click Custom Connectors.
3. Copy and paste the URL of the documentation for the API you want to connect to into the Maia URL input field, beneath the Add a custom connector with Maia message.

4. Click Build. Maia will begin scanning the documentation.

   

5. If Maia detects API endpoints that can be imported, it will prompt you to choose which endpoints to include in your custom connector. Select the checkboxes next to the endpoints you want to include, and then click Import.

   1. Select the top-most checkbox to select all endpoints.

   

6. Select your authentication method and enter the required credentials. If the API does not require authentication, select No Auth.

7. Click Send.

   Note

   Your authenticaton credentials are used only for test requests and are not saved in the connector.

   

8. Maia will complete the following tasks:

   1. Import the selected endpoints.
   2. Apply authentication to the selected endpoints.
   3. Populate any required parameters.
   4. Send test requests.

9. Once Maia has completed these tasks, the Custom Connector workbench will open, displaying the imported endpoints and their details. You can review and edit the endpoints as needed.

   Note

   Remember to refer to the third-party API documentation for details about the endpoints and their parameters.

   

10. Click Save to save your custom connector.

    Note

    If you need to make changes to the connector after saving, you can reopen it from the Custom Connectors list and edit it as needed.