Skip to content
Merged
Show file tree
Hide file tree
Changes from 11 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
82 changes: 82 additions & 0 deletions docs/api-integrations/accelo.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
---
title: 'Accelo'
sidebarTitle: 'Accelo'
description: 'Integrate your application with the Accelo API'
---

## 🚀 Quickstart

Connect to Accelo with Nango and see data flow in 2 minutes.

<Steps>
<Step title="Create the integration">
In Nango ([free signup](https://app.nango.dev)), go to [Integrations](https://app.nango.dev/dev/integrations) -> _Configure New Integration_ -> _Accelo_.
</Step>
<Step title="Authorize Accelo">
Go to [Connections](https://app.nango.dev/dev/connections) -> _Add Test Connection_ -> _Authorize_, then log in to Accelo. Later, you'll let your users do the same directly from your app.
</Step>
<Step title="Call the Accelo API">
Let's make your first request to the Accelo API. Replace the placeholders below with your [secret key](https://app.nango.dev/dev/environment-settings), [integration ID](https://app.nango.dev/dev/integrations), and [connection ID](https://app.nango.dev/dev/connections):
<Tabs>
<Tab title="cURL">

```bash
curl "https://api.nango.dev/proxy/api/v0/companies" \
-H "Authorization: Bearer <NANGO-SECRET-KEY>" \
-H "Provider-Config-Key: <INTEGRATION-ID>" \
-H "Connection-Id: <CONNECTION-ID>"
```

</Tab>

<Tab title="Node">

Install Nango's backend SDK with `npm i @nangohq/node`. Then run:

```typescript
import { Nango } from '@nangohq/node';

const nango = new Nango({ secretKey: '<NANGO-SECRET-KEY>' });

const res = await nango.get({
endpoint: '/api/v0/companies',
providerConfigKey: '<INTEGRATION-ID>',
connectionId: '<CONNECTION-ID>'
});

console.log(res.data);
```
</Tab>


</Tabs>
Or fetch credentials with the [Node SDK](/reference/sdks/node#get-a-connection-with-credentials) or [API](/reference/api/connection/get).

✅ You're connected! Check the [Logs](https://app.nango.dev/dev/logs) tab in Nango to inspect requests.
</Step>

<Step title="Implement Nango in your app">
Follow our [quickstart](/getting-started/quickstart/embed-in-your-app) to integrate Nango in your app.

To obtain your own production credentials, follow the setup guide linked below.
</Step>
</Steps>

## 📚 Accelo Integration Guides

Nango maintained guides for common use cases.

- [How to register your own Accelo OAuth app](/api-integrations/accelo/how-to-register-your-own-accelo-api-oauth-app)
Register an OAuth app with Accelo and obtain credentials to connect it to Nango

Official docs: [Accelo API documentation](https://api.accelo.com/docs/)

## 🧩 Pre-built syncs & actions for Accelo

Enable them in your dashboard. [Extend and customize](/implementation-guides/building-integrations/extend-reference-implementation) to fit your needs.

import PreBuiltUseCases from "/snippets/generated/accelo/PreBuiltUseCases.mdx"

<PreBuiltUseCases />

---
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
title: 'How to register your own Accelo OAuth app'
sidebarTitle: 'Accelo Setup'
description: 'Register an OAuth app with Accelo and obtain credentials to connect it to Nango'
---

This guide shows you how to register your own app with Accelo to obtain your OAuth credentials (client id & secret). These are required to let your users grant your app access to their Accelo account.

## Registering your application

To use Accelo's API with OAuth 2.0, you need to register your application with Accelo.

Follow Accelo's official guide to register your application: [How to register an Application](https://api.accelo.com/docs/#registering-your-application)

## Connection configuration in Nango

Accelo [requires a user specific subdomain](https://api.accelo.com/docs/#oauth2-0-uri) to run OAuth. When creating connections in Nango, your users will need to provide their Accelo subdomain.

The subdomain is the first part of your Accelo URL. For example, if your Accelo account is at `https://mycompany.api.accelo.com`, your subdomain is `mycompany`.

## OAuth scopes

When configuring your OAuth app, you'll need to specify which scopes your app requires. Scopes define what data and actions your app can access in a user's Accelo account.

For a complete list of available OAuth scopes, see [Accelo's scope documentation](https://api.accelo.com/docs/#scope).

## Additional resources

- [OAuth authentication documentation](https://api.accelo.com/docs/#authentication)
- [Accelo API documentation](https://api.accelo.com/docs/)

---
2 changes: 1 addition & 1 deletion docs/api-integrations/airtable.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ Connect to Airtable with Nango and see data flow in 2 minutes.

Nango maintained guides for common use cases.

- [How to register your own Airtable OAuth app](/api-integrations/airtable/how-to-register-your-own-airtable-oauth-app)
- [How to register your own Airtable OAuth app](/api-integrations/airtable/how-to-register-your-own-airtable-api-oauth-app)
Register an OAuth app with Airtable and obtain credentials to connect it to Nango

Official docs: [Airtable Web API Documentation](https://airtable.com/developers/web/api/introduction)
Expand Down
82 changes: 82 additions & 0 deletions docs/api-integrations/amazon.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
---
title: 'Amazon'
sidebarTitle: 'Amazon'
description: 'Integrate your application with the Amazon API'
---

## 🚀 Quickstart

Connect to Amazon with Nango and see data flow in 2 minutes.

<Steps>
<Step title="Create the integration">
In Nango ([free signup](https://app.nango.dev)), go to [Integrations](https://app.nango.dev/dev/integrations) -> _Configure New Integration_ -> _Amazon_.
</Step>
<Step title="Authorize Amazon">
Go to [Connections](https://app.nango.dev/dev/connections) -> _Add Test Connection_ -> _Authorize_, then log in to Amazon. Later, you'll let your users do the same directly from your app.
</Step>
<Step title="Call the Amazon API">
Let's make your first request to the Amazon API. Replace the placeholders below with your [secret key](https://app.nango.dev/dev/environment-settings), [integration ID](https://app.nango.dev/dev/integrations), and [connection ID](https://app.nango.dev/dev/connections):
<Tabs>
<Tab title="cURL">

```bash
curl "https://api.nango.dev/proxy/user/profile" \
-H "Authorization: Bearer <NANGO-SECRET-KEY>" \
-H "Provider-Config-Key: <INTEGRATION-ID>" \
-H "Connection-Id: <CONNECTION-ID>"
```

</Tab>

<Tab title="Node">

Install Nango's backend SDK with `npm i @nangohq/node`. Then run:

```typescript
import { Nango } from '@nangohq/node';

const nango = new Nango({ secretKey: '<NANGO-SECRET-KEY>' });

const res = await nango.get({
endpoint: '/user/profile',
providerConfigKey: '<INTEGRATION-ID>',
connectionId: '<CONNECTION-ID>'
});

console.log(res.data);
```
</Tab>


</Tabs>
Or fetch credentials with the [Node SDK](/reference/sdks/node#get-a-connection-with-credentials) or [API](/reference/api/connection/get).

✅ You're connected! Check the [Logs](https://app.nango.dev/dev/logs) tab in Nango to inspect requests.
</Step>

<Step title="Implement Nango in your app">
Follow our [quickstart](/getting-started/quickstart/embed-in-your-app) to integrate Nango in your app.

To obtain your own production credentials, follow the setup guide linked below.
</Step>
</Steps>

## 📚 Amazon Integration Guides

Nango maintained guides for common use cases.

- [How to register your own Amazon OAuth app](/api-integrations/amazon/how-to-register-your-own-amazon-api-oauth-app)
Register an OAuth app with Amazon and obtain credentials to connect it to Nango

Official docs: [Amazon API docs](https://developer.amazon.com/docs/login-with-amazon/authorization-code-grant.html)

## 🧩 Pre-built syncs & actions for Amazon

Enable them in your dashboard. [Extend and customize](/implementation-guides/building-integrations/extend-reference-implementation) to fit your needs.

import PreBuiltUseCases from "/snippets/generated/amazon/PreBuiltUseCases.mdx"

<PreBuiltUseCases />

---
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
---
title: 'Set up Amazon with Nango'
sidebarTitle: 'Amazon Setup'
description: 'Register an OAuth app with Amazon and connect it to Nango'
---

This guide shows you how to register your own app with Amazon to obtain your OAuth credentials (client id & secret). These are required to let your users grant your app access to their Amazon account.

## Register your application

<Steps>
<Step title="Create an Amazon developer account">
If you don't already have one, sign up for an [Amazon Developer account](https://developer.amazon.com/).
</Step>

<Step title="Register your application">
Go to the [Login with Amazon console](https://developer.amazon.com/loginwithamazon/console/site/lwa/overview.html) and click **Register new application**.

Enter your application name and description, then save the application.
</Step>

<Step title="Configure OAuth settings">
In your application settings:

1. Click **Web Settings** under the application name
2. Click **Edit** to configure the OAuth settings
3. Add your **Allowed JavaScript Origins** (e.g., `https://yourdomain.com`)
4. Add your **Allowed Return URLs** - this should be your Nango callback URL:
```
https://api.nango.dev/oauth/callback
```
Or if you're self-hosting Nango, use your instance's callback URL.
5. Save your changes
</Step>

<Step title="Get your OAuth credentials">
After saving, you'll see your **Client ID** and **Client Secret** in the web settings section. Copy these credentials.
</Step>

<Step title="Add credentials to Nango">
In the [Nango dashboard](https://app.nango.dev/dev/integrations), find your Amazon integration and add:
- **Client ID** from step 4
- **Client Secret** from step 4
- **Scopes** - Add the required scopes for your use case (see [Amazon's scope documentation](https://developer.amazon.com/docs/login-with-amazon/customer-profile.html))
</Step>
</Steps>

## Connection configuration in Nango

Amazon uses different domain extensions for different regions (e.g., `amazon.com` for the US, `amazon.co.uk` for the UK, or `amazon.de` for Germany). When creating a connection in Nango, you can specify the region-specific domain using connection configuration parameters.

For more details on Amazon's OAuth implementation, see [Amazon's OAuth documentation](https://developer.amazon.com/docs/login-with-amazon/authorization-code-grant.html).

---
82 changes: 82 additions & 0 deletions docs/api-integrations/apollo.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
---
title: 'Apollo'
sidebarTitle: 'Apollo'
description: 'Integrate your application with the Apollo API'
---

## 🚀 Quickstart

Connect to Apollo with Nango and see data flow in 2 minutes.

<Steps>
<Step title="Create the integration">
In Nango ([free signup](https://app.nango.dev)), go to [Integrations](https://app.nango.dev/dev/integrations) -> _Configure New Integration_ -> _Apollo_.
</Step>
<Step title="Authorize Apollo">
Go to [Connections](https://app.nango.dev/dev/connections) -> _Add Test Connection_ -> _Authorize_, then enter your Apollo API key. Later, you'll let your users do the same directly from your app.
</Step>
<Step title="Call the Apollo API">
Let's make your first request to the Apollo API. Replace the placeholders below with your [secret key](https://app.nango.dev/dev/environment-settings), [integration ID](https://app.nango.dev/dev/integrations), and [connection ID](https://app.nango.dev/dev/connections):
<Tabs>
<Tab title="cURL">

```bash
curl "https://api.nango.dev/proxy/v1/organizations/enrich" \
-H "Authorization: Bearer <NANGO-SECRET-KEY>" \
-H "Provider-Config-Key: <INTEGRATION-ID>" \
-H "Connection-Id: <CONNECTION-ID>"
```

</Tab>

<Tab title="Node">

Install Nango's backend SDK with `npm i @nangohq/node`. Then run:

```typescript
import { Nango } from '@nangohq/node';

const nango = new Nango({ secretKey: '<NANGO-SECRET-KEY>' });

const res = await nango.get({
endpoint: '/v1/organizations/enrich',
providerConfigKey: '<INTEGRATION-ID>',
connectionId: '<CONNECTION-ID>'
});

console.log(res.data);
```
</Tab>


</Tabs>
Or fetch credentials with the [Node SDK](/reference/sdks/node#get-a-connection-with-credentials) or [API](/reference/api/connection/get).

✅ You're connected! Check the [Logs](https://app.nango.dev/dev/logs) tab in Nango to inspect requests.
</Step>

<Step title="Implement Nango in your app">
Follow our [quickstart](/getting-started/quickstart/embed-in-your-app) to integrate Nango in your app.

To obtain your own production credentials, follow the setup guide linked below.
</Step>
</Steps>

## 📚 Apollo Integration Guides

Nango maintained guides for common use cases.

- [How do I link my Apollo account?](/api-integrations/apollo/connect)
Learn how to obtain your Apollo API key and link your account

Official docs: [Apollo API docs](https://docs.apollo.io/reference)

## 🧩 Pre-built syncs & actions for Apollo

Enable them in your dashboard. [Extend and customize](/implementation-guides/building-integrations/extend-reference-implementation) to fit your needs.

import PreBuiltUseCases from "/snippets/generated/apollo/PreBuiltUseCases.mdx"

<PreBuiltUseCases />

---
Original file line number Diff line number Diff line change
Expand Up @@ -20,16 +20,16 @@ This guide will walk you through obtaining these credentials within Apollo.
#### Step 1: Finding Your API Key
1. Log in to your [Apollo](https://app.apollo.io/#/login) account.
2. Navigate to **Settings** > [Integrations](https://app.apollo.io/#/settings/integrations).
<img src="/integrations/all/apollo/settings.png" />
<img src="/api-integrations/apollo/settings.png" />
3. Find the **API** option and click **Connect**.
<img src="/integrations/all/apollo/integrations.png" />
<img src="/api-integrations/apollo/integrations.png" />
4. Click **API keys** to view or create new **API keys**. Then, click **Create new key**.
<img src="/integrations/all/apollo/api_page.png" />
<img src="/api-integrations/apollo/api_page.png" />
5. **Name** your **API Key** and add a **Description**. To scope your key appropriately, click the checkbox for each Apollo API endpoint you need to access.
<img src="/integrations/all/apollo/api_key_form.png" />
<img src="/api-integrations/apollo/api_key_form.png" />
6. Click **Create API key**.
7. On the **API Keys** page, click on the reveal button next to your newely generated API key to reveal it.
<img src="/integrations/all/apollo/reveal.png" />
7. On the **API Keys** page, click on the reveal button next to your newly generated API key to reveal it.
<img src="/api-integrations/apollo/reveal.png" />
<Note>To access all endpoints that are available with your Apollo plan, set your key to be a master key by toggling on the **Set as master key** slider. Certain endpoints such as [Get a List of Users](https://docs.apollo.io/docs/get-a-list-of-users) are only accessible when using a master API key.</Note>
#### Step 2: Enter credentials in the Connect UI

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


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

You are now connected to Apollo.

Loading
Loading