OpenAPI Documentation for Stratosphere API
Swagger is an OpenAPI toolset that we are utilizing to enhance documentation of the Stratosphere API. Embedded below is the Swagger UI, which presents a list of the Stratosphere API endpoints, parameters, and schemas, and you can also test out each endpoint within this page.
Interested in learning more about the Stratosphere API? Request a Demo, and the Terso Solutions team will schedule a personalized demo for you based on your company's unique challenges and goals.
The OpenAPI documentation includes version information for the API and a link to the API JSON. This JSON is automatically updated when changes are released to production. You can use this JSON for further testing or integrations, such as for creating a Postman Collection.
The documentation includes a list of the available servers. This page points solely to the Stratosphere Production server, so only one server is available in the dropdown.
Utilize Organization Keys created via Stratosphere's Key Management activity to authorize and test the API within this page. Swagger allows you to set authorization for the server or individual commands per API endpoint.
- First, locate the Display Name and Access Key for your Organization Key.
- Scroll down to the Login endpoint below.
- Expand the section and click "Try it out".
- In the Request Body, replace the displayName string with your Organization Key's Display Name, and replace the accessKey string with your Organization Key's Access Key.
- Click Execute.
- Copy the accessToken from the Response Body.
- To authorize for the server:
- Click the Authorize button next to Servers
- Enter your accessToken in the Value field and click Authorize. Clicking "Close" or the X in the top right of the window will cancel the authorization.
- To authorize for an command:
- Click the lock icon for an command.
- Enter your accessToken in the Value field and click Authorize. Clicking "Close" or the X in the top right of the window will cancel the authorization.
- Once you have added authorization, the lock icons will update to the locked position.
- To log out, click the lock icon and click Logout.
Swagger displays each API endpoint and the available commands for each endpoint. Each command can be expanded by click the colorful header to display additional information, including parameter information, an example response value, and schema.
Within the expanded command section, Swagger also gives you the ability to "Try it out". To test out an command:
- Complete the authorization steps above for either the server or the specific command.
- Expand the endpoint and command you'd like to test.
- Click the "Try it out" button.
- Enter values for the parameter(s) you'd like to test, ensuring you've entered values for all required parameters.
- Click Execute.
- The page will update to include the Curl, Request URL, and Server response.
- After executing your first test, you can update the parameters and execute again or clear the values entered.
Loading...
Loading...