User Agent Missing

Always provide user agent header

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

Summary

The Youmanage Api requires the user-agent header to be provided, to aid in diagnostics and to shut down errant apps.

Most tools such as cUrl will send a default user-agent header but if you are using something else and don't define the header then you will run into this error:

curl -H "User-Agent:" https://api.youmanage.co.uk/status

{
  "Error": {
    "Code": "YM0002",
    "Reference": "https://developer.youmanage.co.uk/api/errors/ym0002",
    "Target": null,
    "Message": "User agent is required",
    "Details": null
  }
}

   

Solution

We recommend using the name of your application or some other unique identifier, to reissue the request.

Reissuing the same request but with the user-agent header supplied gives the following results:

curl -H "User-Agent:AwesomeApp2.0" https://api.youmanage.co.uk/status

{
  "status": "Awesome"
}