Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions docs/connectors/adobe-acrobat-sign.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,28 @@ Adobe Acrobat Sign is an e-signature management solution. Use the Adobe Acrobat

OAuth 2.0 flow

To configure OAuth for Sign, begin by [creating an App:](https://opensource.adobe.com/acrobat-sign/developer_guide/gstarted.html#get-the-app-id-and-secret)

1. [Log in to Acrobat Sign](https://secure.adobesign.com/public/login).
2. Select **API** from the top menu. If you do not see the **API** link, select **Account**
3. Select **API Applications.**
4. Select the **Create** (+) icon at the top right of the table and provide details about your app.
5. Choose a domain based on the intended use:
6. **CUSTOMER**: Apps that only access your account or are used for internal use and testing.
7. **PARTNER**: Select this type if you're developing an application for other users and your app needs access to other Acrobat Sign accounts.
Note: PARTNER applications [must be certified](https://www.adobe.com/go/esign-dev-cert) to have full access to other accounts.

To Retrieve the OAuth [Client ID and Secret:](https://opensource.adobe.com/acrobat-sign/developer_guide/gstarted.html#configure-oauth)

1. In the API Applications menu, select the application.
2. Click **Configure OAuth for the Application** link to configure your OAuth integration.
3. For the redirect URI enter `https://oauth2.%WHITE_LABEL_BASE_URL%/callback`.
4. check the boxes for the necessary scopes needed with the modifier set to `account` for the integration and save.
5. in the API Applications menu, select the application and select View / Edit.
6. Enter the Application ID/Client ID and Client Secret Values into the connection configuration of the integration.
7. Client ID and Application ID are the same value and can be used interchangeably.
8. Enter the scopes

This connection uses OAuth 2.0, a common authentication mechanism for integrations.
Read about how OAuth 2.0 works [here](../oauth2.md).

Expand Down
11 changes: 11 additions & 0 deletions docs/connectors/adobe-analytics.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,17 @@ Manage companies, report suites, metrics, dimensions and more within Adobe Analy

Connect to Adobe Analytics via OAuth 2.0

To create an Adobe Analytics OAuth 2.0 app, first visit the [Adobe Developer Console](https://developer.adobe.com/console/).

- Create a new project
- Add the Adobe Analytics API to the project
- Select **User Authentication, OAuth** for the type of authentication you need, and then select **Web** for the type of application you're trying to integrate with Adobe
- For **Redirect URI** enter `https://oauth2.%WHITE_LABEL_BASE_URL%/callback`
- For **Redirect URI Pattern** enter your OAuth 2.0's base URL (minus the `/callback` portion).
- Take note of your **Client ID** and **Client Secret**

Enter your client ID and client secret when you create an Adobe Analytics connection.

This connection uses OAuth 2.0, a common authentication mechanism for integrations.
Read about how OAuth 2.0 works [here](../oauth2.md).

Expand Down
12 changes: 12 additions & 0 deletions docs/connectors/adobe-commerce-magento.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,18 @@ Adobe Commerce (Magento) is an open-source e-commerce platform. Use the Adobe Co

Adobe Commerce API Access Key

The Marketplace EQP API uses a two-step process to authenticate a client application and authorize access to resources:

1. Using your [API access key](https://developer.adobe.com/commerce/marketplace/guides/eqp/v1/access-keys/), obtain a session token.
2. You create your API access key from one, or both, of the **Marketplace Developer Portal** user interfaces:
1. production - [https://commercedeveloper.adobe.com](https://commercedeveloper.adobe.com/)
2. sandbox - [https://commercedeveloper-sandbox.adobe.com](https://commercedeveloper-sandbox.adobe.com/)
3. From the **Marketplace Developer Portal**, sign in, click on your name (top, right corner), and choose either the **Account Information** or the **Marketplace Profile** link.
4. From the left-hand side navigation menu, click on **Manage API Keys**.
5. Click **Create API Access Key**.
6. In the "Create New API Key" dialog, enter an **API Key Name**. This name is for your own use. Then, click **Continue**.
7. Enter this API Key value into your connection configuration.

| Input | Comments | Default |
| -------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | ------- |
| Application ID | https://developer.adobe.com/commerce/marketplace/guides/eqp/v1/access-keys/#what-is-an-api-access-key | |
Expand Down
18 changes: 18 additions & 0 deletions docs/connectors/adobe-io-events.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,24 @@ Adobe I/O Events notifies you when changes occur. Use the Adobe I/O Events compo

Adobe I/O Connection

To establish an OAuth connection for your Adobe integration, follow these steps:

1. Visit the Adobe Developer Console projects page by navigating to [https://developer.adobe.com/console/projects](https://developer.adobe.com/console/projects).

2. Create a new project by clicking the appropriate option.

3. Click on "Add to project" to start configuring your project.

4. Add the "I/O Management API" to your project. This API enables access to Adobe I/O services.

5. Select "OAuth Server-to-Server authentication" as your preferred authentication method.

6. Generate an access token from the connected credentials section. This step will also provide you with the Client ID required for your integration.

7. In the Project overview view, you can download the project configuration JSON file. This file contains various values such as Organization ID, Project ID, and Workspace ID, which are essential for using the actions within your integration.

With these steps, you'll have set up an OAuth connection and obtained the necessary credentials for your Adobe I/O Events Component.

This connection uses OAuth 2.0, a common authentication mechanism for integrations.
Read about how OAuth 2.0 works [here](../oauth2.md).

Expand Down
9 changes: 9 additions & 0 deletions docs/connectors/adp-workforce-now.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,15 @@ ADP Workforce Now is a comprehensive solution for managing HR, payroll, and labo

This connection allows you to authenticate with ADP Workforce Now using OAuth 2.0.

In order to complete an OAuth 2.0 connection to ADP Workforce Now, a Client ID and Client Secret must be provided in the integration. These credentials may be obtained by contacting your ADP client representative.

This will also require access to the [Developer Self Service Portal](https://adpapps.adp.com/self-service)

1. From this page a project may be created to house the OAuth credentials needed for a successful connection
2. Navigate to the **Development Credentials** tab and you should see your **Client ID** and **Client Secret** values.
3. Switch from the **Data Connector** tab to the **End-user/SSO** and in the App redirect URI field enter `https://oauth2.%WHITE_LABEL_BASE_URL%/callback`
4. **Certificate File** and **Key File** may be obtained by following this [Certificate Signing Request Guide](https://developers.adp.com/learn/how-to-articles/generate-a-certificate-signing-request#overview)

| Input | Comments | Default |
| --------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------- |
| API Endpoint | The endpoint to use for the ADP Workforce Now API | https://api.adp.com/ |
Expand Down
14 changes: 14 additions & 0 deletions docs/connectors/airtable.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,9 @@ Manage records, tables and bases in Airtable

Airtable API Key and Base ID. Will be deprecated on Feb 1, 2024

Airtable API keys will be [deprecated on Feb 1, 2024](https://support.airtable.com/docs/airtable-api-key-deprecation-notice).
Please elect to use OAuth 2.0 or personal access tokens instead.

| Input | Comments | Default |
| ---------------- | --------------------------------------------------------------------------------------------------------------- | ------- |
| Airtable Base ID | Visit https://airtable.com/api and select your workspace. The ID of your base will be printed for you in green. | |
Expand All @@ -22,6 +25,14 @@ Airtable API Key and Base ID. Will be deprecated on Feb 1, 2024

Connect your Airtable account using OAuth 2.0

To create an OAuth 2.0 app in Airtable, first log in to Airtable and then visit [airtable.com/create/oauth](https://airtable.com/create/oauth).

Register a new OAuth integration, and enter `https://oauth2.%WHITE_LABEL_BASE_URL%/callback` as the OAuth redirect URL.

Under **Scopes**, select all scopes that you'll need.
Note which scopes you selected, along with the **Client ID** and **Client secret** that Airtable provides you.
Enter scopes, client ID and client secret into the config wizard designer.

This connection uses OAuth 2.0, a common authentication mechanism for integrations.
Read about how OAuth 2.0 works [here](../oauth2.md).

Expand All @@ -35,6 +46,9 @@ Read about how OAuth 2.0 works [here](../oauth2.md).

Connect your Airtable account using a personal access token

A **personal access token** can be used for testing an Airtable integration.
You can create a personal access token at [airtable.com/create/tokens](https://airtable.com/create/tokens).

| Input | Comments | Default |
| ------- | ------------------------------------------------------------------- | ------- |
| API Key | You can generate an API key from https://airtable.com/create/tokens | |
Expand Down
16 changes: 16 additions & 0 deletions docs/connectors/algolia.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,22 @@ Algolia is an advanced AI search platform.

Algolia API Key

**API Keys** are necessary for interacting with the Algolia API. API keys are unique to each application you create in Algolia.

To generate an **API Key**, you should log into Algolia and navigate to your application page. Within the application settings, you can find your API keys.

Algolia provides three types of API keys:

**Admin API Key**: This key has read and write rights on all indexing and configuration operations.

**Search-Only API Key**: This key has read-only rights on indexing operations and is recommended for use on the frontend.

**Secured API Key**: This key is generated from a search key and has additional rights defined at the time of generation.

For your integration, you will need both the Admin API Key and the Search-Only API Key.

For more information about API keys, refer to the [Algolia Docs](https://www.algolia.com/doc/guides/sending-and-managing-data/prepare-your-data/#how-to-get-your-api-keys).

| Input | Comments | Default |
| -------------- | --------------------------- | ------- |
| API Key | Your Algolia API Key | |
Expand Down
27 changes: 27 additions & 0 deletions docs/connectors/amazon-seller-central.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,33 @@ Amazon Seller Central is the portal for accessing your Amazon seller account. Us

Authenticate requests to Amazon Seller Central.

**To register your application (for all public applications and private seller applications)**

1. Sign into Seller Central using your developer credentials and navigate to [Develop Apps](https://sellercentral.amazon.com/sellingpartner/developerconsole).
2. On the **Developer Central** page, choose **Add new app client**.
3. Enter the OAuth Redirect URI as `https://oauth2.%WHITE_LABEL_BASE_URL%/callback` and save
4. Viewing the LWA credentials will provide the client ID and client secret to enter into your credentials

#### Amazon Seller Central Sandbox Environment

When connecting to the Sandbox environment, it is important to know that some fields will require different value formats than Production in order to succeed.
The expected values can be referenced under the [Selling Partner API Models](https://github.com/amzn/selling-partner-api-models/tree/f3b0bc6c3949f791589b079e78b341f13f954b41/models)

**Orders Example**

[Order Model Reference](https://github.com/amzn/selling-partner-api-models/blob/f3b0bc6c3949f791589b079e78b341f13f954b41/models/orders-api-model/ordersV0.json)

- Created After accepts **TEST_CASE_200** or **TEST_CASE_200_NEXT_TOKEN**
- Created Before accepts **TEST_CASE_200** or **TEST_CASE_200_NEXT_TOKEN**
- Order ID accepts **TEST_CASE_200**

**Notifications Example**

[Notifications Model Reference](https://github.com/amzn/selling-partner-api-models/blob/f3b0bc6c3949f791589b079e78b341f13f954b41/models/notifications-api-model/notifications.json)

- Subscription ID accepts **TEST_CASE_200_SUBSCRIPTION_ID**
- Created Before accepts **TEST_CASE_200_DESTINATION_ID**

This connection uses OAuth 2.0, a common authentication mechanism for integrations.
Read about how OAuth 2.0 works [here](../oauth2.md).

Expand Down
8 changes: 8 additions & 0 deletions docs/connectors/amqp.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,14 @@ Send and receive messages on an AMQP-based message broker

Authenticate requests to an amqp server

An AMQP connection is comprised of a host name (this can be an IP address or FQDN endpoint), port, protocol and vhost.
For example, if you are told that your AMQP server is hosted at `amqps://amqp.example.com:5672/example/vhost`, enter `amqp.example.com` for the **host**, and `5672` for the **port**, select `AMQPS` for the **protocol**, and enter `example/vhost` for the **vhost**.

AMQP often requires authentication (a username and password), but some AMQP servers are anonymous and do not require authentication.
If the server you're interacting with is allows anonymous authentication, you can omit the **username** and **password** fields.

You can verify that your settings are correct using the this component's [Check AMQP Connection](#check-amqp-connection) action.

| Input | Comments | Default |
| -------- | -------------------------------------------------------------------------- | ----------- |
| Host | The IP address or endpoint of the AMQP server | 192.168.0.1 |
Expand Down
5 changes: 5 additions & 0 deletions docs/connectors/anthropic.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,11 @@ Interact with Anthropic's Claude models

Connection to Anthropic's Claude API

To generate an API key:

1. Navigate to [API Keys](https://console.anthropic.com/settings/keys) and select **create key**
2. Enter the API key value into the connection configuration of the integration.

| Input | Comments | Default |
| ------- | ----------------------- | ------- |
| API Key | Your Anthropic API key. | |
Expand Down
10 changes: 10 additions & 0 deletions docs/connectors/arcgis.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,16 @@ Use the Esri ArcGIS component to manage map layers, and update locations.

OAuth 2.0 connection for ArcGIS

ArcGIS requires a Developer Account to create applications for OAuth.

To obtain Oauth credentials:

1. Navigate to https://developers.arcgis.com/dashboard/.
2. Navigate to the Oauth 2.0 section and select + New Application.
3. Once application is created document your Client ID, Client Secret, and Temporary Token.
4. In the Redirect URLs section select + Add URI and enter `https://oauth2.%WHITE_LABEL_BASE_URL%/callback`.
5. Enter the Client ID, Client Secret, and Temporary Token in the designated fields of your integration connection configuration.

This connection uses OAuth 2.0, a common authentication mechanism for integrations.
Read about how OAuth 2.0 works [here](../oauth2.md).

Expand Down
4 changes: 4 additions & 0 deletions docs/connectors/arena-plm.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,10 @@ Interact with items and resources in Arena PLM

Arena PLM Basic Auth

Arena's API relies on basic authentication.
They recommend that you create a user dedicated to integrations with an email address and password.
In addition to email address and password, your customer will also need to know their **workspace ID**, which is a 9-digit number that they can find within Arena PLM.

| Input | Comments | Default |
| ---------------------- | -------- | ------------------------------ |
| Email Address | | |
Expand Down
17 changes: 17 additions & 0 deletions docs/connectors/asana.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,16 @@ Manage users, projects, and teams in your Asana workspace

### Asana OAuth 2.0 Connection

To make API requests of Asana on behalf of your customers you need to create an "OAuth app" within Asana.
Log in to Asana and then visit [app.asana.com/0/my-apps](https://app.asana.com/0/my-apps).

- Click **Create new app**
- Give your app a name and agree to Asana's terms and conditions
- Open **OAuth** from the left-hand menu and take note of the generated **Client ID** and **Client secret**
- Click **+ Add redirect URL** and enter `https://oauth2.%WHITE_LABEL_BASE_URL%/callback`

Finally, when creating your Asana integration update your Asana connection with the **Client ID** and **Client secret** that you noted.

This connection uses OAuth 2.0, a common authentication mechanism for integrations.
Read about how OAuth 2.0 works [here](../oauth2.md).

Expand All @@ -21,6 +31,13 @@ Read about how OAuth 2.0 works [here](../oauth2.md).

### Asana Personal Access Token

Developer **personal access tokens** can be used for development purposes, but you should use an [OAuth 2.0 connection](#asana-oauth-20-connection) when you deploy your integration (so your users can log in with their accounts).

To generate an **personal access token**, log in to Asana and open [app.asana.com/0/my-apps](https://app.asana.com/0/my-apps).
Then, click **+ Create new token**.

For more information on access tokens, refer to the [Asana Docs](https://developers.asana.com/docs/personal-access-token).

| Input | Comments | Default |
| --------------------- | --------------------------------------------------------------------------------------------------- | ------- |
| Personal Access Token | Log in to https://app.asana.com/0/my-apps to fetch a personal access token for development purposes | |
Expand Down
6 changes: 6 additions & 0 deletions docs/connectors/aspose.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,12 @@ Aspose is a robust file manipulation service that can manage various document an

Aspose Api Key Flow

In order to use the apiKey connection of Aspose, you need to provide both
the client_id and client_secret from your Aspose's application.
To access the Aspose's REST API, you need to create an application.
To register new applications, login into the [Aspose Developer Dashboard](https://dashboard.aspose.cloud/) site using your Aspose Account,
and go to the Applications view. Once you create a new application, Aspose will issue a client_id and client_secret.

| Input | Comments | Default |
| ------------------------- | ----------------------------------------- | ------- |
| Application Client ID | Client ID of your Aspose Application. | |
Expand Down
Binary file added docs/connectors/assets/azure-cosmos-db.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading