Getting Started

This guide will get you all set up and ready to use the Demo API. We'll cover how to get started 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.

Choose your client

Before making your first API request, you need to pick which API client you will use. In the following examples, we will use cURL to make our HTTP requests.

# cURL is most likely already installed on your machine
# run the command below to find out
curl --version

Making your first API request

After picking your preferred client, you are ready to make your first call to the Demo API. Below is an example GET request to check the status of the gateway, followed by a successful response.

GET /hello

curl -G https://demoapidocs.firstrate.com:8443/reports/hello

# {
#    "status": "pass",
#    "version": "1.0",
#    "description": "Core 2.0 Demo API Gateway",
#    "message": "Hello, World!",
#    "timestamp": "2025-05-07T00:25:45.348Z"
# }

What's next?

Great, you're now set up with an API client and have made your first request to the API. Here are a few links that might be handy as you venture further into the Demo API:

• Check out the interactive API Docs where you can try some requests
• Read about Authentication methods to secure your calls
• Learn about the different error messages in our Demo API