Skip to content

Commit 2e8665d

Browse files
authored
CORE-110647 Updated the imsurl in the documentation (#75)
1 parent 57092d0 commit 2e8665d

File tree

1 file changed

+73
-48
lines changed

1 file changed

+73
-48
lines changed

DEVELOPER_GUIDE.md

+73-48
Original file line numberDiff line numberDiff line change
@@ -205,31 +205,47 @@ 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. `aep.connection.endpoint.headers` format should be JSON-encoded. Example: To send below 2 HTTP headers -
238+
1. key: `x-adobe-flow-id`, value: `341fd4f0-cdec-4912-1ab6-fb54aeb41286`
239+
2. key: `x-adobe-dataset-id`, value: `3096fbfd5978431948af3ba3`
240+
241+
Use config -
242+
```json
243+
"aep.connection.endpoint.headers": "{\"x-adobe-flow-id\":\"341fd4f0-cdec-4912-1ab6-fb54aeb41286\", \"x-adobe-dataset-id\": \"3096fbfd5978431948af3ba3\"}"
244+
```
245+
246+
2. `aep.connection.auth.endpoint` value for prod
247+
`<ims-url>` : `https://ims-na1.adobelogin.com`
248+
233249
234250
2. Using jwt_token **[DEPRECATED]**
235251
- Convert private.key from adobe console to PKCS8 private using command
@@ -267,19 +283,24 @@ Use the command below to set up a Sink connector to a Authenticated Streaming Co
267283
}' http://localhost:8083/connectors
268284
```
269285
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-
275-
Use config -
276-
```json
277-
"aep.connection.endpoint.headers": "{\"x-adobe-flow-id\":\"341fd4f0-cdec-4912-1ab6-fb54aeb41286\", \"x-adobe-dataset-id\": \"3096fbfd5978431948af3ba3\"}"
278-
```
279-
#### note : jwt_token authentication is deprecated
286+
Note -
287+
1. `aep.connection.endpoint.headers` format should be JSON-encoded. Example: To send below 2 HTTP headers -
288+
1. key: `x-adobe-flow-id`, value: `341fd4f0-cdec-4912-1ab6-fb54aeb41286`
289+
2. key: `x-adobe-dataset-id`, value: `3096fbfd5978431948af3ba3`
290+
291+
Use config -
292+
```json
293+
"aep.connection.endpoint.headers": "{\"x-adobe-flow-id\":\"341fd4f0-cdec-4912-1ab6-fb54aeb41286\", \"x-adobe-dataset-id\": \"3096fbfd5978431948af3ba3\"}"
294+
```
280295
296+
2. `aep.connection.auth.endpoint` value for prod
297+
`<ims-url>` : `https://ims-na1.adobelogin.com`
298+
299+
#### Note : jwt_token authentication is deprecated
300+
301+
302+
3. Using access_token
281303
282-
3. Using oauth2_access_token
283304
- Create http connector
284305
```shell
285306
curl -s -X POST \
@@ -296,26 +317,30 @@ Use the command below to set up a Sink connector to a Authenticated Streaming Co
296317
"value.converter.schemas.enable": "false",
297318
"aep.endpoint": "https://dcs.adobedc.net/collection/{DATA_INLET_ID}",
298319
"aep.flush.interval.seconds": 1,
299-
"aep.flush.bytes.kb": 4,
320+
"aep.flush.bytes.kb": 4,
300321
"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>"
322+
"aep.connection.auth.token.type": "access_token",
304323
"aep.connection.auth.endpoint": "<ims-url>",
305324
"aep.connection.endpoint.headers": "<optional-header-that-needs-to-be-passed-to-AEP>"
325+
"aep.connection.auth.client.id": "<client_id>",
326+
"aep.connection.auth.client.code": "<client_code>",
327+
"aep.connection.auth.client.secret": "<client_secret>"
306328
}
307329
}' http://localhost:8083/connectors
308330
```
309331
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`
332+
Note -
333+
1. `aep.connection.endpoint.headers` format should be JSON-encoded. Example: To send below 2 HTTP headers -
334+
1. key: `x-adobe-flow-id`, value: `341fd4f0-cdec-4912-1ab6-fb54aeb41286`
335+
2. key: `x-adobe-dataset-id`, value: `3096fbfd5978431948af3ba3`
314336
315-
Use config -
316-
```json
317-
"aep.connection.endpoint.headers": "{\"x-adobe-flow-id\":\"341fd4f0-cdec-4912-1ab6-fb54aeb41286\", \"x-adobe-dataset-id\": \"3096fbfd5978431948af3ba3\"}"
318-
```
337+
Use config -
338+
```json
339+
"aep.connection.endpoint.headers": "{\"x-adobe-flow-id\":\"341fd4f0-cdec-4912-1ab6-fb54aeb41286\", \"x-adobe-dataset-id\": \"3096fbfd5978431948af3ba3\"}"
340+
```
341+
342+
2. `aep.connection.auth.endpoint` value for prod
343+
`<ims-url>` : `https://ims-na1.adobelogin.com`
319344
320345
#### Batching
321346

0 commit comments

Comments
 (0)