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
+49-43Lines changed: 49 additions & 43 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,11 +13,11 @@ Pipedream Connect provides a proxy API that you can use to send authenticated re
13
13
14
14
The Connect proxy enables you to interface with any integrated API and make authenticated requests on behalf of your users, without dealing with OAuth or storing end user credentials.
15
15
16
-
- You send a request to the proxy and identify the end user you want to act on behalf of
17
-
- The proxy sends the request to the downstream API and dynamically inserts your end user's auth credentials
18
-
- The proxy returns the response from the downstream API back to you
16
+
1. You send a request to the proxy and identify the end user you want to act on behalf of
17
+
2. The proxy sends the request to the downstream API and dynamically inserts your end user's auth credentials
18
+
3. The proxy returns the response from the downstream API back to you
19
19
20
-

20
+

21
21
22
22
<Callouttype="info">
23
23
Before getting started with the Connect proxy, make sure you've already gone through the [managed auth quickstart](/connect/managed-auth/quickstart) for Pipedream Connect.
@@ -28,33 +28,16 @@ Before getting started with the Connect proxy, make sure you've already gone thr
28
28
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).
29
29
30
30
- A [Pipedream OAuth client](/rest-api/auth#oauth) to make authenticated requests to Pipedream's API
31
-
- The [external user ID](/connect/api#external-users) for your end user (ex, `abc-123`)
32
31
- Connect [environment](/connect/environments) (ex, `production` or `development`)
32
+
- The [external user ID](/connect/api#external-users) for your end user (ex, `abc-123`)
33
33
- The [account ID](/connect/api#accounts) for your end user's connected account (ex, `apn_1234567`)
34
34
35
-
### Code examples
36
-
37
-
**URL**
38
-
39
-
- The URL of the API you want to call (ex, `https://slack.com/api/chat.postMessage`)
40
-
- If using the REST API, this should be an URL-safe Base64 encoded string (ex, `aHR0cHM6Ly9zbGFjay5jb20vYXBpL2NoYXQucG9zdE1lc3NhZ2U`)
35
+
Refer to the full Connect API [here](/connect/api).
41
36
42
-
**HTTP method**
37
+
### Using the Pipedream SDK (preferred)
43
38
44
-
- Use the HTTP method required by the downstream API
45
-
46
-
**Body**
39
+
You can use the [Pipedream SDK](https://www.npmjs.com/package/@pipedream/sdk) to send a fetch-style request:
47
40
48
-
- Optionally include a body to send to the downstream API
49
-
50
-
**Headers**
51
-
52
-
- If using the REST API, include the `Authorization` header with your Pipedream OAuth access token (`Bearer {access_token}`)
53
-
- Only headers that contain the prefix `x-pd-proxy` will get forwarded to the downstream API
0 commit comments