-
Notifications
You must be signed in to change notification settings - Fork 133
/
VTEX - Legacy CMS Portal API.json
189 lines (189 loc) · 10.9 KB
/
VTEX - Legacy CMS Portal 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
{
"openapi": "3.0.0",
"info": {
"title": "Legacy CMS Portal API",
"description": "[CMS (Content Management System)](https://help.vtex.com/en/tracks/cms--2YcpgIljVaLVQYMzxQbc3z/1oN446gRGcR2s70RvBCAmj) is a feature dedicated to manage content in a constant and practical manner. With the Legacy CMS Portal API, you will be able to update your website internet communication protocol.\r\n\r\n## Index \r\n\r\n ### Change URI Schema\r\n\r\n- `PUT` [Update all account's websites internet communication protocol](https://developers.vtex.com/docs/api-reference/legacy-cms-portal-api#put-/api/catalog_system/pvt/virtualfolder/changeurischema/-protocol-)\r\n- `PUT` [Update specific website comunication protocol](https://developers.vtex.com/docs/api-reference/legacy-cms-portal-api#put-/api/catalog_system/pvt/virtualfolder/site/-websiteId-/changeurischema/-protocol-)\n\n**Server**\n- `https://{accountName}.vtexcommercestable.com.br/`\r\n\r\n### Common parameters\r\n\r\n| **Parameter name** | **Description** | **Type** |\r\n| --------------- | ----------------- | ----------------- |\r\n| {{accountName}} | Name of the VTEX account. Used as part of the URL. | Server variable. |\r\n| {{protocol}} | Internet communication protocol, it can be `HTTP` or `HTTPS`. | Path variable. |\r\n\r\n ",
"contact": {},
"version": "1.0"
},
"servers": [
{
"url": "https://{accountName}.vtexcommercestable.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"
}
}
}
],
"components": {
"securitySchemes": {
"appKey": {
"type": "apiKey",
"in": "header",
"name": "X-VTEX-API-AppKey",
"description": "Unique identifier of the [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys)."
},
"appToken": {
"type": "apiKey",
"in": "header",
"name": "X-VTEX-API-AppToken",
"description": "Secret token of the [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys)."
},
"VtexIdclientAutCookie": {
"type": "apiKey",
"in": "header",
"name": "VtexIdclientAutCookie",
"description": "[User token](https://developers.vtex.com/docs/guides/api-authentication-using-user-tokens), valid for 24 hours."
}
},
"parameters": {
"Content-Type": {
"name": "Content-Type",
"in": "header",
"description": "Type of the content being sent.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"example": "application/json"
}
},
"Accept": {
"name": "Accept",
"in": "header",
"description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"example": "application/json"
}
}
}
},
"paths": {
"/api/catalog_system/pvt/virtualfolder/changeurischema/{protocol}": {
"put": {
"tags": [
"Change URI Schema"
],
"summary": "Update all account's websites internet communication protocol",
"description": "Updates all account's website protocols to `HTTP` or `HTTPS`.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https:\/\/developers.vtex.com\/docs\/guides\/authentication-overview#application-keys) must have the appropriate [License Manager resource](https:\/\/help.vtex.com\/en\/tutorial\/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise, they will receive a status code `403` error. This is the applicable resource for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Catalog | Configuration | **CMS Management** |\r\n\r\nThere are no applicable [predefined roles](https:\/\/help.vtex.com\/en\/tutorial\/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https:\/\/help.vtex.com\/en\/tutorial\/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add the resources above to use this endpoint.\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https:\/\/developers.vtex.com\/docs\/guides\/authentication-overview#machine-authentication).\r\n\r\n>\u2757 To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https:\/\/help.vtex.com\/en\/tutorial\/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.",
"operationId": "Changeentireaccount(allwebsites)",
"parameters": [
{
"name": "protocol",
"in": "path",
"description": "Internet communication protocol, it can be `HTTP` or `HTTPS`.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"example": "https"
}
},
{
"$ref": "#/components/parameters/Content-Type"
},
{
"$ref": "#/components/parameters/Accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"title": "Request Status",
"description": "Message indicating that the request was successful.",
"type": "string"
},
"example": "OK"
}
}
}
},
"deprecated": false
}
},
"/api/catalog_system/pvt/virtualfolder/site/{websiteId}/changeurischema/{protocol}": {
"put": {
"tags": [
"Change URI Schema"
],
"summary": "Update specific website comunication protocol",
"description": "Updates a specific website protocol to `HTTP` or `HTTPS`.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https:\/\/developers.vtex.com\/docs\/guides\/authentication-overview#application-keys) must have the appropriate [License Manager resource](https:\/\/help.vtex.com\/en\/tutorial\/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise, they will receive a status code `403` error. This is the applicable resource for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Catalog | Configuration | **CMS Management** |\r\n\r\nThere are no applicable [predefined roles](https:\/\/help.vtex.com\/en\/tutorial\/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https:\/\/help.vtex.com\/en\/tutorial\/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add the resources above to use this endpoint.\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https:\/\/developers.vtex.com\/docs\/guides\/authentication-overview#machine-authentication).\r\n\r\n>\u2757 To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https:\/\/help.vtex.com\/en\/tutorial\/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.",
"operationId": "Changespecificwebsite",
"parameters": [
{
"name": "websiteId",
"in": "path",
"description": "Specific website ID.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"example": "292c47c7-0b81-48f9-a5a0-dcf240100884"
}
},
{
"name": "protocol",
"in": "path",
"description": "Internet communication protocol, it can be `HTTP` or `HTTPS`.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"example": "https"
}
},
{
"$ref": "#/components/parameters/Content-Type"
},
{
"$ref": "#/components/parameters/Accept"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"title": "Request Status",
"description": "Message indicating that the request was successful.",
"type": "string"
},
"example": "OK"
}
}
}
},
"deprecated": false
}
}
},
"tags": [
{
"name": "Change URI Schema",
"description": "Changes CMS URI"
}
],
"security": [
{
"appKey": [],
"appToken": []
}
]
}