Skip to main content
Maia Team can help you create a custom connector to fetch data using a REST API that returns JSON data and 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 Team can read the content of that page and any linked sub-pages at the same path. For example, if you provide the link https://api.com/docs, Maia Team can also access pages like https://api.com/docs/endpoints. Maia Team also detects whether the API requires authentication. If authentication is required, Maia Team prompts you to choose the appropriate method (such as API Key, Basic Auth, Bearer Token, or OAuth) and to enter the required credentials. Instead of a link to public documentation, you can also upload the API documentation as a file. The file containing the API specification must be a PDF, YAML or JSON file up to 5 MB.
If the API documentation is too large, Maia Team may timeout after 10 minutes. If this happens, try linking to a smaller sub-section of the API documentation, or uploading a smaller file.

Video example

Creating a custom connector with Maia Team

Follow these steps to create a custom connector with Maia Team‘s help:
  1. In the left navigation, click and then click Custom Connectors.
  2. In the Custom connectors dashboard, provide the documentation for the API you want to connect to. Either:
    • Paste the URL into the Enter the link to your API documentation field.
    • Click Upload a PDF, JSON, or YAML file and select the file containing the API documentation.
  3. Click Build.
  4. In the Endpoints list, select the checkboxes for all the endpoints you want to include in your custom connector. Select the checkbox in the Endpoints header to select all available endpoints.
    This dialog lists all the API endpoints that Maia Team found using the API documentation you provided. If you can’t see an endpoint that you expected, make sure that the URL or file you provided includes all the endpoints you want to use, then try again. If the issue persists, you can add endpoints manually when the custom connector has been created.
  5. Click Import.
  6. In Authentication type, select the authentication method you want to use to connect to the data source, then enter the required credentials. If the API doesn’t require authentication, select No Auth.
    Your authentication credentials are only used for sending test requests to validate your custom connector configuration. They aren’t saved in the custom connector editor.The custom connector only saves the authentication type. When configuring your custom connector in Designer, you’ll provide your credentials as secrets.
  7. Click Send. Maia Team will import the selected endpoints, apply authentication and pagination where required, and add any required parameters.
  8. In the custom connector editor, review and edit the endpoints. For more information, read Creating custom connectors.
  9. Click Save.
Your custom connector is ready to be used in orchestration pipelines in Designer. It will appear in the list of available custom connectors in the Custom connectors dashboard, and can be added to orchestration pipelines in Designer like any other connector. For information about configuring custom connector properties in orchestration pipelines, read Custom connectors in Designer.