Skip to content

Commit f4de2bd

Browse files
authored
Sync August connector docs and add connection docs (#5)
* Sync August connector docs * Pull in connection docs if they exist * Generate connector docs with connection-specific information
1 parent 7a03383 commit f4de2bd

File tree

156 files changed

+3964
-395
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

156 files changed

+3964
-395
lines changed

docs/connectors/adobe-acrobat-sign.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,28 @@ Adobe Acrobat Sign is an e-signature management solution. Use the Adobe Acrobat
1313

1414
OAuth 2.0 flow
1515

16+
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)
17+
18+
1. [Log in to Acrobat Sign](https://secure.adobesign.com/public/login).
19+
2. Select **API** from the top menu. If you do not see the **API** link, select **Account**
20+
3. Select **API Applications.**
21+
4. Select the **Create** (+) icon at the top right of the table and provide details about your app.
22+
5. Choose a domain based on the intended use:
23+
6. **CUSTOMER**: Apps that only access your account or are used for internal use and testing.
24+
7. **PARTNER**: Select this type if you're developing an application for other users and your app needs access to other Acrobat Sign accounts.
25+
Note: PARTNER applications [must be certified](https://www.adobe.com/go/esign-dev-cert) to have full access to other accounts.
26+
27+
To Retrieve the OAuth [Client ID and Secret:](https://opensource.adobe.com/acrobat-sign/developer_guide/gstarted.html#configure-oauth)
28+
29+
1. In the API Applications menu, select the application.
30+
2. Click **Configure OAuth for the Application** link to configure your OAuth integration.
31+
3. For the redirect URI enter `https://oauth2.%WHITE_LABEL_BASE_URL%/callback`.
32+
4. check the boxes for the necessary scopes needed with the modifier set to `account` for the integration and save.
33+
5. in the API Applications menu, select the application and select View / Edit.
34+
6. Enter the Application ID/Client ID and Client Secret Values into the connection configuration of the integration.
35+
7. Client ID and Application ID are the same value and can be used interchangeably.
36+
8. Enter the scopes
37+
1638
This connection uses OAuth 2.0, a common authentication mechanism for integrations.
1739
Read about how OAuth 2.0 works [here](../oauth2.md).
1840

docs/connectors/adobe-analytics.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,17 @@ Manage companies, report suites, metrics, dimensions and more within Adobe Analy
1313

1414
Connect to Adobe Analytics via OAuth 2.0
1515

16+
To create an Adobe Analytics OAuth 2.0 app, first visit the [Adobe Developer Console](https://developer.adobe.com/console/).
17+
18+
- Create a new project
19+
- Add the Adobe Analytics API to the project
20+
- 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
21+
- For **Redirect URI** enter `https://oauth2.%WHITE_LABEL_BASE_URL%/callback`
22+
- For **Redirect URI Pattern** enter your OAuth 2.0's base URL (minus the `/callback` portion).
23+
- Take note of your **Client ID** and **Client Secret**
24+
25+
Enter your client ID and client secret when you create an Adobe Analytics connection.
26+
1627
This connection uses OAuth 2.0, a common authentication mechanism for integrations.
1728
Read about how OAuth 2.0 works [here](../oauth2.md).
1829

docs/connectors/adobe-commerce-magento.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,18 @@ Adobe Commerce (Magento) is an open-source e-commerce platform. Use the Adobe Co
1313

1414
Adobe Commerce API Access Key
1515

16+
The Marketplace EQP API uses a two-step process to authenticate a client application and authorize access to resources:
17+
18+
1. Using your [API access key](https://developer.adobe.com/commerce/marketplace/guides/eqp/v1/access-keys/), obtain a session token.
19+
2. You create your API access key from one, or both, of the **Marketplace Developer Portal** user interfaces:
20+
1. production - [https://commercedeveloper.adobe.com](https://commercedeveloper.adobe.com/)
21+
2. sandbox - [https://commercedeveloper-sandbox.adobe.com](https://commercedeveloper-sandbox.adobe.com/)
22+
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.
23+
4. From the left-hand side navigation menu, click on **Manage API Keys**.
24+
5. Click **Create API Access Key**.
25+
6. In the "Create New API Key" dialog, enter an **API Key Name**. This name is for your own use. Then, click **Continue**.
26+
7. Enter this API Key value into your connection configuration.
27+
1628
| Input | Comments | Default |
1729
| -------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | ------- |
1830
| Application ID | https://developer.adobe.com/commerce/marketplace/guides/eqp/v1/access-keys/#what-is-an-api-access-key | |

docs/connectors/adobe-io-events.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,24 @@ Adobe I/O Events notifies you when changes occur. Use the Adobe I/O Events compo
1313

1414
Adobe I/O Connection
1515

16+
To establish an OAuth connection for your Adobe integration, follow these steps:
17+
18+
1. Visit the Adobe Developer Console projects page by navigating to [https://developer.adobe.com/console/projects](https://developer.adobe.com/console/projects).
19+
20+
2. Create a new project by clicking the appropriate option.
21+
22+
3. Click on "Add to project" to start configuring your project.
23+
24+
4. Add the "I/O Management API" to your project. This API enables access to Adobe I/O services.
25+
26+
5. Select "OAuth Server-to-Server authentication" as your preferred authentication method.
27+
28+
6. Generate an access token from the connected credentials section. This step will also provide you with the Client ID required for your integration.
29+
30+
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.
31+
32+
With these steps, you'll have set up an OAuth connection and obtained the necessary credentials for your Adobe I/O Events Component.
33+
1634
This connection uses OAuth 2.0, a common authentication mechanism for integrations.
1735
Read about how OAuth 2.0 works [here](../oauth2.md).
1836

docs/connectors/adp-workforce-now.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,15 @@ ADP Workforce Now is a comprehensive solution for managing HR, payroll, and labo
1313

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

16+
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.
17+
18+
This will also require access to the [Developer Self Service Portal](https://adpapps.adp.com/self-service)
19+
20+
1. From this page a project may be created to house the OAuth credentials needed for a successful connection
21+
2. Navigate to the **Development Credentials** tab and you should see your **Client ID** and **Client Secret** values.
22+
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`
23+
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)
24+
1625
| Input | Comments | Default |
1726
| --------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------- |
1827
| API Endpoint | The endpoint to use for the ADP Workforce Now API | https://api.adp.com/ |

docs/connectors/airtable.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,9 @@ Manage records, tables and bases in Airtable
1313

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

16+
Airtable API keys will be [deprecated on Feb 1, 2024](https://support.airtable.com/docs/airtable-api-key-deprecation-notice).
17+
Please elect to use OAuth 2.0 or personal access tokens instead.
18+
1619
| Input | Comments | Default |
1720
| ---------------- | --------------------------------------------------------------------------------------------------------------- | ------- |
1821
| Airtable Base ID | Visit https://airtable.com/api and select your workspace. The ID of your base will be printed for you in green. | |
@@ -22,6 +25,14 @@ Airtable API Key and Base ID. Will be deprecated on Feb 1, 2024
2225

2326
Connect your Airtable account using OAuth 2.0
2427

28+
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).
29+
30+
Register a new OAuth integration, and enter `https://oauth2.%WHITE_LABEL_BASE_URL%/callback` as the OAuth redirect URL.
31+
32+
Under **Scopes**, select all scopes that you'll need.
33+
Note which scopes you selected, along with the **Client ID** and **Client secret** that Airtable provides you.
34+
Enter scopes, client ID and client secret into the config wizard designer.
35+
2536
This connection uses OAuth 2.0, a common authentication mechanism for integrations.
2637
Read about how OAuth 2.0 works [here](../oauth2.md).
2738

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

3647
Connect your Airtable account using a personal access token
3748

49+
A **personal access token** can be used for testing an Airtable integration.
50+
You can create a personal access token at [airtable.com/create/tokens](https://airtable.com/create/tokens).
51+
3852
| Input | Comments | Default |
3953
| ------- | ------------------------------------------------------------------- | ------- |
4054
| API Key | You can generate an API key from https://airtable.com/create/tokens | |

docs/connectors/algolia.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,22 @@ Algolia is an advanced AI search platform.
1313

1414
Algolia API Key
1515

16+
**API Keys** are necessary for interacting with the Algolia API. API keys are unique to each application you create in Algolia.
17+
18+
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.
19+
20+
Algolia provides three types of API keys:
21+
22+
**Admin API Key**: This key has read and write rights on all indexing and configuration operations.
23+
24+
**Search-Only API Key**: This key has read-only rights on indexing operations and is recommended for use on the frontend.
25+
26+
**Secured API Key**: This key is generated from a search key and has additional rights defined at the time of generation.
27+
28+
For your integration, you will need both the Admin API Key and the Search-Only API Key.
29+
30+
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).
31+
1632
| Input | Comments | Default |
1733
| -------------- | --------------------------- | ------- |
1834
| API Key | Your Algolia API Key | |

docs/connectors/amazon-seller-central.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,33 @@ Amazon Seller Central is the portal for accessing your Amazon seller account. Us
1313

1414
Authenticate requests to Amazon Seller Central.
1515

16+
**To register your application (for all public applications and private seller applications)**
17+
18+
1. Sign into Seller Central using your developer credentials and navigate to [Develop Apps](https://sellercentral.amazon.com/sellingpartner/developerconsole).
19+
2. On the **Developer Central** page, choose **Add new app client**.
20+
3. Enter the OAuth Redirect URI as `https://oauth2.%WHITE_LABEL_BASE_URL%/callback` and save
21+
4. Viewing the LWA credentials will provide the client ID and client secret to enter into your credentials
22+
23+
#### Amazon Seller Central Sandbox Environment
24+
25+
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.
26+
The expected values can be referenced under the [Selling Partner API Models](https://github.com/amzn/selling-partner-api-models/tree/f3b0bc6c3949f791589b079e78b341f13f954b41/models)
27+
28+
**Orders Example**
29+
30+
[Order Model Reference](https://github.com/amzn/selling-partner-api-models/blob/f3b0bc6c3949f791589b079e78b341f13f954b41/models/orders-api-model/ordersV0.json)
31+
32+
- Created After accepts **TEST_CASE_200** or **TEST_CASE_200_NEXT_TOKEN**
33+
- Created Before accepts **TEST_CASE_200** or **TEST_CASE_200_NEXT_TOKEN**
34+
- Order ID accepts **TEST_CASE_200**
35+
36+
**Notifications Example**
37+
38+
[Notifications Model Reference](https://github.com/amzn/selling-partner-api-models/blob/f3b0bc6c3949f791589b079e78b341f13f954b41/models/notifications-api-model/notifications.json)
39+
40+
- Subscription ID accepts **TEST_CASE_200_SUBSCRIPTION_ID**
41+
- Created Before accepts **TEST_CASE_200_DESTINATION_ID**
42+
1643
This connection uses OAuth 2.0, a common authentication mechanism for integrations.
1744
Read about how OAuth 2.0 works [here](../oauth2.md).
1845

docs/connectors/amqp.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,14 @@ Send and receive messages on an AMQP-based message broker
1313

1414
Authenticate requests to an amqp server
1515

16+
An AMQP connection is comprised of a host name (this can be an IP address or FQDN endpoint), port, protocol and vhost.
17+
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**.
18+
19+
AMQP often requires authentication (a username and password), but some AMQP servers are anonymous and do not require authentication.
20+
If the server you're interacting with is allows anonymous authentication, you can omit the **username** and **password** fields.
21+
22+
You can verify that your settings are correct using the this component's [Check AMQP Connection](#check-amqp-connection) action.
23+
1624
| Input | Comments | Default |
1725
| -------- | -------------------------------------------------------------------------- | ----------- |
1826
| Host | The IP address or endpoint of the AMQP server | 192.168.0.1 |

docs/connectors/anthropic.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,11 @@ Interact with Anthropic's Claude models
1313

1414
Connection to Anthropic's Claude API
1515

16+
To generate an API key:
17+
18+
1. Navigate to [API Keys](https://console.anthropic.com/settings/keys) and select **create key**
19+
2. Enter the API key value into the connection configuration of the integration.
20+
1621
| Input | Comments | Default |
1722
| ------- | ----------------------- | ------- |
1823
| API Key | Your Anthropic API key. | |

0 commit comments

Comments
 (0)