Get Started with Production Versions API

Everything you need to know to get started with the Production Versions 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.

In addition to an API profile, your API user needs a profile with the following capabilities to use the Production Versions API:

  • Direct Publish

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.

Note: If using Postman to send requests, you can request a security token directly in the tool, see Use Postman to Call Visier APIs.

Choose your tool

To use Visier APIs, you 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 all the available production versions using the /v1alpha/admin/production-versions endpoint. For a complete list of available endpoints, see "Production Versions" in API Reference.

The following sample request retrieves all the production versions in your Visier solution. Replace {vanity_name} with your tenant name. The API key is expected as a header, while the security token is expected as a cookie.

Copy
cURL sample request: Retrieve a list of all production versions
curl GET --url 'https://{vanity_name}.api.visier.io/v1alpha/admin/production-versions' \
-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:

Copy
Sample response
{
    "publishedVersions": [
      {
        "id": "49cf48cd-7637-4153-b4c2-84f76586fed3",
        "name": "Talent acquisition module implementation",
        "description": "Implement a TA module as a SKU that we can offer to customers.",
        "versionNumber": 39
      },
      {
        "id": "37569c5f-aa29-46b6-a6cc-3bd84ddae5de",
        "name": "Map requisition source data",
        "description": "Map source data for requisitions to the corresponding analytic objects.",
        "versionNumber": 38
      }
    ]
}

Next steps

Now that you've successfully authenticated and completed your first API request, you can call more Visier APIs!

To learn more: