Get Started with System Status API

Everything you need to know to get started with the System Status API.

Get a Visier Account

To use the APIs, you must have a Visier account with a profile that has the API capability. If you don't have an account, contact your administrator. They will create an account for you with permissions that allow you to view data.

Generate your API key and security token

To make an API request, you will need an API key and a security token. For more information about how to get an API key and request a security token, see API Authentication.

Choose your tool

To begin working with the System Status API you will need to choose a tool to make your first request. This can be Postman or whichever method you usually use to make HTTP requests. For more information about using Postman for your first request, see Use Postman to Call Visier APIs.

Make your first request

To test that you have everything set up correctly, we'll create a request to retrieve Visier's current system status using the /v1/admin/system-status endpoint. For a complete list of available endpoints, see "System Status" in API Reference.

The following sample request retrieves Visier's current system status. Replace {vanity_name} with your tenant name. The API key is expected as a header, while the security token is expected as a cookie.

1
2
3
curl -X GET --url 'https://{vanity_name}.api.visier.io/v1/admin/system-status' \
-H 'apikey:{api_key}' \
-H 'Cookie:VisierASIDToken={security_token}'

If everything was set up correctly and the request was successful, you should see a similar response:

1
2
3
{
    "UP"
}

Next steps

To learn more, see the System Status API Reference.