forked from vtex/openapi-schemas
-
Notifications
You must be signed in to change notification settings - Fork 0
/
VTEX - Session Manager API.json
609 lines (609 loc) · 34.1 KB
/
VTEX - Session Manager API.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
{
"openapi": "3.0.0",
"info": {
"title": "Session Manager API",
"description": "Session Manager tracks the current browsing sessions of all customers on the VTEX platform. Important session information is automatically captured and stored in a secure and easily accessible location. This includes data such as relevant cookies, query strings, authentication credentials, current profile and pricing information, if applicable. Session Manager API allows developers to retrieve and manage information about sessions. No authentication is required.\r\n\r\nFor more information, read the [Session Manager guide](https://developers.vtex.com/docs/guides/session-manager).\r\n\r\n## Index\r\n\r\n### Sessions\r\n\r\n- `POST` [Create new session](https://developers.vtex.com/docs/api-reference/session-manager-api#post-/api/sessions)\r\n- `GET` [Get session](https://developers.vtex.com/docs/api-reference/session-manager-api#get-/api/sessions)\r\n- `PATCH` [Edit session](https://developers.vtex.com/docs/api-reference/session-manager-api#patch-/api/sessions)\r\n\r\n### Segment\r\n\r\n- `GET` [Get segment](https://developers.vtex.com/docs/api-reference/session-manager-api#get-/api/segments)",
"contact": {},
"version": "1.0"
},
"servers": [
{
"url": "https://{accountName}.{environment}.com.br",
"description": "VTEX server URL.",
"variables": {
"accountName": {
"description": "Name of the VTEX account. Used as part of the URL",
"default": "apiexamples"
},
"environment": {
"description": "Environment to use. Used as part of the URL.",
"enum": [
"vtexcommercestable"
],
"default": "vtexcommercestable"
}
}
}
],
"paths": {
"/api/sessions": {
"post": {
"tags": [
"Session"
],
"summary": "Create new session",
"description": "Creates a new session and returns a session token and a segment token. Also stores `vtex_session` and `vtex_segment` cookies, with the same values returned in the response.\n\r\n\rAll parameters in the body that are not within the public namespace will be ignored. Query string items will automatically be added to the public namespace.\n\r\n\rNo authentication is required.\n\r\n\r>⚠️ The Session Manager API uses the `vtex_session` and `vtex_segment` cookies to store the data required to identify the user and the session. These cookies are stored in the user's browser when the session is created and sent automatically in every request to that domain. You will have to reproduce that by sending these cookies as headers in other requests to Session Manager API in order for it to work outside of a browser environment.",
"operationId": "Createnewsession",
"parameters": [],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateEditSessionRequest"
},
"example": {
"public": {
"variable1": {
"value": "value1"
},
"variable2": {
"value": "value2"
}
}
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateEditSessionResponse"
},
"example": {
"sessionToken": "eyJhbGciOiJFUzI1NiIsImtpZCI6IjM5MEI4MTM1RDUzQ0MwMUY0RjA4N0YwMzA2RjhDODMzNzBDMjY4M0UiLCJ0eXAiOiJqd3QifQ.eyJhY2NvdW50LmlkIjoiYThiMjdmYjQtNjUxNi00Y2MwLTgyYjYtYTVmMmIwMTFlNmUyIiwiaWQiOiIyNmQyY2I2Yy0yMTNlLTQ5MzYtOWUyYS0xZDFlMjk5ZWMzM2IiLCJ2ZXJzaW9uIjoyLCJzdWIiOiJzZXNzaW9uIiwiYWNjb3VudCI6InNlc3Npb24iLCJleHAiOjE2OTM1Nzg5NzYsImlhdCI6MTY5Mjg4Nzc3NiwiaXNzIjoidG9rZW4tZW1pdHRlciIsImp0aSI6IjhiYWU2NzdmLWE0NTAtNGI0OC05YTBkLTViMzAwYjNiY2NkOCJ9.Ak1bn2xEA1A5dVN4qR6RI8vnZpSpLXyVxFCthMoVjmWn0HlP5BqMHEMYApDj8TPPhyxT0hGT0vkmvMQa2Mprrw",
"segmentToken": "eyJjYW1wYWlnbnMiOm51bGwsImNoYW5uZWwiOiIxIiwicHJpY2VUYWJsZXMiOm51bGwsInJlZ2lvbklkIjpudWxsLCJ1dG1fY2FtcGFpZ24iOm51bGwsInV0bV9zb3VyY2UiOm51bGwsInV0bWlfY2FtcGFpZ24iOm51bGwsImN1cnJlbmN5Q29kZSI6IkJSTCIsImN1cnJlbmN5U3ltYm9sIjoiUiQiLCJjb3VudHJ5Q29kZSI6IkJSQSIsImN1bHR1cmVJbmZvIjoiZW4tVVMiLCJjaGFubmVsUHJpdmFjeSI6InB1YmxpYyJ9"
}
}
}
}
},
"deprecated": false
},
"get": {
"tags": [
"Session"
],
"summary": "Get session",
"description": "Retrieves information from a previously created sesssion.\n\r\n\r>⚠️ The Session Manager API uses the `vtex_session` and `vtex_segment` cookies to store the data required to identify the user and the session. These cookies are stored in the user's browser when the session is created and sent automatically in every request to that domain. You will have to reproduce that by sending these cookies as headers to Session Manager API in order for it to work outside of a browser environment.",
"operationId": "GetSession",
"parameters": [
{
"name": "items",
"in": "query",
"description": "Items are the keys of the values you wish to get. They follow the format `namespace1.key1,namespace2.key2`.\n\r\n\rIf you wish to recover the data sent on [Create new session](https://developers.vtex.com/docs/api-reference/session-manager-api#post-/api/sessions), it should be `public.{key}`, replacing `{key}` with the name of the custom property you created. Following the example request presented in [Create new session](https://developers.vtex.com/docs/api-reference/session-manager-api#post-/api/sessions), it would be `public.variable1,public.variable2`.\n\r\n\rIf you want to retrieve all keys from Session Manager, you can use the wildcard operator (`*`) as a value for this query parameter.",
"required": true,
"style": "form",
"explode": true,
"schema": {
"type": "string",
"example": "*"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetSessionResponse"
},
"example": {
"id": "26d2cb6c-213e-4936-9e2a-1d1e299ec33b",
"namespaces": {
"account": {
"id": {
"value": "a8b27fb4-6516-4cc0-82b6-a5f2b011e6e2",
"keepAlive": true
},
"accountName": {
"value": "apiexamples"
}
},
"store": {
"channel": {
"value": "1"
},
"countryCode": {
"value": "BRA"
},
"cultureInfo": {
"value": "en-US"
},
"currencyCode": {
"value": "BRL"
},
"currencySymbol": {
"value": "R$"
},
"channelPrivacy": {
"value": "public"
}
},
"public": {
"variable1": {
"value": "value1"
},
"variable2": {
"value": "value2"
}
},
"checkout": {
"regionId": {
"value": "v2.1BB18CE648B5111D0933734ED83EC783"
}
}
}
}
}
}
}
},
"security": [
{
"vtex_session": [],
"vtex_segment": []
}
],
"deprecated": false
},
"patch": {
"tags": [
"Session"
],
"summary": "Edit session",
"description": "Edits information from a previously created sesssion.\n\r\n\rThis endpoint works the same way as the [Create new session](https://developers.vtex.com/docs/api-reference/session-manager-api#post-/api/sessions) endpoint, but when the request is sent with a `vtex_session` and the `vtex_segment` cookies in the header, it retrieves the session first and then applies the changes instead of generating a new one.\n\r\n\rOnly keys inside the `public` namespace in the request body are considered, and query parameters are automatically added to the public namespace.\n\r\n\r>⚠️ The Session Manager API uses the `vtex_session` and `vtex_segment` cookies to store the data required to identify the user and the session. These cookies are stored in the user's browser when the session is created and sent automatically in every request to that domain. You will have to reproduce that by sending these cookies as headers to Session Manager API in order for it to work outside of a browser environment.",
"operationId": "Editsession",
"parameters": [],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateEditSessionRequest"
},
"example": {
"public": {
"variable2": {
"value": "value2_patched"
},
"variable3": {
"value": "value3"
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateEditSessionResponse"
},
"example": {
"sessionToken": "eyJhbGciOiJFUzI1NiIsImtpZCI6IjM5MEI4MTM1RDUzQ0MwMUY0RjA4N0YwMzA2RjhDODMzNzBDMjY4M0UiLCJ0eXAiOiJqd3QifQ.eyJhY2NvdW50LmlkIjoiYThiMjdmYjQtNjUxNi00Y2MwLTgyYjYtYTVmMmIwMTFlNmUyIiwiaWQiOiIyNmQyY2I2Yy0yMTNlLTQ5MzYtOWUyYS0xZDFlMjk5ZWMzM2IiLCJ2ZXJzaW9uIjoyLCJzdWIiOiJzZXNzaW9uIiwiYWNjb3VudCI6InNlc3Npb24iLCJleHAiOjE2OTM1Nzg5NzYsImlhdCI6MTY5Mjg4Nzc3NiwiaXNzIjoidG9rZW4tZW1pdHRlciIsImp0aSI6IjhiYWU2NzdmLWE0NTAtNGI0OC05YTBkLTViMzAwYjNiY2NkOCJ9.Ak1bn2xEA1A5dVN4qR6RI8vnZpSpLXyVxFCthMoVjmWn0HlP5BqMHEMYApDj8TPPhyxT0hGT0vkmvMQa2Mprrw",
"segmentToken": "eyJjYW1wYWlnbnMiOm51bGwsImNoYW5uZWwiOiIxIiwicHJpY2VUYWJsZXMiOm51bGwsInJlZ2lvbklkIjpudWxsLCJ1dG1fY2FtcGFpZ24iOm51bGwsInV0bV9zb3VyY2UiOm51bGwsInV0bWlfY2FtcGFpZ24iOm51bGwsImN1cnJlbmN5Q29kZSI6IkJSTCIsImN1cnJlbmN5U3ltYm9sIjoiUiQiLCJjb3VudHJ5Q29kZSI6IkJSQSIsImN1bHR1cmVJbmZvIjoiZW4tVVMiLCJjaGFubmVsUHJpdmFjeSI6InB1YmxpYyJ9"
}
}
}
}
},
"security": [
{
"vtex_session": [],
"vtex_segment": []
}
],
"deprecated": false
}
},
"/api/segments": {
"get": {
"tags": [
"Segment"
],
"summary": "Get segment",
"description": "Retrieves information about the segment, which contains additional data related to the session's context.\n\r\n\rYou can add certain public fields as the query string and the system will attempt to fulfill it. Values such as `cultureInfo` and `utm` are overwriteable, just keep in mind such changes will not be reflected in the client's session.\n\r\n\rIf you wish to change the value on the session (and thus be reflected on the segment without special query strings), then use the [Edit session](https://developers.vtex.com/docs/api-reference/session-manager-api#patch-/api/sessions) endpoint. ## Permissions\r\n\r\nThis endpoint does not require [authentication](https:\/\/developers.vtex.com\/docs\/guides\/authentication) or [permissions](https:\/\/help.vtex.com\/en\/tutorial\/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).",
"operationId": "GetSegment",
"parameters": [],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Segment"
},
"example": {
"campaigns": null,
"channel": "1",
"priceTables": null,
"regionId": "v2.1BB18CE648B5111D0933734ED83EC783",
"utm_campaign": null,
"utm_source": null,
"utmi_campaign": null,
"currencyCode": "BRL",
"currencySymbol": "R$",
"countryCode": "BRA",
"cultureInfo": "en-US",
"channelPrivacy": "public"
}
}
}
}
},
"security": [
{
"vtex_session": [],
"vtex_segment": []
}
],
"deprecated": false
}
}
},
"components": {
"securitySchemes": {
"vtex_session": {
"type": "apiKey",
"in": "cookie",
"name": "vtex_session",
"description": "Token that identifies the user's individual session. Obtained [when a new session is created](https://developers.vtex.com/docs/api-reference/session-manager-api#post-/api/sessions)."
},
"vtex_segment": {
"type": "apiKey",
"in": "cookie",
"name": "vtex_segment",
"description": "Token that identifies the user's segment, shared with other users with similar navigation parameters. Obtained [when a new session is created](https://developers.vtex.com/docs/api-reference/session-manager-api#post-/api/sessions)."
}
},
"schemas": {
"CreateEditSessionRequest": {
"title": "CreateEditSessionRequest",
"required": [
"public"
],
"type": "object",
"properties": {
"public": {
"title": "Public",
"type": "object",
"properties": {
"additionalProperties": {
"type": "object",
"description": "Custom property.",
"properties": {
"value": {
"type": "string",
"description": "Value of the custom property."
}
}
}
},
"example": {
"variable2": {
"value": "value2"
},
"variable3": {
"value": "value3"
}
}
}
},
"example": {
"public": {
"variable2": {
"value": "value2"
},
"variable3": {
"value": "value3"
}
}
}
},
"CreateEditSessionResponse": {
"type": "object",
"description": "Object containing session token and segment token.",
"properties": {
"sessionToken": {
"type": "string",
"description": "Token that identifies the user's individual session."
},
"segmentToken": {
"type": "string",
"description": "Token that identifies the user's segment, shared with other users with similar navigation parameters."
}
},
"example": {
"sessionToken": "eyJhbGciOiJFUzI1NiIsImtpZCI6IjM5MEI4MTM1RDUzQ0MwMUY0RjA4N0YwMzA2RjhDODMzNzBDMjY4M0UiLCJ0eXAiOiJqd3QifQ.eyJhY2NvdW50LmlkIjoiYThiMjdmYjQtNjUxNi00Y2MwLTgyYjYtYTVmMmIwMTFlNmUyIiwiaWQiOiIyNmQyY2I2Yy0yMTNlLTQ5MzYtOWUyYS0xZDFlMjk5ZWMzM2IiLCJ2ZXJzaW9uIjoyLCJzdWIiOiJzZXNzaW9uIiwiYWNjb3VudCI6InNlc3Npb24iLCJleHAiOjE2OTM1Nzg5NzYsImlhdCI6MTY5Mjg4Nzc3NiwiaXNzIjoidG9rZW4tZW1pdHRlciIsImp0aSI6IjhiYWU2NzdmLWE0NTAtNGI0OC05YTBkLTViMzAwYjNiY2NkOCJ9.Ak1bn2xEA1A5dVN4qR6RI8vnZpSpLXyVxFCthMoVjmWn0HlP5BqMHEMYApDj8TPPhyxT0hGT0vkmvMQa2Mprrw",
"segmentToken": "eyJjYW1wYWlnbnMiOm51bGwsImNoYW5uZWwiOiIxIiwicHJpY2VUYWJsZXMiOm51bGwsInJlZ2lvbklkIjpudWxsLCJ1dG1fY2FtcGFpZ24iOm51bGwsInV0bV9zb3VyY2UiOm51bGwsInV0bWlfY2FtcGFpZ24iOm51bGwsImN1cnJlbmN5Q29kZSI6IkJSTCIsImN1cnJlbmN5U3ltYm9sIjoiUiQiLCJjb3VudHJ5Q29kZSI6IkJSQSIsImN1bHR1cmVJbmZvIjoiZW4tVVMiLCJjaGFubmVsUHJpdmFjeSI6InB1YmxpYyJ9"
}
},
"GetSessionResponse": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Session ID."
},
"namespaces": {
"type": "object",
"description": "Object with namespaces, each containing a set of information about the session.",
"properties": {
"account": {
"type": "object",
"description": "Account information related to the session.",
"properties": {
"id": {
"type": "object",
"description": "VTEX account ID.",
"properties": {
"value": {
"type": "string",
"description": "Value of the VTEX account ID."
},
"keepAlive": {
"type": "boolean",
"description": "Determines whether or not the connection should be kept alive."
}
}
},
"accountName": {
"type": "object",
"description": "VTEX account name.",
"properties": {
"value": {
"type": "string",
"description": "Value of the VTEX account name."
}
}
}
}
},
"store": {
"type": "object",
"description": "Store information related to the session.",
"properties": {
"channel": {
"type": "object",
"description": "[Trade policy](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV) ID.",
"properties": {
"value": {
"type": "string",
"description": "Value of the [Trade policy](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV) ID."
}
}
},
"countryCode": {
"type": "object",
"description": "Country code.",
"properties": {
"value": {
"type": "string",
"description": "Value of the country code."
}
}
},
"cultureInfo": {
"type": "object",
"description": "Locale that provides culture-specific information, such as the language, sublanguage, country/region, calendar, and conventions associated with a particular culture. Read [this documentation](https://learn.microsoft.com/en-us/dotnet/api/system.globalization.cultureinfo?view=net-7.0#culture-names-and-identifiers) for more details.",
"properties": {
"value": {
"type": "string",
"description": "Value of the `cultureInfo` property."
}
}
},
"currencyCode": {
"type": "object",
"description": "Currency code.",
"properties": {
"value": {
"type": "string",
"description": "Value of the currency code."
}
}
},
"currencySymbol": {
"type": "object",
"description": "Currency symbol.",
"properties": {
"value": {
"type": "string",
"description": "Value of the currency symbol."
}
}
},
"channelPrivacy": {
"type": "object",
"description": "Defines whether or not the channel is private.",
"properties": {
"value": {
"type": "string",
"description": "Value containing the channel's privacy option."
}
}
}
}
},
"public": {
"type": "object",
"description": "Public and editable information related to the session.",
"additionalProperties": {
"type": "object",
"description": "Custom property.",
"properties": {
"value": {
"type": "string",
"description": "Value of the custom property."
}
}
}
},
"checkout": {
"type": "object",
"description": "Checkout information related to the session.",
"properties": {
"regionId": {
"type": "object",
"description": "ID of the session's region.",
"properties": {
"value": {
"type": "string",
"description": "Value of the Region ID."
}
}
}
}
}
}
}
},
"example": {
"id": "26d2cb6c-213e-4936-9e2a-1d1e299ec33b",
"namespaces": {
"account": {
"id": {
"value": "a8b27fb4-6516-4cc0-82b6-a5f2b011e6e2",
"keepAlive": true
},
"accountName": {
"value": "apiexamples"
}
},
"store": {
"channel": {
"value": "1"
},
"countryCode": {
"value": "BRA"
},
"cultureInfo": {
"value": "en-US"
},
"currencyCode": {
"value": "BRL"
},
"currencySymbol": {
"value": "R$"
},
"channelPrivacy": {
"value": "public"
}
},
"public": {
"variable1": {
"value": "value1"
},
"variable2": {
"value": "value2"
}
},
"checkout": {
"regionId": {
"value": "v2.1BB18CE648B5111D0933734ED83EC783"
}
}
}
}
},
"Segment": {
"type": "object",
"description": "Object containing information about the segment.",
"properties": {
"campaigns": {
"type": "string",
"description": "Campaigns associated with the session."
},
"channel": {
"type": "string",
"description": "[Trade policy](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV) ID."
},
"priceTables": {
"type": "string",
"description": "Price tables associated with the session."
},
"regionId": {
"type": "string",
"description": "ID of the session's region."
},
"utm_campaign": {
"type": "string",
"description": "UTM campaign code."
},
"utm_source": {
"type": "string",
"description": "UTM source code."
},
"utmi_campaign": {
"type": "string",
"description": "UTMI campaign code."
},
"currencyCode": {
"type": "string",
"description": "Currency code."
},
"currencySymbol": {
"type": "string",
"description": "Currency symbol."
},
"countryCode": {
"type": "string",
"description": "Country code."
},
"cultureInfo": {
"type": "string",
"description": "Locale that provides culture-specific information, such as the language, sublanguage, country/region, calendar, and conventions associated with a particular culture. Read [this documentation](https://learn.microsoft.com/en-us/dotnet/api/system.globalization.cultureinfo?view=net-7.0#culture-names-and-identifiers) for more details."
},
"channelPrivacy": {
"type": "string",
"description": "Defines whether or not the channel is private."
}
},
"example": {
"campaigns": null,
"channel": "1",
"priceTables": null,
"regionId": "v2.1BB18CE648B5111D0933734ED83EC783",
"utm_campaign": null,
"utm_source": null,
"utmi_campaign": null,
"currencyCode": "BRL",
"currencySymbol": "R$",
"countryCode": "BRA",
"cultureInfo": "pt-BR",
"channelPrivacy": "public"
}
}
}
},
"tags": [
{
"name": "Session",
"description": ""
},
{
"name": "Segment",
"description": ""
}
]
}