Custom API Connector

Overview

OpenAPI Integrations let you connect an API to Couchdrop using an OpenAPI specification. Couchdrop imports the API schema and uses it to identify the authentication methods and API actions available from that specification.

This is useful when you need to connect Couchdrop to an API that is not already available as a predefined integration. You can import your own OpenAPI schema from a URL or start from one of the templates available in Couchdrop.

OpenAPI Integration is currently a Beta Feature.

How OpenAPI Integrations work with Couchdrop

An OpenAPI Integration is configured as a platform integration. You provide an OpenAPI schema, review the methods Couchdrop has imported, and then configure one of the authentication schemes defined by that API.

Once the schema has been imported, Couchdrop displays the API operations under Available actions. These actions can then be selected when working with the integration.

This follows Couchdrop's connection model of configuring an external platform first and then using the resulting connection within Couchdrop workflows.

How to create a Custom API connection

Before you start

To create an OpenAPI Integration, you will need:

• Access to Couchdrop with permission to create integrations
• An OpenAPI schema available from a URL, or one of the OpenAPI templates available in Couchdrop
• Authentication details required by the API specification

1

Create an OpenAPI Integration

Create a new OpenAPI Integration in Couchdrop.

Enter an Integration name to identify the connection.

2

Import an API schema

Under API Schema, select Import schema.

The Import OpenAPI Schema window provides two options:

• Use a template — Select one of the schemas provided by Couchdrop.
• Import from URL — Load an OpenAPI schema from a URL.

Select the schema you want to use and import it into the integration.

3

Review the imported schema

Select Review schema to open the Review & Edit OpenAPI Schema window.

This lets you modify the imported OpenAPI schema before saving the integration.

Review the schema to make sure it contains the API methods and authentication configuration you want Couchdrop to use.

4

Configure authentication

Under Authentication, select an authentication scheme available from the imported API schema.

The authentication methods shown here are determined by the schema you imported.

For example, when using the Couchdrop API template, the available authentication scheme includes:

• ApiKeyAuth (apiKey) — Used to authenticate requests to the Couchdrop API.

Configure the authentication information required by the selected scheme.

5

Review available actions

Under Available actions, Couchdrop lists the API operations imported from the OpenAPI schema.

Select an API method to view more information about that action.

For example, the Couchdrop API template includes:

List all users

• Method: GET
• Endpoint: /manage/credentials
• Description: Lists all users through the Couchdrop API.

The actions available for other OpenAPI integrations depend on the operations defined in their imported schemas.

6

Save the integration

Once you have reviewed the schema, configured authentication, and confirmed the required API actions are available, save the OpenAPI Integration.

The integration is now configured for use with the actions exposed by the imported OpenAPI specification.

OpenAPI Integration settings

Setting	Description
Integration name	Identifies the OpenAPI connection within Couchdrop.
API Schema	Defines the API operations and authentication methods available to the integration. Use Import schema to load a schema from a template or URL, or Review schema to inspect and modify the imported specification before saving.
Authentication	Displays the authentication schemes defined by the imported OpenAPI specification. Available options depend on the schema you import.
Available actions	Lists the API methods discovered in the imported OpenAPI specification. Select an action to view more information, including its HTTP method and path where provided by the schema.

The authentication schemes and available actions shown in an OpenAPI Integration are determined by the schema you import.