What We’ll Cover
Warning: As a warning, configuring APIs is an advanced feature. Only an admin with development experience should attempt modifications.
Accessing the DirectScale API Developer Portal
The DirectScale Platform uses APIs to communicate with each part of its platform. These add deeper developments and customizations to give you the power to configure elements to your preferences. The API site helps you understand how the default APIs function, the requirements that must be fulfilled to use them, and allows you to test them so they can be used properly in the DirectScale Platform.
Important: To access the comprehensive API Documentation Portal navigate to: developer.directscale.com
As a guest you are able to see the API documentation by clicking the API tab. The APIs are organized by the different Services within the Platform. Each API document provides information on its functionality and the requirements to properly use it.
Note: Based on system configurations and compensation plan programming, other APIs can be made available. See the video: How to Create Custom APIs for more information.
Requesting Authorization to Your Company API Information
To be authorized to use your company’s specific API information and to fully use the site’s testing features like Try it and your API Subscription Keys, you’ll need to request and receive authorization from Customer Support. To be granted access to the API Documentation Portal in an efficient and protected manner, Customer Support needs specific information.
Important: To contact Customer Support and begin this process, email firstname.lastname@example.org. You can also navigate to the Help Center page or Admin Sites and click the Help Button in the bottom right corner. When the pop-up appears, click the Live Chat button to begin your request. If you are in the Help Center you will need to first type something in the search field and press Enter before the full pop-up with the Live Chat button will appear.
Note: If a Partner or 3rd party developer would like authorization to a company’s API information, it is suggested that the company put in the request on their behalf.
Customer Support will require 6 specific items of information to grant authorization. These are:
The first and last name of the person that will receive access.
The email address of the person that will receive access.
A basic message to begin your request.
Your company’s client ID.
Which Platform Environment to give access to; Live, Stage or both.
If the person making the request is a Partner or 3rd Party developer, Customer Support needs proof that the company has authorized access for this person. This is best done through email. Screenshots of company approval will do, but they must clearly show that it came from the company. This is to maintain compliance.