You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs-v2/pages/connect/api-proxy.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -27,7 +27,7 @@ Before getting started with the Connect proxy, make sure you've already gone thr
27
27
You can send requests to the Connect proxy using the [Pipedream SDK](/connect/sdk/) with a fetch-style interface, or by making a request to the [REST API](/rest-api/connect/proxy/).
28
28
29
29
- A [Pipedream OAuth client](/rest-api/auth/#oauth) to make authenticated requests to Pipedream's API
30
-
- Connect [environment](/connect/environments/) (ex, `production` or `development`)
30
+
- Connect [environment](/connect/managed-auth/environments/) (ex, `production` or `development`)
31
31
- The [external user ID](/connect/api/#external-users) for your end user (ex, `abc-123`)
32
32
- The [account ID](/connect/api/#accounts) for your end user's connected account (ex, `apn_1234567`)
Copy file name to clipboardExpand all lines: docs-v2/pages/connect/api.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -104,7 +104,7 @@ export default function Home() {
104
104
105
105
## Environment
106
106
107
-
Some API endpoints accept an [environment](/connect/environments/) parameter. This lets you specify the environment (`production` or `development`) where resources will live in your project.
107
+
Some API endpoints accept an [environment](/connect/managed-auth/environments/) parameter. This lets you specify the environment (`production` or `development`) where resources will live in your project.
108
108
109
109
Always set the environment when you create the SDK client:
Copy file name to clipboardExpand all lines: docs-v2/pages/connect/managed-auth/customization.mdx
+3-5Lines changed: 3 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,17 +1,15 @@
1
1
importArcadeEmbedfrom'@/components/ArcadeEmbed'
2
2
importCalloutfrom'@/components/Callout'
3
3
4
-
# Customizing the Auth Flow
4
+
# Project Configuration
5
+
6
+
By default, your end users will see a primarly Pipedream branded experience when they connect their account. To customize this screen to highlight your application, you can configure your [app's name](#application-name), [support email](#support-email), and [logo](#logo) in the Pipedream UI.
By default, your end users will see a primarly Pipedream branded experience when they connect their account. To customize this screen to highlight your application, you can configure your [app's name](#application-name), [support email](#support-email), and [logo](#logo) in the Pipedream UI.
13
-
</Callout>
14
-
15
13
## Customizing your application details
16
14
17
15
Open your project in the Pipedream UI: [https://pipedream.com/projects](https://pipedream.com/projects)
Copy file name to clipboardExpand all lines: docs-v2/pages/connect/managed-auth/environments.mdx
+6-5Lines changed: 6 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,22 +3,22 @@ import Image from 'next/image'
3
3
4
4
# Environments
5
5
6
-
Pipedream Connect projects support two environments: `development` and `production`. Connected accounts and credentials stored in `development`remain separate from `production`.
6
+
Pipedream Connect projects support two environments: `development` and `production`. Connected accounts and credentials stored in one environment remain separate from the other.
7
7
8
8
<Callouttype="info">
9
-
You can use all of the Connect features in `development` mode **on any plan**. **[Visit the pricing page](https://pipedream.com/pricing?plan=Connect)** to select the right plan when you're ready to ship to production.
9
+
You can use all of the Connect features in `development` mode **on any plan**. **[Visit the pricing page](https://pipedream.com/pricing?plan=Connect)** to select the right plan when you're ready to ship your app to production.
10
10
</Callout>
11
11
12
12
## Development mode
13
13
14
-
Development mode provides access to all Connect features while you're building and testing your integration. It has the following constraints:
14
+
Development mode provides access to all Connect features while you're building and testing your integration with the following constraints:
15
15
16
16
-**Maximum of 10 external users**: The development environment is limited to 10 unique external user IDs. If you exceed this limit, you'll need to [delete some existing users](/connect/managed-auth/users/#deleting-users) before adding new ones.
17
17
-**Must be signed in to pipedream.com**: When connecting an account in development mode, you must be signed in to pipedream.com in the same browser where you're connecting your account.
18
18
-**Personal testing only**: Development mode is intended for your own accounts during testing and development, not for your real end users.
19
19
20
20
<Callouttype="warning">
21
-
The `development` environment is not intended for production use with your customers. When you're ready to launch, you should transition to the `production` environment.
21
+
The `development` environment is not intended for production use with your customers. When you're ready to launch, you should transition to `production`.
@@ -27,17 +27,17 @@ Here's how Connect sits in your frontend and backend, and communicates with Pipe
27
27
28
28
## Getting started
29
29
30
+
We'll walk through these steps below with an interactive demo that lets you see an execute the code directly in the docs.
31
+
30
32
<Steps>
31
33
32
34
### Configure your environment
33
35
34
36
You'll need to do two things to add Pipedream Connect to your app:
35
37
36
-
1.[Connect to the Pipedream API from your server](#generate-a-short-lived-token). This lets you make secure calls to the Pipedream API to initiate the account connection flow and retrieve account credentials. If you're running a JavaScript framework like Node.js on your server, you can use the Pipedream SDK.
38
+
1.[Connect to the Pipedream API from your server](#generate-a-short-lived-token). This lets you make secure calls to the Pipedream API to initiate the account connection flow and retrieve account credentials.
37
39
2.[Add the Pipedream SDK to your frontend](#connect-your-users-account) or redirect your users to [a Pipedream-hosted URL](/connect/connect-link/) to start the account connection flow.
38
40
39
-
We'll walk through these steps below with an interactive demo that lets you see an execute the code directly in the docs.
40
-
41
41
If you're building your own app, you'll need to provide these credentials to the environment, or retrieve them from your secrets store:
1. Open an existing Pipedream project or create a new one at [pipedream.com/projects](https://pipedream.com/projects).
54
-
2. Click the **Settings** tab, then copy your **Project ID**.
53
+
1. Open an existing Pipedream project or create a new one at [pipedream.com/projects](https://pipedream.com/projects)
54
+
2. Click the **Settings** tab, then copy your **Project ID**
55
55
56
56
### Create a Pipedream OAuth client
57
57
58
58
Pipedream uses OAuth to authorize requests to the REST API. To create an OAuth client:
59
59
60
-
1. Visit the [API settings](https://pipedream.com/settings/api) for your workspace.
61
-
2. Click the **New OAuth Client** button.
62
-
3. Name your client and click **Create**.
63
-
4. Copy the client secret. **It will not be accessible again**. Click **Close**.
64
-
5. Copy the client ID from the list.
60
+
1. Visit the [API settings](https://pipedream.com/settings/api) for your workspace
61
+
2. Create a new OAuth client and note the client ID and secret
65
62
66
63
You'll need these when configuring the SDK and making API requests.
67
64
68
65
### Generate a short-lived token
69
66
70
67
To securely initiate account connections for your users, you'll need to generate a short-lived token for your users and use that in the [account connection flow](#connect-your-users-account). See [the docs on Connect tokens](/connect/tokens/) for a general overview of why we need to create tokens and scope them to end users.
71
68
72
-
In the code below you can see how we generate a Connect token for an example user, and even**try it yourself**:
69
+
Check out the code below **try it yourself**:
73
70
74
71
<divclassName="not-prose">
75
72
<TokenGenerationDemo />
@@ -83,7 +80,7 @@ Refer to the API docs for [full set of parameters you can pass](/connect/api/#cr
83
80
84
81
### Connect your user's account
85
82
86
-
To connect a third-party account for a user, you have two options:
83
+
You have two options when connecting an account for your user:
87
84
88
85
1.[Use the Pipedream SDK](#use-the-pipedream-sdk-in-your-frontend) in your frontend
89
86
2.[Use Connect Link](#or-use-connect-link) to deliver a hosted URL to your user
@@ -128,24 +125,16 @@ Check out the [full API docs](/connect/api/#create-token) for all parameters you
128
125
129
126
Now that your users have connected an account, you can use their auth in one of a few ways:
130
127
131
-
1.[Retrieve their credentials from the REST API](/connect/api/#accounts) to use in your backend application
132
-
2.[Use Pipedream's visual workflow builder](/connect/workflows/) to define complex logic to run on behalf of your users
133
-
3.[Embed Pipedream components directly in your app](/connect/components/) to run actions and triggers on their behalf
128
+
1.[Expose 10k+ tools](/connect/components/) to your AI app or agent and call them on behalf of your customers
129
+
2.[Send custom requests](/connect/proxy/) to any one of the 2500+ APIs using the Connect API proxy
130
+
3.[Use Pipedream's visual workflow builder](/connect/workflows/) to define complex logic to run on behalf of your users
131
+
4.[Embed Pipedream components directly in your app](/connect/components/) to run actions and triggers on their behalf
134
132
135
133
### Deploy your app to production
136
134
137
-
- Test end to end in [development](/connect/environments/)
135
+
- Test end to end in [development](/connect/managed-auth/environments/)
0 commit comments