forked from vtex/openapi-schemas
-
Notifications
You must be signed in to change notification settings - Fork 0
/
VTEX - Message Center API.json
171 lines (171 loc) · 6.79 KB
/
VTEX - Message Center 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
{
"openapi": "3.0.0",
"info": {
"version": "1.0.0",
"title": "Message Center API",
"license": {
"name": "MIT"
}
},
"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": "{accountName}"
},
"environment": {
"description": "Environment to use. Used as part of the URL.",
"default": "{environment}"
}
}
}
],
"paths": {
"/api/mail-service/pvt/providers/{EmailProvider}/dkim": {
"post": {
"summary": "Generate DKIM keys",
"description": "Create DKIM keys for sender that was setup in VTEX mail servers",
"operationId": "createDKIM",
"tags": ["DKIM Configuration"],
"parameters": [
{
"name": "EmailProvider",
"in": "path",
"required": true,
"description": "E-mail address for sender that was setup in VTEX mail servers",
"schema": {
"type": "string",
"default": "help@valdie.co"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/200_OK"
},
"examples": {
"emailNotFound": {
"summary": "emailNotFound summary",
"value": {
"status": "emailNotFound",
"dkimKeys": null
}
},
"emailNotVerified": {
"summary": "emailNotVerified summary",
"value": {
"status": "emailNotVerified",
"dkimKeys": null
}
},
"created": {
"summary": "created summary",
"value": {
"status": "created",
"dkimKeys": [
"'n3zbltwizctxpgcmqrars4bmfdd3zlyo._domainkey.valdie.co','CNAME','n3zbltwizctxpgcmqrars4bmfdd3zlyo.dkim.amazonses.com'",
"'sq4iae4be52fhqq3wm44btttvndeecfv._domainkey.valdie.co','CNAME','sq4iae4be52fhqq3wm44btttvndeecfv.dkim.amazonses.com'",
"'n4z6g2g7yfy4pnhjklfesxrrkt4o2ha4._domainkey.valdie.co','CNAME','n4z6g2g7yfy4pnhjklfesxrrkt4o2ha4.dkim.amazonses.com'"
]
}
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401_Unauthorized"
},
"examples": {
"unauthorized": {
"summary": "unauthorized summary",
"value": {
"type": "https://tools.ietf.org/html/rfc7235#section-3.1",
"title": "Unauthorized",
"status": 401,
"traceId": "00-f8949e0e2a80ff4481b4375908349701-a6a7ecf8b50a2043-00"
}
}
}
}
}
}
}
}
}
},
"security": [
{
"appKey": [],
"appToken": []
}
],
"components": {
"securitySchemes": {
"appKey": {
"type": "apiKey",
"in": "header",
"name": "X-VTEX-API-AppKey"
},
"appToken": {
"type": "apiKey",
"in": "header",
"name": "X-VTEX-API-AppToken"
}
},
"schemas": {
"200_OK": {
"type": "object",
"additionalProperties": true,
"required": ["status"],
"properties": {
"status": {
"type": "string",
"enum": ["emailNotFound", "emailNotVerified", "created"]
},
"dkimKeys": {
"type": "array",
"additionalProperties": true,
"nullable": true
}
}
},
"401_Unauthorized": {
"type": "object",
"additionalProperties": true,
"required": ["type", "title", "status", "traceId"],
"properties": {
"type": {
"type": "string",
"enum": [
"https://tools.ietf.org/html/rfc7235#section-3.1"
]
},
"title": {
"type": "string",
"enum": ["Unauthorized"]
},
"status": {
"type": "integer",
"enum": [401]
},
"traceId": {
"type": "string",
"pattern": "^00-[0-9a-f]{32}-[0-9a-f]{16}-00$"
}
}
}
}
}
}