API Credentials: Setup Guide for Gopersonal Integration

Gopersonal uses the VTEX Catalog System API to synchronize products. This guide will walk you through the process of creating API credentials with the correct permissions and ensuring you have the required role.

Prerequisites

• Required Role: You must have the Catalog role in your VTEX account to access the Catalog System API.

API Endpoint

The API endpoint used for product synchronization is:

${url}/api/catalog_system/pub/products/search

Creating API Credentials

Follow these steps to create and configure your API credentials:

1. Access VTEX Admin

   • Log in to your VTEX account

   • Navigate to your store's admin panel

2. Generate API Key

   • Go to: Account Settings > Access and permissions > API Access

   • Click "Generate new key"

   • Name your key (e.g., "Gopersonal Catalog API Access")

   • Click "Create key"

3. Set API Permissions

   • In the key creation window, find the "Permissions" section

   • Under "Resources", select "Catalog"

   • For "Types of access", choose "Read"

   • Click "Add permission"

4. Save Your Credentials

   • Copy the AppKey and AppToken displayed

   • Store these credentials securely

   • Click "Close" to finish

Important Security Notes

• Treat your AppKey and AppToken as you would a password

• The AppToken cannot be viewed again after initial creation

• Ensure proper security measures are in place when storing and using these credentials

By following this guide, you'll have the necessary API credentials to integrate Gopersonal with your VTEX catalog. If you encounter any issues or need further assistance, please contact VTEX support or your account manager.