Activate API Access

Enabling API Access for Users

API access is controlled on a per-user basis in the Venddor platform. Administrators can enable or disable API access for specific user accounts as needed.

Note: API access must be explicitly enabled for each user who needs to interact with the Venddor API.

Step-by-Step Activation Process

Follow these steps to activate API access for a specific user:

  1. Log in to the Venddor admin panel with your administrator credentials
  2. Navigate to Customers → Administrators in the main menu
  3. Select the admin account you want to grant API access to (e.g., admin@example.com)
  4. Switch to the API access tab in the user profile
  5. Check the box labeled Yes, allow this user to use the API
  6. Click Save to apply the changes
Tip: Once API access is enabled, an API key is automatically generated for the user. The user will need both their email address and this API key for authentication when making API calls.

Authentication Requirements

After activation, the user will need the following credentials to authenticate with the API:

{
  "email": "admin@example.com",
  "api_key": "a1b2c3d4e5f6g7h8i9j0..."
}