@@ -74,38 +74,87 @@ is to either use your existing authentication token and API key combination, or
7474
7575Once you have an IMS access token and API key, it needs to be provided as part of the POST request.
7676
77+ Note that the sandbox-name is optional, if not provided will default to the Production sandbox.
78+
79+
7780```
78- CURL -X POST "https://platform.adobe.io/data/core/edge/inlet" \
79- -H "Cache-Control: no-cache" \
80- -H "Content-Type: application/json" \
81- -H "Authorization: Bearer {ACCESS_TOKEN}" \
82- -H "x-api-key: {API_KEY}" \
83- -H "x-gw-ims-org-id: {IMS_ORG}" \
84- -d '{
85- "name" : "<data_inlet_name>",
86- "description" : "<data_inlet_description>",
87- "sourceId" : "<identifier_of_device_or_source_that_helps_you_identify_it>",
88- "dataType": "xdm"
89- }'
81+ curl -X POST https://platform.adobe.io/data/foundation/flowservice/connections \
82+ -H 'Authorization: Bearer {ACCESS_TOKEN}' \
83+ -H 'Content-Type: application/json' \
84+ -H 'x-gw-ims-org-id: {IMS_ORG}' \
85+ -H 'x-api-key: {API_KEY}' \
86+ -H 'x-sandbox-name: {SANDBOX_NAME}' \
87+ -d '{
88+ "name": "Sample Streaming Connection",
89+ "providerId": "521eee4d-8cbe-4906-bb48-fb6bd4450033",
90+ "description": "Sample description",
91+ "connectionSpec": {
92+ "id": "bc7b00d6-623a-4dfc-9fdb-f1240aeadaeb",
93+ "version": "1.0"
94+ },
95+ "auth": {
96+ "specName": "Streaming Connection",
97+ "params": {
98+ "sourceId": "Sample connection source",
99+ "dataType": "xdm",
100+ "name": "Sample connection"
101+ }
102+ }
103+ }
104+ ```
105+
106+ If the request was successful a new Streaming Connection should be created for you. The response will looking similar to
107+ the one below. The ` id ` field in the response is the Connection Id.
108+
109+ ``` json
110+ {
111+ "id" : " 77a05521-91d6-451c-a055-2191d6851c34" ,
112+ "etag" : " \" a500e689-0000-0200-0000-5e31df730000\" "
113+ }
90114```
91115
92- If the request was successful a new Data Inlet should be created for you. The response will looking similar to
93- the one below
116+ With the connection created, you can now retrieve your data collection URL from the connection information.
117+
118+ ```
119+ curl -X GET https://platform.adobe.io/data/foundation/flowservice/connections/{CONNECTION_ID} \
120+ -H 'Authorization: Bearer {ACCESS_TOKEN}' \
121+ -H 'x-gw-ims-org-id: {IMS_ORG}' \
122+ -H 'x-api-key: {API_KEY}' \
123+ -H 'x-sandbox-name: {SANDBOX_NAME}'
124+ ```
94125
95126```
96127{
97- "inletUrl": "https://dcs.adobedc.net/collection/{DATA_INLET_ID}",
98- "inletId": "{DATA_INLET_ID}",
99- "imsOrg": "{IMS_ORG}",
100- "sourceId": "website",
101- "dataType": "xdm",
102- "name": "My Data Inlet",
103- "description": "Collects streaming data from my website",
104- "authenticationRequired": false,
105- "createdBy": "{API_KEY}",
106- "createdAt": "2019-01-11T21:03:49.090Z",
107- "modifiedBy": "{API_KEY}",
108- "modifiedAt": "2019-01-11T21:03:49.090Z"
128+ "items": [
129+ {
130+ "createdAt": 1583971856947,
131+ "updatedAt": 1583971856947,
132+ "createdBy": "{API_KEY}",
133+ "updatedBy": "{API_KEY}",
134+ "createdClient": "{USER_ID}",
135+ "updatedClient": "{USER_ID}",
136+ "id": "77a05521-91d6-451c-a055-2191d6851c34",
137+ "name": "Another new sample connection (Experience Event)",
138+ "description": "Sample description",
139+ "connectionSpec": {
140+ "id": "bc7b00d6-623a-4dfc-9fdb-f1240aeadaeb",
141+ "version": "1.0"
142+ },
143+ "state": "enabled",
144+ "auth": {
145+ "specName": "Streaming Connection",
146+ "params": {
147+ "sourceId": "Sample connection (ExperienceEvent)",
148+ "inletUrl": "https://dcs.adobedc.net/collection/a868e1ce678a911ef1482b083329af3cafa4bafdc781285f25911eaae9e00eb2",
149+ "inletId": "a868e1ce678a911ef1482b083329af3cafa4bafdc781285f25911eaae9e00eb2",
150+ "dataType": "xdm",
151+ "name": "Sample connection (ExperienceEvent)"
152+ }
153+ },
154+ "version": "\"56008aee-0000-0200-0000-5e697e150000\"",
155+ "etag": "\"56008aee-0000-0200-0000-5e697e150000\""
156+ }
157+ ]
109158}
110159```
111160
0 commit comments