Skip to content

Commit df0bc8e

Browse files
committed
CORE-110647:Updated the imsurl in the documentation
1 parent 57092d0 commit df0bc8e

File tree

1 file changed

+60
-48
lines changed

1 file changed

+60
-48
lines changed

DEVELOPER_GUIDE.md

+60-48
Original file line numberDiff line numberDiff line change
@@ -205,38 +205,7 @@ curl -s -X POST \
205205
206206
Use the command below to set up a Sink connector to a Authenticated Streaming Connection:
207207
208-
1. Using access_token
209-
```shell
210-
curl -s -X POST \
211-
-H "Content-Type: application/json" \
212-
--data '{
213-
"name": "aep-auth-sink-connector",
214-
"config": {
215-
"connector.class": "com.adobe.platform.streaming.sink.impl.AEPSinkConnector",
216-
"topics": "connect-test",
217-
"tasks.max": 1,
218-
"key.converter": "org.apache.kafka.connect.json.JsonConverter",
219-
"key.converter.schemas.enable": "false",
220-
"value.converter": "org.apache.kafka.connect.json.JsonConverter",
221-
"value.converter.schemas.enable": "false",
222-
"aep.endpoint": "https://dcs.adobedc.net/collection/{DATA_INLET_ID}",
223-
"aep.flush.interval.seconds": 1,
224-
"aep.flush.bytes.kb": 4,
225-
"aep.connection.auth.enabled": true,
226-
"aep.connection.auth.token.type": "access_token",
227-
"aep.connection.auth.client.id": "<client_id>",
228-
"aep.connection.auth.client.code": "<client_code>",
229-
"aep.connection.auth.client.secret": "<client_secret>"
230-
}
231-
}' http://localhost:8083/connectors
232-
```
233-
234-
2. Using jwt_token **[DEPRECATED]**
235-
- Convert private.key from adobe console to PKCS8 private using command
236-
```shell
237-
openssl pkcs8 -topk8 -inform PEM -outform DER -in private.key -out private-pkcs8.key -nocrypt
238-
```
239-
208+
1. Using oauth2_access_token
240209
- Create http connector
241210
```shell
242211
curl -s -X POST \
@@ -255,31 +224,34 @@ Use the command below to set up a Sink connector to a Authenticated Streaming Co
255224
"aep.flush.interval.seconds": 1,
256225
"aep.flush.bytes.kb": 4,
257226
"aep.connection.auth.enabled": true,
258-
"aep.connection.auth.token.type": "jwt_token",
227+
"aep.connection.auth.token.type": "oauth2_access_token",
259228
"aep.connection.auth.client.id": "<client_id>",
260-
"aep.connection.auth.imsOrg": "<organization-id>",
261-
"aep.connection.auth.accountKey": "<technical-account-id>",
262-
"aep.connection.auth.filePath": "<path-to-private-pkcs8.key>",
229+
"aep.connection.auth.client.secret": "<client_secret>"
263230
"aep.connection.auth.endpoint": "<ims-url>",
264231
"aep.connection.endpoint.headers": "<optional-header-that-needs-to-be-passed-to-AEP>"
265-
"aep.connection.auth.client.secret": "<client_secret>"
266232
}
267233
}' http://localhost:8083/connectors
268234
```
269-
270-
Note - `aep.connection.endpoint.headers` format should be JSON-encoded.
271-
Example: To send below 2 HTTP headers -
235+
236+
Note - `aep.connection.endpoint.headers` format should be JSON-encoded.
237+
Example: To send below 2 HTTP headers -
272238
1. key: `x-adobe-flow-id`, value: `341fd4f0-cdec-4912-1ab6-fb54aeb41286`
273239
2. key: `x-adobe-dataset-id`, value: `3096fbfd5978431948af3ba3`
274-
240+
241+
`aep.connection.auth.endpoint` value for prod
242+
`<ims-url>` : `https://ims-na1.adobelogin.com`
243+
275244
Use config -
276245
```json
277246
"aep.connection.endpoint.headers": "{\"x-adobe-flow-id\":\"341fd4f0-cdec-4912-1ab6-fb54aeb41286\", \"x-adobe-dataset-id\": \"3096fbfd5978431948af3ba3\"}"
278247
```
279-
#### note : jwt_token authentication is deprecated
280248
249+
2. Using jwt_token **[DEPRECATED]**
250+
- Convert private.key from adobe console to PKCS8 private using command
251+
```shell
252+
openssl pkcs8 -topk8 -inform PEM -outform DER -in private.key -out private-pkcs8.key -nocrypt
253+
```
281254
282-
3. Using oauth2_access_token
283255
- Create http connector
284256
```shell
285257
curl -s -X POST \
@@ -298,24 +270,64 @@ Use the command below to set up a Sink connector to a Authenticated Streaming Co
298270
"aep.flush.interval.seconds": 1,
299271
"aep.flush.bytes.kb": 4,
300272
"aep.connection.auth.enabled": true,
301-
"aep.connection.auth.token.type": "oauth2_access_token",
273+
"aep.connection.auth.token.type": "jwt_token",
302274
"aep.connection.auth.client.id": "<client_id>",
303-
"aep.connection.auth.client.secret": "<client_secret>"
275+
"aep.connection.auth.imsOrg": "<organization-id>",
276+
"aep.connection.auth.accountKey": "<technical-account-id>",
277+
"aep.connection.auth.filePath": "<path-to-private-pkcs8.key>",
304278
"aep.connection.auth.endpoint": "<ims-url>",
305279
"aep.connection.endpoint.headers": "<optional-header-that-needs-to-be-passed-to-AEP>"
280+
"aep.connection.auth.client.secret": "<client_secret>"
306281
}
307282
}' http://localhost:8083/connectors
308283
```
309-
310-
Note - `aep.connection.endpoint.headers` format should be JSON-encoded.
311-
Example: To send below 2 HTTP headers -
284+
285+
Note - `aep.connection.endpoint.headers` format should be JSON-encoded.
286+
Example: To send below 2 HTTP headers -
312287
1. key: `x-adobe-flow-id`, value: `341fd4f0-cdec-4912-1ab6-fb54aeb41286`
313288
2. key: `x-adobe-dataset-id`, value: `3096fbfd5978431948af3ba3`
314289
290+
`aep.connection.auth.endpoint` value for prod
291+
`<ims-url>` : `https://ims-na1.adobelogin.com`
292+
315293
Use config -
316294
```json
317295
"aep.connection.endpoint.headers": "{\"x-adobe-flow-id\":\"341fd4f0-cdec-4912-1ab6-fb54aeb41286\", \"x-adobe-dataset-id\": \"3096fbfd5978431948af3ba3\"}"
318296
```
297+
#### note : jwt_token authentication is deprecated
298+
299+
300+
3. Using access_token
301+
```shell
302+
curl -s -X POST \
303+
-H "Content-Type: application/json" \
304+
--data '{
305+
"name": "aep-auth-sink-connector",
306+
"config": {
307+
"connector.class": "com.adobe.platform.streaming.sink.impl.AEPSinkConnector",
308+
"topics": "connect-test",
309+
"tasks.max": 1,
310+
"key.converter": "org.apache.kafka.connect.json.JsonConverter",
311+
"key.converter.schemas.enable": "false",
312+
"value.converter": "org.apache.kafka.connect.json.JsonConverter",
313+
"value.converter.schemas.enable": "false",
314+
"aep.endpoint": "https://dcs.adobedc.net/collection/{DATA_INLET_ID}",
315+
"aep.flush.interval.seconds": 1,
316+
"aep.flush.bytes.kb": 4,
317+
"aep.connection.auth.enabled": true,
318+
"aep.connection.auth.token.type": "access_token",
319+
"aep.connection.auth.endpoint": "<ims-url>",
320+
"aep.connection.auth.client.id": "<client_id>",
321+
"aep.connection.auth.client.code": "<client_code>",
322+
"aep.connection.auth.client.secret": "<client_secret>"
323+
}
324+
}' http://localhost:8083/connectors
325+
```
326+
327+
Note -
328+
`aep.connection.auth.endpoint` value for prod
329+
`<ims-url>` : `https://ims-na1.adobelogin.com`
330+
319331
320332
#### Batching
321333

0 commit comments

Comments
 (0)