Public API Overview

The Public API is a RESTful service that accepts JSON requests. With it, third-party developers can create intuitive integrations and create additional functionality not present in the standard DirectScale Platform. Need to integrate with a logistics provider or eCommerce platform? Or create a custom enrollment experience? Import inventory? You can accomplish all of these and more with the Public API.



Authorization

Authorization to the Public API requires an invitation. Talk with your client contact (or security admin) to work with Customer Care to create an API account for you.

See Authorization for more information.



Environments

The DirectScale Platform has both Live and Stage environments. The Public API has separate keys for these environments.

  • The Live site base API URL is https://dsapi.directscale.com/v1.
  • The Stage site base API URL is https://dsapi-stage.directscale.com/v1.

See Authentication: Getting API Keys.



HTTP Verbs

The endpoints are set up in a customer-centric way with sensibly use of the HTTP verbs.

  • GET - To retrieve
  • POST - To create
  • DELETE - To delete
  • PUT - To update
  • PATCH - To update by named parameter


Call Structure

We've kept the call structure simple. Take the Customers API, for example. It has a call structured with the Customer ID in the URL:

https://dsapi.directscale.com/v1/customers/{customerId}/

You’ll see most of the calls that are based on a particular customer account in the /customers API. You can manage customer-related orders, AutoShips, payment methods, services, stats, service log entries, and reset password in this same way with this URL structure:

https://dsapi.directscale.com/v1/customers/{customerId}/orders or autoships or paymentmethods, etc.

Any call that you've not performed with customer accounts themselves are in more standard groupings:

  • Address /address - Basic address data.
  • Custom Services /custom - An authenticated means of calling your custom-written APIs. Learn how to create custom API in the Client Extension.
  • Office /office - Web Office functions, including “Forgot Password”.
  • Orders /orders - When a call operates on an order ID or related entities (like Autoships), you’ll find it here, with the same HTTP verbs as in Customers where it makes sense.
  • Products /products - All things inventory-related.
  • Single Sign-On /sso - Although a Web Office function, this call is frequently used. Not currently OAuth. Learn more about Single Sign-On (SSO).
  • Validate /validate - Use this to leverage the login functionality, as well as useful form validation functions.

Did this page help you?