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/environments.mdx
+26-8Lines changed: 26 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,10 +9,25 @@ Pipedream Connect projects support two environments: `development` and `producti
9
9
You can use all of the Connect features in `development` mode **on any plan**. **[Get in touch with our Sales team](https://pipedream.com/pricing?plan=Enterprise)** when you're ready to ship to production.
10
10
</Callout>
11
11
12
+
## Development mode
13
+
14
+
Development mode provides access to all Connect features while you're building and testing your integration. It has the following constraints:
15
+
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
+
-**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
+
-**Personal testing only**: Development mode is intended for your own accounts during testing and development, not for your real end users.
19
+
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.
22
+
</Callout>
23
+
24
+
<br />
25
+
26
+
<Imagesrc="https://res.cloudinary.com/pipedreamin/image/upload/v1732654019/Google_Chrome_-_Pipedream_Connect_2024-11-26_at_12.45.06_PM_yp4gnl.png"alt="Connect in development mode"width={350}height={529} />
12
27
13
28
## How to specify the environment
14
29
15
-
You specify the environment when [creating a new Connect token](/connect/api/#create-a-new-token) with the Pipedream SDK or API. When users succesfully connect their account, Pipedream saves the account credentials (API key, access token, etc) for that `external_user_id` in the specified environment.
30
+
You specify the environment when [creating a new Connect token](/connect/api/#create-a-new-token) with the Pipedream SDK or API. When users successfully connect their account, Pipedream saves the account credentials (API key, access token, etc.) for that `external_user_id` in the specified environment.
16
31
17
32
Always set the environment when you create the SDK client:
or pass the `X-PD-Environment` header in HTTP requests:
46
+
or pass the `x-pd-environment` header in HTTP requests:
32
47
33
48
```bash
34
49
curl -X POST https://api.pipedream.com/v1/connect/{project_id}/tokens \
35
50
-H "Content-Type: application/json" \
36
-
-H "X-PD-Environment: development" \
51
+
-H "x-pd-environment: development" \
37
52
-H "Authorization: Bearer {access_token}" \
38
53
-d '{
39
54
"external_user_id": "your-external-user-id"
40
55
}'
41
56
```
42
57
43
-
<Callouttype="warning">
44
-
When connecting an account in `development`, make sure you're signed in to pipedream.com in the same browser where you're connecting your account. This is only a requirement for the `development` environment. **You should only use `development` with your own accounts when testing and developing, and not with your end users.**
45
-
</Callout>
58
+
## Shipping Connect to production
46
59
47
-
<br />
60
+
When you're ready to ship to production:
48
61
49
-
<Imagesrc="https://res.cloudinary.com/pipedreamin/image/upload/v1732654019/Google_Chrome_-_Pipedream_Connect_2024-11-26_at_12.45.06_PM_yp4gnl.png"alt="Connect in development mode"width={350}height={529} />
62
+
1. Contact the [Pipedream Sales team](https://pipedream.com/pricing?plan=Enterprise) to enable production access
63
+
2. Update your environment to `production` in your SDK client configuration and / or API calls
64
+
65
+
<Callouttype="info">
66
+
Using Connect in production doesn't have any user limits and doesn't require that the end user is signed in to pipedream.com like the development environment does.
0 commit comments