Article sections

    1st step: Creating a role with the needed rights in your VTEX account

    First thing you will need to do in your VTEX integration with Reveal, will be to create a custom role that has the following rights:

    • Product: Catalog
      • all permissions (can be only read)
    • Product: OMS
      • all permissions for OMS (read and write)
    • Product: Master Data
      • all permissions (with read and write)
    • Product: Dynamic Storage
      • all permissions

    More about the VTEX permissions and roles you can find here.

    2nd step: obtaining the access token for your VTEX Integration

    For the manual integration with VTEX to be completed, an access token will be needed, that needs to be communicated with your development team. Follow the next steps to see how you can obtain it:

    First, you will need to go inside your VTEX account, click on your name > Account Settings> Account.
    Then scroll down to security and click on the “Generate access key and secret” button:

    A new page will open. You will need to name your Token Access Key – for example Reveal Key.

    Click on “Generate new secret” button. Again a new page will be opened, displaying the AppToken window with the secret code (automatically generated), that you will need to copy it somewhere safe and easy to remember.

    3rd step: once the Access Token is generated, a new line will appear in the Security section in your VTEX customer’s account. From there, the Access key for the newly created token will be needed as well.

    You will also need to share with us the customer their AccountName and Environment as per the image below:

    An example of how the link would look like:

    4th step: now that you have the firsts set-ups done, you are ready to begin with your manual integration

    Additional details needed?

    Please don’t hesitate to reach out to our amazing customer support team if you need any additional information.

    Was this post helpful?

    Related Articles