Quickstart
This guide will get you all set up and ready to use the High Systems API. We'll cover how to get started using the OpenAPI Specification and how to make your first API request. We'll also look at where to go next to find all the information you need to take full advantage of our powerful REST API.
Before you can make requests to the High Systems API, you will need to grab your API key from your User Profile. You find it under the Token section in your User Profile.
Using the OpenAPI Specification
To take full advantage of the OpenAPI Specification, you can import the document into a program like Postman or Hoppscotch. This will provide you with all the available endpoints with sample requests and their responses.
These programs often have easy ways to export your requests to whatever language you're using.
Choose your client
Before making your first API request, you need to pick which API client you will use. In addition to good ol' cURL HTTP requests, High Systems offers clients for JavaScript.
# cURL is most likely already installed on your machine
curl --version
Making your first API request
After setting up your environment with the OpenAPI Specification document, you are ready to make your first call to the High Systems API. Below, you can see how to send a GET request to the applications endpoint to get a list of all your applications.
curl -G https://instance.highsystems.io/api/rest/v1/applications \
-H "Authorization: Bearer {token}"
What's next?
Great, you're now set up with the OpenAPI Specification and have made your first request to the API. Here are a few links that might be handy as you venture further into the High Systems API: