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.

Sign up for GitHub

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

Merged
merged 12 commits into from
Dec 6, 2024
Merged

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

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
a23894d
feat(docs): add connect-ui docs
Dec 3, 2024
cc84819
fix validation
Dec 3, 2024
5d4bc44
review
Dec 4, 2024
3e3ac98
review
Dec 4, 2024
fd1ad71
fix
Dec 4, 2024
5359930
Merge branch 'master' into kelvinwari/ext-266-add-connect-ui-document…
hassan254-prog Dec 4, 2024
7630c81
Merge branch 'master' into kelvinwari/ext-266-add-connect-ui-document…
hassan254-prog Dec 5, 2024
96c31ea
separate into specific folders
Dec 5, 2024
f6934da
improve
Dec 5, 2024
9a0d7b2
fix validtion
Dec 5, 2024
e422a67
review
Dec 6, 2024
0c6fc3c
review
Dec 6, 2024
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
Prev Previous commit
Next Next commit
review
  • Loading branch information
Hassan Wari authored and Hassan Wari committed Dec 4, 2024
commit 3e3ac988816dce1c7c4ca7923d2ee7c9cd7902b2
2 changes: 1 addition & 1 deletion docs-v2/integrations/all/aws.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,6 @@ API configuration: [`aws`](https://nango.dev/providers.yaml), [`aws-iam`](https:

## Going further

<Card title="Connect to AWS-IAM" icon="link" href="/integrations/all/aws-iam/connect" horizontal>
<Card title="Connect to AWS-IAM" icon="link" href="/integrations/all/aws/connect" horizontal>
Guide to connect to AWS-IAM using Connect UI
</Card>
0 .../integrations/all/aws-iam/aws-profile.png → docs-v2/integrations/all/aws/aws-profile.png
View file
Open in desktop
File renamed without changes
0 ...tegrations/all/aws-iam/aws_access_key.png → ...2/integrations/all/aws/aws_access_key.png
View file
Open in desktop
File renamed without changes
10 changes: 5 additions & 5 deletions docs-v2/integrations/all/aws-iam/connect.mdx → docs-v2/integrations/all/aws/connect.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,18 +21,18 @@ This guide will walk you through finding the API Key within AWS IAM.
#### 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-iam/aws-profile.png" />
<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-iam/aws_access_key.png" />
<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-iam/keys.png" />
<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-iam/region.png" />
<img src="/integrations/all/aws/region.png" />

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

Expand All @@ -42,6 +42,6 @@ Once you have these keys and the region:
3. Submit the form, and you should be successfully authenticated.


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

You are now connected to AWS IAM.
0 docs-v2/integrations/all/aws-iam/form.png → docs-v2/integrations/all/aws/form.png
View file
Open in desktop
File renamed without changes
0 docs-v2/integrations/all/aws-iam/keys.png → docs-v2/integrations/all/aws/keys.png
View file
Open in desktop
File renamed without changes
0 docs-v2/integrations/all/aws-iam/region.png → docs-v2/integrations/all/aws/region.png
View file
Open in desktop
File renamed without changes
2 changes: 1 addition & 1 deletion docs-v2/integrations/all/bamboohr.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,6 @@ For more details, see the [docs here](/guides/getting-started/authorize-an-api-f

## Going further

<Card title="Connect to BambooHR (basic auth)" icon="link" href="/integrations/all/bamboohr-basic/connect" horizontal>
<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>
0 ...tegrations/all/bamboohr-basic/account.png → ...-v2/integrations/all/bamboohr/account.png
View file
Open in desktop
File renamed without changes
0 ...egrations/all/bamboohr-basic/api_keys.png → ...v2/integrations/all/bamboohr/api_keys.png
View file
Open in desktop
File renamed without changes
11 changes: 6 additions & 5 deletions ...tegrations/all/bamboohr-basic/connect.mdx → ...-v2/integrations/all/bamboohr/connect.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,9 @@ sidebarTitle: BambooHR (basic auth)
# Overview

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

Expand All @@ -25,8 +26,8 @@ This guide will walk you through generating or finding both the API Key and subd
#### 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-basic/account.png" />
<img src="/integrations/all/bamboohr-basic/api_keys.png" />
<img src="/integrations/all/bamboohr/account.png" />
<img src="/integrations/all/bamboohr/api_keys.png" />

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

Expand All @@ -36,6 +37,6 @@ Once you have the **API Key** and **Subdomain**:
3. Submit the form, and you should be successfully authenticated.


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

You are now connected to BambooHR (basic auth).
0 .../integrations/all/bamboohr-basic/form.png → docs-v2/integrations/all/bamboohr/form.png
View file
Open in desktop
File renamed without changes
2 changes: 1 addition & 1 deletion docs-v2/integrations/all/brex.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,6 @@ Brex offers both Basic auth `API key` and OAuth as authentication and Nango impl

## Going further

<Card title="Connect to Brex (api key)" icon="link" href="/integrations/all/brex-api-key/connect" horizontal>
<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>
0 ...ns/all/brex-api-key/auth-allow-access.png → ...tegrations/all/brex/auth-allow-access.png
View file
Open in desktop
File renamed without changes
0 ...ns/all/brex-api-key/auth-create-token.png → ...tegrations/all/brex/auth-create-token.png
View file
Open in desktop
File renamed without changes
0 ...egrations/all/brex-api-key/auth-token.png → docs-v2/integrations/all/brex/auth-token.png
View file
Open in desktop
File renamed without changes
12 changes: 6 additions & 6 deletions ...integrations/all/brex-api-key/connect.mdx → docs-v2/integrations/all/brex/connect.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ sidebarTitle: Brex (api key)
# Overview

To authenticate with Brex (api key), you will need one key pieces of information:
1. **Token** - A key that grants Nango permission to interact with Brex APIs resources and services.
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 Token within Brex.
This guide will walk you through finding or generating the Api Token within Brex.

### Prerequisites:

Expand All @@ -21,11 +21,11 @@ This guide will walk you through finding or generating the Token within Brex.
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-api-key/auth-create-token.png" style={{maxWidth: "450px" }}/>
<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-api-key/auth-allow-access.png" style={{maxWidth: "450px" }}/>
<img src="/integrations/all/brex/auth-allow-access.png" style={{maxWidth: "450px" }}/>
6. Your token is now created.
<img src="/integrations/all/brex-api-key/auth-token.png" style={{maxWidth: "450px" }}/>
<img src="/integrations/all/brex/auth-token.png" style={{maxWidth: "450px" }}/>

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

Expand All @@ -35,6 +35,6 @@ Once you have your **API Token**:
3. Submit the form, and you should be successfully authenticated.


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

You are now connected to Brex.
0 ...v2/integrations/all/brex-api-key/form.png → docs-v2/integrations/all/brex/form.png
View file
Open in desktop
File renamed without changes
2 changes: 1 addition & 1 deletion docs-v2/integrations/all/brightcrowd.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,6 @@ API configurations: [`brightcrowd`](https://nango.dev/providers.yaml)

## Going further

<Card title="Connect to BrightCrowd" icon="link" href="/integrations/all/brightCrowd/connect" horizontal>
<Card title="Connect to BrightCrowd" icon="link" href="/integrations/all/brightcrowd/connect" horizontal>
Guide to connect to BrightCrowd using Connect UI
</Card>
Binary file removed docs-v2/integrations/all/buildium/canny_api_key.png
View file
Open in desktop
Binary file not shown.
20 changes: 14 additions & 6 deletions docs-v2/integrations/all/buildium/connect.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,22 +14,30 @@ This guide will walk you through finding these Keys within Buildium.

### Prerequisites:

- You must have a registered Buildium account and an administrator user role.
- You will also need to have a Premium Subscription.
- You must have a registered Buildium account with an administrator user role.
- A Premium Subscription is also required.
- Additionally, you need to enable the API in the settings. To do so, please follow these [steps](#step-1-enabling-api)
### Instructions:

#### Step 1: Finding Your API Key and Client ID
#### Step 1: Enabling API
1. **Log in** to your Buildium dashboard.
2. Open the **Settings** menu and click **Application settings**.
3. Under **System preferences**, click **Api settings**. A modal will appear.
4. Click the **Open API** toggle to turn it on. Then click **Save**.


#### Step 2: Finding Your Client ID and Secret
1. **Log in** to your Buildium dashboard.
2. Open the **Settings** menu and click **Developer Tools**.
3. Click the **Create API Key** button. A modal will appear, enter a **Name** and **Description** for your **API key** submit the form.
4. Now, choose which pieces of Buildium data you want this API key to have access to by marking the corresponding checkboxes. Once finished, click **Next**.


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

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


Expand Down
Binary file modified docs-v2/integrations/all/buildium/form.png
View file
Open in desktop
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This could be great to reorder form when this happen, client ID is more logical at position 1

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs-v2/integrations/all/cal-com/form.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs-v2/integrations/all/canny/form.png
View file
Open in desktop
hassan254-prog marked this conversation as resolved.
Show resolved Hide resolved
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions docs-v2/integrations/all/perimeter81/connect.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,4 +49,6 @@ Enter your credentials as follows:
- Domain: Your permiter81 domain (one of `perimeter81.com` for US and `eu.sase.checkpoint.com` for EU)
- API Key: Your API key

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

Click "Connect" to complete the authentication.
Binary file added docs-v2/integrations/all/perimeter81/form.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 6 additions & 4 deletions packages/shared/providers.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -814,6 +814,7 @@ bill:
proxy:
base_url: https://gateway.prod.bill.com/connect
docs: https://docs.nango.dev/integrations/all/bill
docs_connect: https://docs.nango.dev/integrations/all/bill/connect

bitbucket:
display_name: Bitbucket
Expand Down Expand Up @@ -1146,15 +1147,16 @@ buildium:
description: Your API Key Client ID
pattern: '^[a-f0-9-]+$'
example: a228f0e7-b4a3-4150-b9ae-8552fc2880d3
doc_section: '#step-1-finding-your-api-key-and-client-id'
doc_section: '#step-2-finding-your-client-id-and-secret'
order: 1
credentials:
apiKey:
type: string
title: API Key
description: The API key for your Buildium account
title: Secret
description: The Secret for your Buildium account
pattern: '^[A-Za-z0-9+/]+$'
example: uOq2p+xlgpFdijfV/HqY+EvYpZKHRwlyhGuAVbJIxXs
doc_section: '#step-1-finding-your-api-key-and-client-id'
doc_section: '#step-2-finding-your-client-id-and-secret'

cal-com-v1:
display_name: Cal.com (v1)
Expand Down
5 changes: 4 additions & 1 deletion packages/webapp/public/images/template-logos/cal-com-v1.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion packages/webapp/public/images/template-logos/canny.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading