Skip to content

Commit 3531ea8

Browse files
update VTEX guide (#36)
* update vtex.md * delete old images * add new images * fix image paths in vtex.md * fix image paths in vtex.md
1 parent 056705f commit 3531ea8

File tree

9 files changed

+26
-24
lines changed

9 files changed

+26
-24
lines changed

content/docs/tutorials/vtex.md

Lines changed: 26 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -2,48 +2,50 @@
22
title: VTEX
33
---
44

5-
*This tutorial provides step-by-step instructions on how to rotate a VTEX Application Key.*
5+
*This tutorial provides step-by-step instructions on how to rotate a VTEX API Key.*
66

77
---
88

9-
## Generate a new VTEX Application Key
9+
## Generate a new VTEX API Key
1010

11-
### Step 1 - Navigate to the Application Key page
12-
Log into your VTEX admin account and navigate to `https://{accountName}.myvtex.com/admin/appkeys`.
11+
### Step 1 - Navigate to the API Keys page
12+
Log into your VTEX admin account and navigate to `https://{accountName}.myvtex.com/admin/api-keys`.
1313
![](/images/vtex/1.gif)
1414

15-
### Step 2 - Generate a new Application Key
16-
#### 2a. Click `Manage My Keys`
15+
### Step 2 - Generate a new API Key
16+
#### 2a. Click `Generate Key`
1717
![](/images/vtex/2.png)
18-
#### 2b. Click `Generate New`
19-
![](/images/vtex/3.png)
20-
#### 2c. Provide a `Label`, add roles and click `Generate`
21-
![](/images/vtex/4.gif)
22-
#### 2d. Copy the application token
23-
![](/images/vtex/5.png)
18+
#### 2b. Provide `Key identification`, add roles and click `Generate`
19+
![](/images/vtex/3.gif)
20+
#### 2c. Copy the token unique access link
21+
![](/images/vtex/4.png)
22+
#### 2d. Navigate to the token unique access link
23+
Go to the link generated in the previous step, in the format `https://share.vtex.com/credentials/{token}`, where `token` is a random identifier generated when the key is created.
24+
#### 2e. Copy the `Key` and the `New token` and store it somewhere safe
2425

2526
---
2627

27-
## Replace the Leaked VTEX Application Key
28-
Replace the leaked VTEX Application Key with the new one in all impacted applications and services.
28+
## Replace the Leaked VTEX API Key
29+
Replace the leaked VTEX API Key with the new one in all impacted applications and services.
2930

3031
---
3132

32-
## Revoke the Leaked VTEX Application Key
33+
## Revoke the Leaked VTEX API Key
3334

34-
### Step 1 - Navigate to the Application Key page
35-
Log into your VTEX admin account and navigate to `https://{accountName}.myvtex.com/admin/appkeys`.
35+
### Step 1 - Navigate to the API Keys page
36+
Log into your VTEX admin account and navigate to `https://{accountName}.myvtex.com/admin/api-keys`.
3637
![](/images/vtex/1.gif)
3738

38-
### Step 2 - Revoke the VTEX Application Key
39-
#### 2a. Click `Manage My Keys`
40-
![](/images/vtex/2.png)
41-
#### 2b. Click `Deactivate`
42-
Click the `Deactivate` menu option in the row corresponding to the Application Key you want to deactivate.
39+
### Step 2 - Revoke the VTEX API Key
40+
#### 2a. Click `Delete Key`
41+
Find the row of the API Key you want to delete and click the ellipsis menu ``, then click the `Delete Key` menu option.
42+
![](/images/vtex/5.png)
43+
#### 2b. Confirm deletion
44+
Check `I understand that this action cannot be undone` and click `Delete` to confirm.
4345
![](/images/vtex/6.png)
4446

4547
---
4648

4749
## Resources
48-
- [VTEX Application Key Documentation](https://help.vtex.com/en/tutorial/application-keys--2iffYzlvvz4BDMr6WGUtet)
49-
- [VTEX Application Key Best Practices](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm)
50+
- [VTEX API Key Documentation](https://help.vtex.com/en/tutorial/api-keys--4bFEmcHXgpNksoePchZyy6)
51+
- [VTEX API Key Best Practices](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm)
-10.7 KB
Loading
229 KB
Loading
685 KB
Loading
-29.9 KB
Binary file not shown.
-1.05 MB
Binary file not shown.
65.6 KB
Loading
-35.6 KB
Loading
-469 Bytes
Loading

0 commit comments

Comments
 (0)