Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(docs): add connect-ui docs #3106

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open
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
6 changes: 6 additions & 0 deletions docs-v2/integrations/all/affinity.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -34,3 +34,9 @@ API configuration: [`Affinity`](https://nango.dev/providers.yaml)
- For rate limit details, check out [Affinity](https://api-docs.affinity.co/#rate-limits).

<Note>Add Getting Started links and Gotchas by [editing this page](https://github.com/nangohq/nango/tree/master/docs-v2/integrations/all/affinity.mdx)</Note>

## Going further

<Card title="Connect to Affinity" icon="link" href="/integrations/all/affinity/connect" horizontal>
Guide to connect to Affinity using Connect UI
</Card>
Binary file added docs-v2/integrations/all/affinity/api_keys.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
37 changes: 37 additions & 0 deletions docs-v2/integrations/all/affinity/connect.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
title: Affinity - How do I link my account?
sidebarTitle: Affinity
---

# Overview

To authenticate with Affinity, you will need one key pieces of information:
1. **API Key** - A key that grants Nango permission to interact with Affinity's APIs resources and services.

This guide will walk you through finding or generating the API Key within Affinity.

### Prerequisites:

- You must have a registered account with Affinity.
- Permission to generate an **API Key**.

### Instructions:

#### Step 1: Finding Your API Key
1. **Log in** to your Affinity dashboard and click **Settings** on the left-side of your screen.
<img src="/integrations/all/affinity/settings.avif" />
2. Click on the **API** tab, then click on **Generate new API key**.
<img src="/integrations/all/affinity/api_keys.png" />


#### Step 2: Enter credentials in the Connect UI

Once you have the **API Key**:
1. Open the form where you need to authenticate with Affinity.
2. Enter the **API Key** in the designated field.
3. Submit the form, and you should be successfully authenticated.


<img src="/integrations/all/affinity/form.png" style={{maxWidth: "450px" }}/>

You are now connected to Affinity.
Binary file added docs-v2/integrations/all/affinity/form.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs-v2/integrations/all/affinity/settings.avif
Binary file not shown.
8 changes: 7 additions & 1 deletion docs-v2/integrations/all/anrok.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,10 @@ API configuration: [`anrok`](https://nango.dev/providers.yaml)
- Anrok uses API_KEY auth mode with Authorization: Bearer `api_key` in the request header to access different endpoints.
- The default rate limit for a seller account is 10 requests per second.

<Note>Add Getting Started links and Gotchas by [editing this page](https://github.com/nangohq/nango/tree/master/docs-v2/integrations/all/anrok.mdx)</Note>
<Note>Add Getting Started links and Gotchas by [editing this page](https://github.com/nangohq/nango/tree/master/docs-v2/integrations/all/anrok.mdx)</Note>

## Going further

<Card title="Connect to Anrok" icon="link" href="/integrations/all/anrok/connect" horizontal>
Guide to connect to Anrok using Connect UI
</Card>
34 changes: 34 additions & 0 deletions docs-v2/integrations/all/anrok/connect.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
title: Anrok - How do I link my account?
sidebarTitle: Anrok
---

# Overview

To authenticate with Anrok, you will need one key pieces of information:
1. **API Key** - A key that grants Nango permission to interact with Anrok's APIs resources and services.

This guide will walk you through finding or generating the API Key within Anrok.

### Prerequisites:

- You must have a registered account with Anrok.

### Instructions:

#### Step 1: Finding Your API Key
1. **Log in** to your Anrok dashboard and navigate to the **Settings page**.
2. Click **Manage API keys**.
3. Click **New key**, then select **Create key**.

#### Step 2: Enter credentials in the Connect UI

Once you have the **API Key**:
1. Open the form where you need to authenticate with Anrok.
2. Enter the **API Key** in the designated field.
3. Submit the form, and you should be successfully authenticated.


<img src="/integrations/all/anrok/form.png" style={{maxWidth: "450px" }}/>

You are now connected to Anrok.
Binary file added docs-v2/integrations/all/anrok/form.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 7 additions & 1 deletion docs-v2/integrations/all/avalara.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,10 @@ API configuration: [`avalara`](https://nango.dev/providers.yaml), [`avalara-sand
- Avalara uses BASIC auth mode to access various AvaTax API endpoints. You can provide either a combination of your `username` and `password` or your `accountID` and `licensekey` to authenticate with the Avalara AvaTax API. The license key can be generated by an account administrator under Settings > Reset License Key.
- When creating a new connection on Nango, please provide the `avalaraClient`, which can help you diagnose and resolve issues with your software when used appropriately. This value is a combination of `(app name); (app version); (library name); (library version); (machine name)`. For more details, refer to [Client Headers](https://developer.avalara.com/avatax/client-headers/)

<Note>Add Getting Started links and Gotchas by [editing this page](https://github.com/nangohq/nango/tree/master/docs-v2/integrations/all/avalara.mdx)</Note>
<Note>Add Getting Started links and Gotchas by [editing this page](https://github.com/nangohq/nango/tree/master/docs-v2/integrations/all/avalara.mdx)</Note>

## Going further

<Card title="Connect to Avalara" icon="link" href="/integrations/all/avalara/connect" horizontal>
Guide to connect to Avalara using Connect UI
</Card>
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs-v2/integrations/all/avalara/avalara_keys.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
43 changes: 43 additions & 0 deletions docs-v2/integrations/all/avalara/connect.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
title: Avalara - How do I link my account?
sidebarTitle: Avalara
---


# Overview

To authenticate with Avalara, you will need three key pieces of information:
1. **User Name** - The User Name associated with your Avalara AvaTax account, used to authenticate API requests. Alternatively, you can use your **AccountID** instead of a **User Name**.
2. **Password** - The password linked to your Avalara AvaTax account, required for secure authentication. Alternatively, you can use your **License Key** instead of a **Password**.
3. **AvalaraClient** - A key that can help you diagnose and resolve issues with your software.

This guide will walk you through finding or generating the **Account ID/License Key** pair within Avalara.

### Prerequisites:

- You must have a registered account with Avalara.
- Only account administrators can generate the **Account ID/License Key** pair.

### Instructions:

#### Step 1: Finding Your Pair Keys
1. You can use your **username/password** pair for authentication, or alternatively, opt for the **Account ID/License Key** pair. To obtain the later credentials, **log in** to your Avalara dashboard.
2. Navigate to **Settings** and select **License and API Keys** to obtain both the **Account ID** and the **License Key**. Under the License Keys tab, click on **Generate New Keys** to create new credentials.
<img src="/integrations/all/avalara/avalara_keys.png" />

#### Step 2: Generating an Avalara Client
1. You can generate an Avalara Client by having a combination of **(app name); (app version); (library name); (library version); (machine name)**
<img src="/integrations/all/avalara/avalara_client.png" />


#### Step 3: Enter credentials in the Connect UI

Once you have these keys:
1. Open the form where you need to authenticate with Avalara.
2. Enter the **User Name**, **Password** and **Avalara Client** in their respective fields.
3. Submit the form, and you should be successfully authenticated.


<img src="/integrations/all/avalara/form.png" style={{maxWidth: "450px" }}/>

You are now connected to Avalara.
Binary file added docs-v2/integrations/all/avalara/form.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 7 additions & 1 deletion docs-v2/integrations/all/aws.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -66,4 +66,10 @@ API configuration: [`aws`](https://nango.dev/providers.yaml), [`aws-iam`](https:
return { authorizationHeader, date };
```
<Note>Add Getting Started links and Gotchas by [editing this page](https://github.com/nangohq/nango/tree/master/docs-v2/integrations/all/aws.mdx)</Note>
<Note>Add Getting Started links and Gotchas by [editing this page](https://github.com/nangohq/nango/tree/master/docs-v2/integrations/all/aws.mdx)</Note>
## Going further
<Card title="Connect to AWS-IAM" icon="link" href="/integrations/all/aws/connect" horizontal>
Guide to connect to AWS-IAM using Connect UI
</Card>
Binary file added docs-v2/integrations/all/aws/aws-profile.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs-v2/integrations/all/aws/aws_access_key.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
47 changes: 47 additions & 0 deletions docs-v2/integrations/all/aws/connect.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
---
title: AWS-IAM - How do I link my account?
sidebarTitle: AWS-IAM
---


# Overview

To authenticate with AWS-IAM, you will need two key pieces of information:
1. **Access Key ID** - This is a unique identifier that specifies the IAM user or role making the request.
2. **Secret Access Key** - This is a confidential key that acts as a password used to sign API requests made to AWS IAM services.

This guide will walk you through finding the API Key within AWS IAM.

### Prerequisites:

- You must have a registered account with AWS.

### Instructions:

#### Step 1: Finding Your pair keys
1. **Log in** to your AWS IAM console.
2. In the navigation bar on the upper right, select your user name, and then select **Security credentials**.
<img src="/integrations/all/aws/aws-profile.png" />

3. In the **Access keys** section, click **Create access key**. If you already have two access keys, this button is deactivated and you must delete an access key before you can create a new one.

<img src="/integrations/all/aws/aws_access_key.png" />
4. On the **Access key best practices & alternatives** page, choose your use case to learn about additional options which can help you avoid creating a long-term access key. If you determine that your use case still requires an access key, click **Other** and then click **Next**.
5. Once you are done, a pair of both **Access** and **Secret Access** keys will be generated.
<img src="/integrations/all/aws/keys.png" />

#### Step 2: Finding Your region host
1. You can obtain this directly from the web address bar.
<img src="/integrations/all/aws/region.png" />

#### Step 3: Enter credentials in the Connect UI

Once you have these keys and the region:
1. Open the form where you need to authenticate with AWS-IAM.
2. Enter the **Access Key ID**, **Secret Access Key**, and **Region** in their respective fields.
3. Submit the form, and you should be successfully authenticated.


<img src="/integrations/all/aws/form.png" style={{maxWidth: "450px" }}/>

You are now connected to AWS IAM.
Binary file added docs-v2/integrations/all/aws/form.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs-v2/integrations/all/aws/keys.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs-v2/integrations/all/aws/region.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 6 additions & 0 deletions docs-v2/integrations/all/bamboohr.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -56,3 +56,9 @@ For more details, see the [docs here](/guides/getting-started/authorize-an-api-f


<Note>Add Getting Started links and Gotchas by [editing this page](https://github.com/nangohq/nango/tree/master/docs-v2/integrations/all/bamboohr.mdx)</Note>

## Going further

<Card title="Connect to BambooHR (basic auth)" icon="link" href="/integrations/all/bamboohr/connect" horizontal>
Guide to connect to BambooHR (basic auth) using Connect UI
</Card>
Binary file added docs-v2/integrations/all/bamboohr/account.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs-v2/integrations/all/bamboohr/api_keys.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
42 changes: 42 additions & 0 deletions docs-v2/integrations/all/bamboohr/connect.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
title: BambooHR (basic auth) - How do I link my account?
sidebarTitle: BambooHR (basic auth)
---

# Overview

To authenticate with BambooHR (basic auth), you will need two key pieces of information:
1. **Subdomain** - The subdomain used to access your BambooHR account.
2. **API Key** - A key that grants Nango permission to interact with BambooHR APIs resources and services.


This guide will walk you through generating or finding both the API Key and subdomain within BambooHR.

### Prerequisites:

- You must have a registered account with BambooHR.
- Sufficient permission to view the **API Keys**.

### Instructions:

#### Step 1: Finding Your subdomain
- The subdomain is the same one used when **Logging in** to your BambooHR account.


#### Step 2: Finding Your API Key
1. **Log in** to your BambooHR account and click on **My Account** in the bottom-left corner.
2. From the menu that appears, select **API Keys** to view existing keys or add new ones.
<img src="/integrations/all/bamboohr/account.png" />
<img src="/integrations/all/bamboohr/api_keys.png" />

#### Step 3: Enter credentials in the Connect UI

Once you have the **API Key** and **Subdomain**:
1. Open the form where you need to authenticate with BambooHR (basic auth).
2. Enter your **Subdomain** and **API Key** in their respective fields.
3. Submit the form, and you should be successfully authenticated.


<img src="/integrations/all/bamboohr/form.png" style={{maxWidth: "450px" }}/>

You are now connected to BambooHR (basic auth).
Binary file added docs-v2/integrations/all/bamboohr/form.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 7 additions & 0 deletions docs-v2/integrations/all/brex.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -37,3 +37,10 @@ Brex offers both Basic auth `API key` and OAuth as authentication and Nango impl
- Brex offers a staging system to test your apps, you will get access when you register as a partner. Staging details are [here](https://developer.brex.com/docs/partner_authentication/#api-servers)

<Note>Add Getting Started links and Gotchas by [editing this page](https://github.com/nangohq/nango/tree/master/docs-v2/integrations/all/brex.mdx)</Note>


## Going further

<Card title="Connect to Brex (api key)" icon="link" href="/integrations/all/brex/connect" horizontal>
Guide to connect to Brex (api key) using Connect UI
</Card>
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs-v2/integrations/all/brex/auth-token.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
40 changes: 40 additions & 0 deletions docs-v2/integrations/all/brex/connect.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
title: Brex (api key) - How do I link my account?
sidebarTitle: Brex (api key)
---

# Overview

To authenticate with Brex (api key), you will need one key pieces of information:
1. **Api Token** - A key that grants Nango permission to interact with Brex APIs resources and services.

This guide will walk you through finding or generating the Api Token within Brex.

### Prerequisites:

- You must have a registered account with Brex.

### Instructions:

#### Step 1: Finding Your API Token
1. **Log in** to your Brex account as an account admin.
2. Go to **Developer** > **Settings**.
3. Click **Create Token**.
4. Create a **Name** for your token then choose what level of data access you need for your application; these are the **scopes** your token will have.
<img src="/integrations/all/brex/auth-create-token.png" style={{maxWidth: "450px" }}/>
5. The next screen will confirm your previous selections. Make sure it looks good, then click **Allow Access**.
<img src="/integrations/all/brex/auth-allow-access.png" style={{maxWidth: "450px" }}/>
6. Your token is now created.
<img src="/integrations/all/brex/auth-token.png" style={{maxWidth: "450px" }}/>

#### Step 2: Enter credentials in the Connect UI

Once you have your **API Token**:
1. Open the form where you need to authenticate with Brex (api key).
2. Enter the **API Token** in the designated field.
3. Submit the form, and you should be successfully authenticated.


<img src="/integrations/all/brex/form.png" style={{maxWidth: "450px" }}/>

You are now connected to Brex.
Binary file added docs-v2/integrations/all/brex/form.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 7 additions & 1 deletion docs-v2/integrations/all/brightcrowd.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,10 @@ API configurations: [`brightcrowd`](https://nango.dev/providers.yaml)
- BrightCrowd API handles two main resources, `Book` and `Page`.
- Different auth scopes are required for different requests. To find the exact scope needed for a specific request, please refer to the Security Scopes section, such as the [Request](https://brightcrowd.com/partner-api#/operations/listBooks#Request) for listing all books in the account.

<Note>Add Getting Started links and Gotchas by [editing this page](https://github.com/nangohq/nango/tree/master/docs-v2/integrations/all/brightcrowd.mdx)</Note>
<Note>Add Getting Started links and Gotchas by [editing this page](https://github.com/nangohq/nango/tree/master/docs-v2/integrations/all/brightcrowd.mdx)</Note>

## Going further

<Card title="Connect to BrightCrowd" icon="link" href="/integrations/all/brightcrowd/connect" horizontal>
Guide to connect to BrightCrowd using Connect UI
</Card>
35 changes: 35 additions & 0 deletions docs-v2/integrations/all/brightcrowd/connect.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
title: BrightCrowd - How do I link my account?
sidebarTitle: BrightCrowd
---


# Overview

To authenticate with BrightCrowd, you need two key pieces of information:
1. **Client ID** - A unique identifier for your client.
2. **Client Secret** - A confidential key used to authenticate the identity of the application (client).

This guide will walk you through obtaining these credentials within BrightCrowd.

### Prerequisites:

- You must have an account with BrightCrowd.

### Instructions:

#### Step 1: Requesting API credentials
1. Please reach out to the team on their [website](https://brightcrowd.com) to obtain both **Client ID** and **Client Secret** secrets.

#### Step 2: Enter credentials in the Connect UI

Once you have both the **Client ID** and **Client Secret**:
1. Open the form where you need to authenticate with BrightCrowd.
2. Enter the **Client ID** and **Client Secret** in their designated fields.
3. Submit the form, and you should be successfully authenticated.


<img src="/integrations/all/brightCrowd/form.png" style={{maxWidth: "450px" }}/>

You are now connected to BrightCrowd.

Binary file added docs-v2/integrations/all/brightcrowd/form.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 6 additions & 0 deletions docs-v2/integrations/all/builder-io.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,3 +29,9 @@ API configuration: [`builder-io-private`](https://nango.dev/providers.yaml), [`b
- Builder.io has two different sets of API keys for its various APIs. For the `content` API, a public API key is required, while the `write` API requires a private API key. For more details, please refer to the specific API documentation.

<Note>Add Getting Started links and Gotchas by [editing this page](https://github.com/nangohq/nango/tree/master/docs-v2/integrations/all/builder-io.mdx)</Note>

## Going further

<Card title="Connect to Builder.io" icon="link" href="/integrations/all/builder-io/connect" horizontal>
Guide to connect to Builder.io using Connect UI
</Card>
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Loading