Warning: Only an admin with development experience should attempt API modifications.
The API Docs site helps you understand how DirectScale’s 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.
What We’ll Cover
Accessing the Site
- 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 DirectScale Platform.
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.
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 open a request with Customer Care.
You can also navigate to the Help Center page or Admin sites and click the Help button.
If a partner or 3rd party developer would like authorization to a company’s API information, it’s suggested that the company put in the request on their behalf.
To be granted access in an efficient and protected manner, Customer Care needs specific information:
The first and last name of the person receiving access.
The email address of the person receiving access.
A basic message to begin your request.
Your company’s client ID.
Which environment to give access to: Live, Stage, or both.
If the request comes from a partner or 3rd party developer, Customer Care needs proof that the company has authorized access for them. 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 security compliance.