Getting Started

Getting started with the API

Purple gradient wave Purple wave used to give a visual break between the header and body of the page.

Summary

We're glad to hear you want to integrate with Youmanage!

To get you up and running as quickly as possible, we've detailed the steps you'll need to undertake, in order to make your first request to the API.

 

API Request

The first step to get your setup ready and tested, is to query the status of our API.

The simplest way to check the status, is to send a request using cURL. If you are using a different HTTP client, then ensure that you are also sending a valid User Agent Header in your request, as this is a requirement of the API.

To send a request, open up a command prompt and enter the following:

curl https://localhost:44336/Status

{
  "Status": "Awesome"
}

Assuming all went well, you will receive a similar message to that in the above example and you can move on to the next step, which is to provide authentication to the API.