Best Practices

Platform Access

If you’re a third-party developer, speak with your client contact to create an admin account for you on the DirectScale Corporate Admin. It has Stage and Live environments. You can access it at {Client_ID] for Live and {Client_ID] for Stage.

Understanding Platform Components

Knowing how DirectScale works is essential to understanding what the API is doing and how to validate what you POST. There are many helpful guides in the Help Center's Get Started section. The essential areas are the following:

Order Creation Process

You’ll need to understand how to create and manage a customer and their orders with the Platform.

Inventory Setup

You’ll need to have at least one priced product set up in the system.

Payment Provider Integration

You’ll need a merchant provider configured. You can use the Test Merchant for easy creation without much validation. Or, you can set up with an actual provider integration.

Warehouse and Logistics Setup

You need to have a store, a warehouse, and a shipping method set up. See Inventory Management.

Testing Flow

When using APIs, you don't want to go all "gung-ho" out the gate. There are certain precautions to take and a particular flow that we recommend following:

  1. Get access to the API Gateway.
  2. Use the documentation to familiarize yourself with all the endpoints.
  3. Use the Try it Now testing tool on the Stage API Gateway site to see how they work.
  4. Log in to Corporate Admin, Web Office, or other applicable DirectScale product and see how the data appears.
  5. Start making requests using Postman.
  6. When you feel confident, grab your Live API Key and start using the endpoints in your code. Refer back to the documentation when you have trouble, or our Customer Care or Consulting teams are always happy to assist.

Can I Call a Custom SQL Query from the Public API Endpoints?

DirectScale does not allow you to run raw SQL queries with the API, as safety/abuse issues could occur. Using the Public API, you have two options:

  1. Use existing Public APIs to get the necessary data.
  2. If the Public API doesn't have what you need, create a custom API that runs custom SQL queries.