Skip to content

Commit bc5499a

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

File tree

1 file changed

+71
-40
lines changed

1 file changed

+71
-40
lines changed

DEVELOPER_GUIDE.md

+71-40
Original file line numberDiff line numberDiff line change
@@ -205,31 +205,49 @@ 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-
```
208+
1. Using oauth2_access_token
209+
- Create http connector
210+
```shell
211+
curl -s -X POST \
212+
-H "Content-Type: application/json" \
213+
--data '{
214+
"name": "aep-auth-sink-connector",
215+
"config": {
216+
"connector.class": "com.adobe.platform.streaming.sink.impl.AEPSinkConnector",
217+
"topics": "connect-test",
218+
"tasks.max": 1,
219+
"key.converter": "org.apache.kafka.connect.json.JsonConverter",
220+
"key.converter.schemas.enable": "false",
221+
"value.converter": "org.apache.kafka.connect.json.JsonConverter",
222+
"value.converter.schemas.enable": "false",
223+
"aep.endpoint": "https://dcs.adobedc.net/collection/{DATA_INLET_ID}",
224+
"aep.flush.interval.seconds": 1,
225+
"aep.flush.bytes.kb": 4,
226+
"aep.connection.auth.enabled": true,
227+
"aep.connection.auth.token.type": "oauth2_access_token",
228+
"aep.connection.auth.client.id": "<client_id>",
229+
"aep.connection.auth.client.secret": "<client_secret>"
230+
"aep.connection.auth.endpoint": "<ims-url>",
231+
"aep.connection.endpoint.headers": "<optional-header-that-needs-to-be-passed-to-AEP>"
232+
}
233+
}' http://localhost:8083/connectors
234+
```
235+
236+
Note -
237+
1.
238+
`aep.connection.endpoint.headers` format should be JSON-encoded. Example: To send below 2 HTTP headers -
239+
1. key: `x-adobe-flow-id`, value: `341fd4f0-cdec-4912-1ab6-fb54aeb41286`
240+
2. key: `x-adobe-dataset-id`, value: `3096fbfd5978431948af3ba3`
241+
242+
Use config -
243+
```json
244+
"aep.connection.endpoint.headers": "{\"x-adobe-flow-id\":\"341fd4f0-cdec-4912-1ab6-fb54aeb41286\", \"x-adobe-dataset-id\": \"3096fbfd5978431948af3ba3\"}"
245+
```
246+
247+
2.
248+
`aep.connection.auth.endpoint` value for prod
249+
`<ims-url>` : `https://ims-na1.adobelogin.com`
250+
233251
234252
2. Using jwt_token **[DEPRECATED]**
235253
- Convert private.key from adobe console to PKCS8 private using command
@@ -267,19 +285,26 @@ Use the command below to set up a Sink connector to a Authenticated Streaming Co
267285
}' http://localhost:8083/connectors
268286
```
269287
270-
Note - `aep.connection.endpoint.headers` format should be JSON-encoded.
271-
Example: To send below 2 HTTP headers -
272-
1. key: `x-adobe-flow-id`, value: `341fd4f0-cdec-4912-1ab6-fb54aeb41286`
273-
2. key: `x-adobe-dataset-id`, value: `3096fbfd5978431948af3ba3`
274-
288+
Note -
289+
1.
290+
`aep.connection.endpoint.headers` format should be JSON-encoded. Example: To send below 2 HTTP headers -
291+
1. key: `x-adobe-flow-id`, value: `341fd4f0-cdec-4912-1ab6-fb54aeb41286`
292+
2. key: `x-adobe-dataset-id`, value: `3096fbfd5978431948af3ba3`
293+
275294
Use config -
276295
```json
277296
"aep.connection.endpoint.headers": "{\"x-adobe-flow-id\":\"341fd4f0-cdec-4912-1ab6-fb54aeb41286\", \"x-adobe-dataset-id\": \"3096fbfd5978431948af3ba3\"}"
278297
```
279-
#### note : jwt_token authentication is deprecated
298+
299+
2.
300+
`aep.connection.auth.endpoint` value for prod
301+
`<ims-url>` : `https://ims-na1.adobelogin.com`
302+
303+
#### Note : jwt_token authentication is deprecated
280304
281305
282-
3. Using oauth2_access_token
306+
3. Using access_token
307+
283308
- Create http connector
284309
```shell
285310
curl -s -X POST \
@@ -296,27 +321,33 @@ Use the command below to set up a Sink connector to a Authenticated Streaming Co
296321
"value.converter.schemas.enable": "false",
297322
"aep.endpoint": "https://dcs.adobedc.net/collection/{DATA_INLET_ID}",
298323
"aep.flush.interval.seconds": 1,
299-
"aep.flush.bytes.kb": 4,
324+
"aep.flush.bytes.kb": 4,
300325
"aep.connection.auth.enabled": true,
301-
"aep.connection.auth.token.type": "oauth2_access_token",
302-
"aep.connection.auth.client.id": "<client_id>",
303-
"aep.connection.auth.client.secret": "<client_secret>"
326+
"aep.connection.auth.token.type": "access_token",
304327
"aep.connection.auth.endpoint": "<ims-url>",
305328
"aep.connection.endpoint.headers": "<optional-header-that-needs-to-be-passed-to-AEP>"
329+
"aep.connection.auth.client.id": "<client_id>",
330+
"aep.connection.auth.client.code": "<client_code>",
331+
"aep.connection.auth.client.secret": "<client_secret>"
306332
}
307333
}' http://localhost:8083/connectors
308334
```
309335
310-
Note - `aep.connection.endpoint.headers` format should be JSON-encoded.
311-
Example: To send below 2 HTTP headers -
312-
1. key: `x-adobe-flow-id`, value: `341fd4f0-cdec-4912-1ab6-fb54aeb41286`
313-
2. key: `x-adobe-dataset-id`, value: `3096fbfd5978431948af3ba3`
336+
Note -
337+
1.
338+
`aep.connection.endpoint.headers` format should be JSON-encoded. Example: To send below 2 HTTP headers -
339+
1. key: `x-adobe-flow-id`, value: `341fd4f0-cdec-4912-1ab6-fb54aeb41286`
340+
2. key: `x-adobe-dataset-id`, value: `3096fbfd5978431948af3ba3`
314341
315342
Use config -
316343
```json
317344
"aep.connection.endpoint.headers": "{\"x-adobe-flow-id\":\"341fd4f0-cdec-4912-1ab6-fb54aeb41286\", \"x-adobe-dataset-id\": \"3096fbfd5978431948af3ba3\"}"
318345
```
319346
347+
2.
348+
`aep.connection.auth.endpoint` value for prod
349+
`<ims-url>` : `https://ims-na1.adobelogin.com`
350+
320351
#### Batching
321352
322353
Use the command below to set up an Sink connector to batch up requests and reduce the number of network calls

0 commit comments

Comments
 (0)