Skip to main content

Overview

To authenticate with ShopWorks, you will need:
  1. Hostname - The API hostname for the ShopWorks API you want to access.
  2. Username - The username for your ShopWorks account
  3. Password - The password for your ShopWorks account
This guide will walk you through finding your ShopWorks credentials.

Prerequisites:

  • You must have a ShopWorks account.
  • API access must be enabled by ShopWorks. Email support@shopworx.com to request it.

Instructions:

Step 1: Find Your Hostname

Your hostname depends on the API you want to access:
  • manageordersapi.com/onsite — connects to https://manageordersapi.com/onsite/signin
  • manageordersapi.com/v1/manageorders — connects to https://manageordersapi.com/v1/manageorders/signin

Step 2: Find Your Credentials

Your ShopWorks credentials are the same username and password you use to log into your ShopWorks account.

Step 3: Enter Your Credentials in the Connect UI

Once you have your Hostname, Username, and Password:
  1. Open the form where you need to authenticate with ShopWorks.
  2. Enter the Hostname, Username, and Password in the corresponding fields.
  3. Submit the form to complete authentication.
You are now connected to ShopWorks.