Skip to content

Commit

Permalink
add vtex guide (#27)
Browse files Browse the repository at this point in the history
  • Loading branch information
julia-rabello authored Sep 3, 2024
1 parent ea8bfd5 commit 7fe5c1b
Show file tree
Hide file tree
Showing 8 changed files with 50 additions and 0 deletions.
1 change: 1 addition & 0 deletions content/docs/introduction/_table.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,4 @@
[Slack Webhook](/docs/tutorials/slack-webhook)|[Sourcegraph](/docs/tutorials/sourcegraph)|[Square](/docs/tutorials/square)|
[Stripe](/docs/tutorials/stripe)|[Sumo Logic](/docs/tutorials/sumologic)|[Tailscale](/docs/tutorials/tailscale)|
[Twilio](/docs/tutorials/twilio)|
[VTEX](/docs/tutorials/vtex)|
49 changes: 49 additions & 0 deletions content/docs/tutorials/vtex.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
---
title: VTEX
---

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

---

## Generate a new VTEX Application Key

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

### Step 2 - Generate a new Application Key
#### 2a. Click `Manage My Keys`
![](/images/vtex/2.png)
#### 2b. Click `Generate New`
![](/images/vtex/3.png)
#### 2c. Provide a `Label`, add roles and click `Generate`
![](/images/vtex/4.gif)
#### 2d. Copy the application token
![](/images/vtex/5.png)

---

## Replace the Leaked VTEX Application Key
Replace the leaked VTEX Application Key with the new one in all impacted applications and services.

---

## Revoke the Leaked VTEX Application Key

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

### Step 2 - Revoke the VTEX Application Key
#### 2a. Click `Manage My Keys`
![](/images/vtex/2.png)
#### 2b. Click `Deactivate`
Click the `Deactivate` menu option in the row corresponding to the Application Key you want to deactivate.
![](/images/vtex/6.png)

---

## Resources
- [VTEX Application Key Documentation](https://help.vtex.com/en/tutorial/application-keys--2iffYzlvvz4BDMr6WGUtet)
- [VTEX Application Key Best Practices](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm)
Binary file added themes/compose/static/images/vtex/1.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added themes/compose/static/images/vtex/2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added themes/compose/static/images/vtex/3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added themes/compose/static/images/vtex/4.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added themes/compose/static/images/vtex/5.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added themes/compose/static/images/vtex/6.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 7fe5c1b

Please sign in to comment.