Skip to main content

API Key

If you want to connect an external application though the Veeqo API then you will need to generate API credentials in the form of an API key.

NOTE: Before you can access your API key you will need to contact support to have this enabled.

Before You Start

We recommend creating a new user for each API store/app you want to connect. This makes it easier to track application activity.

Best Practices

  • Create a new user and use the Store / App name as the Username. We recommend doing this for activity tracking.

  • An example format for the user's email address could be appname@yourcompany.com

  • DO NOT share your API key. Anyone with the API key has full access to your account.

How to Generate an API key:

  1. Login into your Veeqo account.

  2. Head to Settings.

  3. Click on Users.

  4. Click "Add New User".

  5. Fill in dummy information.

  6. Once you have created the user, head back to the users page.

  7. Click "Edit" next to the user.

  8. Scroll down to the API key section (only visible if you have API keys enabled in your account).

  9. Click "Generate API key". A popup will display the API key. Copy it and save in a secure place (such as a password manager) as it will not be accessible again after you close the popup.

  10. Click "I've copied my key" to finish.

NOTE: Save your API Key somewhere secure, such as a password manager.

We have recently made a change that means that the API key will only be displayed when it is first created to increase security. We recommend you create a new user for each integration that needs an API key and store it securely.

If you lose an API key, you can create a new one. Simply go to the user and click "Regenerate API key". You will need to reset any integrations you have used the API key for up until this point.

This information can also be found in the API Documentation.

NOTE: For information on OAuth, please reach out to Support

Did this answer your question?