API authentication

Before you can request data from VivaCity’s API you will need to ensure you have access to the platform and have a supported means of authentication.

API keys are the only means of authentication. These can be created through the user account settings page provided you have been invited to the VivaCity platform and have a username and password.

Creating API Keys

Create your API key by navigating to the API access section of the user settings page and click Create New Key. After doing this, you will be prompted to enter a name and a description. This is simply for your own reference. Once you have selected a name you will be shown your new key.

Please save the details of the key in a secure location such as a password manager before closing the popup.

Once you have clicked Done the value of the key can no longer be seen but the details of the key will be shown below.

Managing API Keys

You can create multiple API keys. This might be desirable too manage access to multiple applications. You can create another key by repeating the steps detailed above.

Keys can be deleted by clicking the delete button in the relevant row. You must confirm the action before the key is deleted. Once deleted, the you can no longer use this key to authenticate requests.

Using API Keys

Once you have created one or many API keys you can request data by including it in the header when making a request.

Keys should only be used by the user who created them. API keys may be revoked for security reasons if users are believed to have shared them.

An example of how this can be done can be seen below.

x-vivacity-api-key: ENTER_YOUR_API_KEY

There is no need to request an access token using this authentication method. Also note that, API keys do not expire.