API (Preferences)

ALTR’s APIs enable you to customize, automate and integrate key parts of the ALTR platform. ALTR exposes multiple APIs for configuration, data management and tokenization. ALTR’s APIs use HTTP Basic Authentication, where the username is an API key name and the password is an API key secret.

For a list of ALTR’s APIs, refer to API .

Use this page to

Learn about each field

Name	Description
Creation Date	Date when the API key was created and the username who created it.
Description	A friendly name for the API key. This field is the same as Key Description.
Key Description	A friendly name for the API key. This field is the same as Description.
Key enabled	If on, the key is active and can be used to authenticate API requests. If off, the key is disabled and cannot be used to authenticate API requests. If you disable a key that is in use, any API requests using that key will fail.
Key Name/Username	Name of the API key and the user name when authenticating the API. Copy this text when authenticating other systems to connect to ALTR. NOTE: The key secret was exposed in the UI when the key was created. If you do not have the key secret, you must create a new key - remember to save the key secret.
Status	Status of the API key. This field is controlled by the Key enabled switch. Options are: Enabled— Key is active and can be used to authenticate API requests. Disabled— Key is disabled and cannot be used to authenticate API requests. If you disable a key that is in use, the API request fails.