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
+9-9Lines changed: 9 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,10 +13,10 @@ Pipedream Connect provides a proxy API that you can use to send authenticated re
13
13
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.
14
14
15
15
1. You send a request to the proxy and identify the end user you want to act on behalf of
16
-
2. The proxy sends the request to the downstream API and dynamically inserts your end user's auth credentials
17
-
3. The proxy returns the response from the downstream API back to you
16
+
2. The proxy sends the request to the upstream API and dynamically inserts your end user's auth credentials
17
+
3. The proxy returns the response from the upstream API back to you
18
18
19
-

19
+

20
20
21
21
<Callouttype="info">
22
22
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.
@@ -37,7 +37,7 @@ Refer to the full Connect API [here](/connect/api/).
37
37
38
38
Most API integrations that use OAuth to authenticate requests require that you pass a user's access token in the `Authorization` header with the `Bearer` prefix. For these apps, the Connect proxy will automatically handle that for you — you don't need to pass any reference to their OAuth access token in this case.
39
39
40
-
For apps that require a different authentication method, you should include the necessary headers with the value surrounded by `{{ }}` in your request to the proxy, and Pipedream will automatically replace the macro with the real values and forward to the downstream API. For example:
40
+
For apps that require a different authentication method, you should include the necessary headers with the value surrounded by `{{ }}` in your request to the proxy, and Pipedream will automatically replace the macro with the real values and forward to the upstream API. For example:
hello:"world!"// Include any headers you need to send to the downstream API
103
+
hello:"world!"// Include any headers you need to send to the upstream API
104
104
},
105
105
body: {
106
106
text:"hello, world",
@@ -125,17 +125,17 @@ You can also send a request to the Connect REST API with the below config:
125
125
126
126
**HTTP method**
127
127
128
-
- Use the HTTP method required by the downstream API
128
+
- Use the HTTP method required by the upstream API
129
129
130
130
**Body**
131
131
132
-
- Optionally include a body to send to the downstream API
132
+
- Optionally include a body to send to the upstream API
133
133
134
134
**Headers**
135
135
136
136
- If using the REST API, include the `Authorization` header with your Pipedream OAuth access token (`Bearer {access_token}`)
137
-
- Headers that contain the prefix `x-pd-proxy` will get forwarded to the downstream API
138
-
- If the downstream API requires [custom authorization headers](#authenticating-on-behalf-of-your-user), make sure to prepend with `x-pd-proxy` and include the macro `{{ }}` that Pipedream will replace with the actual value. For example,
137
+
- Headers that contain the prefix `x-pd-proxy` will get forwarded to the upstream API
138
+
- If the upstream API requires [custom authorization headers](#authenticating-on-behalf-of-your-user), make sure to prepend with `x-pd-proxy` and include the macro `{{ }}` that Pipedream will replace with the actual value. For example,
0 commit comments