Discovering Your shopVOX API Credentials: A Step-by-Step Guide

Tyler MacDonald Updated by Tyler MacDonald

Warning: It is important to engage with a web developer to utilize the API effectively. This document provides enough detail to get you started. For any shopVOX API issues, contact our Support team first. Provide detailed information about the API you are using, your integration goals, error codes, and any other relevant details. Send this information to support@shopvox.com with the subject line "API Issue." Response's are typically within 48-72 hours due to the technical nature of API issues. If necessary, your issue will be escalated to the product team for further assistance.

Understanding and obtaining your API credentials is essential for integrating shopVOX with other applications. API credentials are the keys that allow you to access and interact with your shopVOX data programmatically.

How to Find Your API Credentials

Follow these steps to locate your shopVOX API credentials:

  1. Go to Your User Profile Page
    • Log in to your shopVOX account.
    • Click on your profile icon or navigate to the user profile section.
  2. Scroll Down to Find Your Credentials
    • In your profile page, scroll down until you see the section labeled API Credentials.
  3. Copy/Paste Into Your Custom Code or Postman
    • Copy the AuthToken and AccountID provided.
    • Paste these credentials into your custom code or the appropriate fields in Postman or any other API integration tool.

What Are API Credentials?

API credentials consist of two main components:

  • AuthToken: This is a secret key that grants access to your data programmatically. Think of it as a password that allows your application to communicate with shopVOX securely.
  • AccountID: This is a unique identifier for your shopVOX account. It ensures that your requests are directed to the correct account.

How Are API Credentials Used?

When integrating shopVOX with another application, such as a custom code or a service like Zapier, you will use your API credentials to authenticate and authorize your requests. Here’s a simple example of how to use these credentials with Postman, a popular API testing tool:

Using Postman to Access shopVOX API

  1. Open Postman
    • Download and install Postman if you haven't already.
    • Launch Postman on your computer.
  2. Create a New Request
    • Click on the "New" button and select "Request".
    • Name your request and save it to a collection.
  3. Enter the Request URL
    • In the request URL field, enter the shopVOX API endpoint you want to access. For example:
      https://api.shopvox.com/{account_id}/{endpoint}
    • Replace {account_id} with your actual AccountID.
    • Replace {endpoint} with the specific API command you need, such as orders, customers, or any other supported command.
  4. Set Up Authentication
    • Go to the "Headers" tab in Postman.
    • Add a new header with the key Authorization and the value Bearer your_auth_token.
    • Replace your_auth_token with your actual AuthToken.
  5. Send the Request
    • Click the "Send" button to execute the request.
    • If your credentials are correct, you should see a successful response with the requested data.

Summary

API credentials are crucial for securely accessing and integrating your shopVOX data with other applications. By understanding how to use your AuthToken and AccountID, and knowing where to find them in your user profile, you can seamlessly connect shopVOX to various services and enhance your workflow. For detailed steps, refer to the guide above and make sure to handle your credentials with care to maintain the security of your data. Remember, it's essential to work with a web developer to make the most of the shopVOX API, as the shopVOX help desk does not support API-related inquiries.

How did we do?

shopVOX Go! App

Automation - Scheduled Actions

Contact