Skip to content

Commit 7f72553

Browse files
Danny/connect proxy docs patch (#15854)
* s/downstream/upstream * Update pnpm-lock.yaml
1 parent 6c5c0ab commit 7f72553

File tree

2 files changed

+12
-15
lines changed

2 files changed

+12
-15
lines changed

docs-v2/pages/connect/api-proxy.mdx

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,10 @@ Pipedream Connect provides a proxy API that you can use to send authenticated re
1313
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.
1414

1515
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
1818

19-
![Connect API proxy visualization](https://res.cloudinary.com/pipedreamin/image/upload/v1740098219/pd-connect-proxy-viz-updated_jb7wfu.png)
19+
![Connect API proxy visualization](https://res.cloudinary.com/pipedreamin/image/upload/v1741638299/connect-proxy-visual_nnccdk.png)
2020

2121
<Callout type="info">
2222
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/).
3737

3838
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.
3939

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:
4141

4242
```javascript
4343
/*
@@ -100,7 +100,7 @@ const resp = await pd.makeProxyRequest(
100100
options: {
101101
method: "POST",
102102
headers: {
103-
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
104104
},
105105
body: {
106106
text: "hello, world",
@@ -125,17 +125,17 @@ You can also send a request to the Connect REST API with the below config:
125125

126126
**HTTP method**
127127

128-
- Use the HTTP method required by the downstream API
128+
- Use the HTTP method required by the upstream API
129129

130130
**Body**
131131

132-
- Optionally include a body to send to the downstream API
132+
- Optionally include a body to send to the upstream API
133133

134134
**Headers**
135135

136136
- 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,
139139

140140
```javascript
141141
"x-pd-proxy-apiKey: {{api_key}}"

pnpm-lock.yaml

Lines changed: 3 additions & 6 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)