Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Rename Data subject rights API #1063

Merged
merged 3 commits into from
Dec 5, 2023
Merged

Rename Data subject rights API #1063

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6aabf19
edit description
julia-rabello Dec 5, 2023
60ca6d0
rename User Data Rights API
julia-rabello Dec 5, 2023
21e4559
Update generated files by portman
Dec 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
206 changes: 206 additions & 0 deletions PostmanCollections/VTEX - Data Subject Rights.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,206 @@
{
"_": {
"postman_id": "54f33368-355b-478c-bd36-75b3f2bf90a7"
},
"item": [
{
"id": "d484ccb9-7e36-4955-badc-4864eab0988d",
"name": "Data Subject Rights",
"description": {
"content": "",
"type": "text/plain"
},
"item": [
{
"id": "cb30166d-b5f8-4174-8aea-25a9e83472ed",
"name": "Erase customer data",
"request": {
"name": "Erase customer data",
"description": {
"content": "Deletes a given customer's data collected in your store by Checkout, Orders, VTEX ID and Profile System.\r\n\r\n>⚠️ This API is currently in closed alpha testing stage, which means that only specific customers can access it now. Do not share this documentation with people outside of your company. If you do not have access yet, please refer to the [Erasing customer data](https://help.vtex.com/en/tutorial/erasing-customer-data--1R9Fn7A06Ifj4R9YD4JTKU) guide instead.\r\n\r\n>⚠️ Only orders with `invoiced` or `canceled` status are erased in this request.",
"type": "text/plain"
},
"url": {
"path": [
"api",
"user-rights",
"createAndProcessDeleteUserData"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"description": {
"content": "Name of your VTEX account.",
"type": "text/plain"
},
"key": "an",
"value": "mystore"
}
],
"variable": []
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"email\": \"[email protected]\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": [
{
"_": {
"postman_previewlanguage": "json"
},
"id": "acdbf877-da36-41dc-9f05-cfa2915e614b",
"name": "OK",
"originalRequest": {
"url": {
"path": [
"api",
"user-rights",
"createAndProcessDeleteUserData"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"key": "an",
"value": "mystore"
}
],
"variable": []
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "X-VTEX-API-AppKey",
"value": "<API Key>"
},
{
"disabled": false,
"description": {
"content": "(Required) Type of the content being sent.",
"type": "text/plain"
},
"key": "Content-Type",
"value": "application/json"
},
{
"disabled": false,
"description": {
"content": "(Required) HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.",
"type": "text/plain"
},
"key": "Accept",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"email\": \"[email protected]\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"uuid\": \"3e2f53dc-b099-4dc8-9727-581b2a97f39c\",\n \"requestType\": \"Removal\",\n \"email\": \"[email protected]\",\n \"status\": \"Completed\",\n \"dataResponse\": \"{\\r\\n \\\"VTEX Checkout\\\": [],\\r\\n \\\"orders\\\": {\\r\\n \\\"dataStatus\\\": {\\r\\n \\\"status\\\": \\\"anonymized\\\",\\r\\n \\\"reason\\\": \\\"Sensitive information was anonymized rather than deleted to preserve the store metrics.\\\",\\r\\n \\\"evidence\\\": \\\"Anonymized [0] orders\\\",\\r\\n \\\"dryRun\\\": true\\r\\n },\\r\\n \\\"orders\\\": []\\r\\n },\\r\\n \\\"Profile System PII API\\\": {},\\r\\n \\\"VTEX ID\\\": {\\r\\n \\\"type\\\": \\\"https://tools.ietf.org/html/rfc7231#section-6.5.4\\\",\\r\\n \\\"title\\\": \\\"Not Found\\\",\\r\\n \\\"status\\\": 404,\\r\\n \\\"traceId\\\": \\\"00-65d5abf9263b07eb185beee49e2075dc-b67b373e2e93dcf8-00\\\"\\r\\n }\\r\\n}\",\n \"requestTime\": \"2023-09-05T17:19:33.1969022-03:00\",\n \"applications\": [\n {\n \"application\": \"chk\",\n \"status\": \"Deleted\",\n \"errorDetail\": \"\",\n \"updateAt\": \"2023-09-05T20:20:23\"\n },\n {\n \"application\": \"orders\",\n \"status\": \"Deleted\",\n \"errorDetail\": \"\",\n \"updateAt\": \"2023-09-05T20:20:25\"\n },\n {\n \"application\": \"profileSystemV2\",\n \"status\": \"Deleted\",\n \"errorDetail\": \"\",\n \"updateAt\": \"2023-09-05T20:20:26\"\n },\n {\n \"application\": \"vid\",\n \"status\": \"Deleted\",\n \"errorDetail\": \"\",\n \"updateAt\": \"2023-09-05T20:20:29\"\n }\n ]\n}",
"cookie": []
}
],
"event": [
{
"listen": "test",
"script": {
"id": "2939029a-dcf8-4ce4-a4a8-e0439c93f125",
"type": "text/javascript",
"exec": [
"// Validate status 2xx \npm.test(\"[POST]::/api/user-rights/createAndProcessDeleteUserData - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n",
"// Validate if response header has matching content-type\npm.test(\"[POST]::/api/user-rights/createAndProcessDeleteUserData - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n",
"// Validate if response has JSON Body \npm.test(\"[POST]::/api/user-rights/createAndProcessDeleteUserData - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n",
"// Response Validation\nconst schema = {\"type\":\"object\",\"properties\":{\"uuid\":{\"type\":\"string\",\"description\":\"User data rights request unique identifier in [UUID](https://www.uuidtools.com/what-is-uuid) format.\"},\"requestType\":{\"type\":\"string\",\"description\":\"Type of user data rights request.\"},\"email\":{\"type\":\"string\",\"description\":\"Client email.\"},\"status\":{\"type\":\"string\",\"description\":\"Status of the user data rights request.\"},\"dataResponse\":{\"type\":\"string\",\"description\":\"Escaped JSON containing information about the status of data deletion on each VTEX system that stores client data.\"},\"requestTime\":{\"type\":\"string\",\"description\":\"Date of the user data rights request in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html)format.\"},\"applications\":{\"type\":\"array\",\"description\":\"Array containing an object for each VTEX application that stores client data.\",\"items\":{\"type\":\"object\",\"description\":\"Object containing information about user data status in each VTEX application that stores client data.\",\"properties\":{\"application\":{\"type\":\"string\",\"description\":\"Abbreviated name of the application, which can be `chk` (Checkout), `orders` (Order Management System), `profileSystemV2` (PII Profile System) or `vid` (VTEX ID).\"},\"status\":{\"type\":\"string\",\"description\":\"Status of client data in the given application. The possible values are:\\n\\r- `Completed` - Processing completed successfully.\\n\\r- `Error` - An unexpected error occurred during the process. You must make a new request.\\n\\r- `PendingCheck` - Pending validation. Unable to perform validation on one or more services.\\n\\r- `Blocked` - Pending validation. One or more services are unable to fulfill the deletion request. You need to wait and make a new request in the future.\\n\\r- `PendingDeletion` - It was not possible to delete data in one or more services. You must make a new request.\"},\"errorDetail\":{\"type\":\"string\",\"description\":\"In case of error, this field contains an explanatory error message. Otherwise, this field is an empty string.\"},\"updateAt\":{\"type\":\"string\",\"description\":\"Date of the latest update in client data in the given application, in UTC format.\"}}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[POST]::/api/user-rights/createAndProcessDeleteUserData - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n"
]
}
}
],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
}
],
"event": []
}
],
"auth": {
"type": "apikey",
"apikey": [
{
"type": "any",
"value": "X-VTEX-API-AppKey",
"key": "key"
},
{
"type": "any",
"value": "{{apiKey}}",
"key": "value"
},
{
"type": "any",
"value": "header",
"key": "in"
}
]
},
"event": [],
"variable": [
{
"type": "string",
"value": "http://api.vtex.com",
"key": "baseUrl"
}
],
"info": {
"_postman_id": "54f33368-355b-478c-bd36-75b3f2bf90a7",
"name": "Data Subject Rights API",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
"description": {
"content": "According to data protection policies, such as [GDPR and LGPD](https://vtex.com/us-en/privacy-and-agreements/vtex-commitment/), companies using customer personal data are required to delete collected information upon the customer's request. Data Subject Rights API allows stores using the [PII data architecture](https://developers.vtex.com/docs/guides/pii-data-architecture) to erase user data collected by Checkout, Orders, VTEX ID and Profile System, without depending on the VTEX Support flow described in the [Erasing customer data](https://help.vtex.com/en/tutorial/erasing-customer-data--1R9Fn7A06Ifj4R9YD4JTKU) guide.\r\n\r\n>⚠️ This API is currently in closed alpha testing stage, which means that only specific customers can access it now. Do not share this documentation with people outside of your company. If you do not have access yet, please refer to the [Erasing customer data](https://help.vtex.com/en/tutorial/erasing-customer-data--1R9Fn7A06Ifj4R9YD4JTKU) guide instead.\r\n\r\n## Index\r\n\r\n- `POST` [Erase customer data](https://developers.vtex.com/docs/api-reference/user-data-rights-api#post-/api/user-rights/createAndProcessDeleteUserData)",
"type": "text/plain"
}
}
}
2 changes: 1 addition & 1 deletion VTEX - User Data Rights API.json → VTEX - Data Subject Rights.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"openapi": "3.0.0",
"info": {
"title": "Data Subject Rights API",
"description": "According to data protection policies, such as [GDPR and LGPD](https://vtex.com/us-en/privacy-and-agreements/vtex-commitment/), companies using customer personal data are required to delete collected information upon the customer's request. Data Subject Rights API allows stores using the [PII data architecture](https://developers.vtex.com/docs/guides/pii-data-architecture) to erase user data collected by Checkout, Orders, VTEX ID and Profile System, without depending on the VTEX Support flow described in the [Erasing customer data](https://help.vtex.com/en/tutorial/erasing-customer-data--1R9Fn7A06Ifj4R9YD4JTKU) guide.\r\n\r\n>⚠️ This API is currently in closed alpha testing stage, which means that only specific customers can access it now. Do not share this documentation with people outside of your company. If you do not have access yet, please refer to the [Erasing customer data](https://help.vtex.com/en/tutorial/erasing-customer-data--1R9Fn7A06Ifj4R9YD4JTKU) guide instead.\r\n\r\n## Index\r\n\r\n- `POST` [Delete user data](https://developers.vtex.com/docs/api-reference/user-data-rights-api#post-/api/user-rights/createAndProcessDeleteUserData)",
"description": "According to data protection policies, such as [GDPR and LGPD](https://vtex.com/us-en/privacy-and-agreements/vtex-commitment/), companies using customer personal data are required to delete collected information upon the customer's request. Data Subject Rights API allows stores using the [PII data architecture](https://developers.vtex.com/docs/guides/pii-data-architecture) to erase user data collected by Checkout, Orders, VTEX ID and Profile System, without depending on the VTEX Support flow described in the [Erasing customer data](https://help.vtex.com/en/tutorial/erasing-customer-data--1R9Fn7A06Ifj4R9YD4JTKU) guide.\r\n\r\n>⚠️ This API is currently in closed alpha testing stage, which means that only specific customers can access it now. Do not share this documentation with people outside of your company. If you do not have access yet, please refer to the [Erasing customer data](https://help.vtex.com/en/tutorial/erasing-customer-data--1R9Fn7A06Ifj4R9YD4JTKU) guide instead.\r\n\r\n## Index\r\n\r\n- `POST` [Erase customer data](https://developers.vtex.com/docs/api-reference/user-data-rights-api#post-/api/user-rights/createAndProcessDeleteUserData)",
"version": "1.0"
},
"servers": [
Expand Down