The VIA® Public API is intended for use by customers to provide direct integration services with the VIA® Platform to integrate or extend their processes. To utilize the Public API you must be an administrator of your account and create a Public API key for use with the system.
| Info | ||
|---|---|---|
| ||
This API key is a security token and should not be shared with any unauthorized users of the system as it allows for programmatic control of your VIA® Platform Environment. The use of the API key and the VIA® Public API is governed by the terms of service and your license agreements. YOU are responsible for security the API keys and for the proper use of the keys you create. |
Access the Administration panel in your VIA and click on "API Settings" to access the control system for the API. Granting access to the system can be done simply by clicking the "+ Add API Key" button on the tip right corner of the screen.
Enter a description to describe the purpose or use case for the API key and click the save button to create the key. Once the key is created it will be displayed in the list of approved keys. You can click the clipboard button to copy the assigned API key to your browser clipboard to allow easy pasting of the key into other systems. The key is active immediately upon creation and is available for use. You can delete the key using the trashcan icon to the far right of the key in the list.
Clicking the circular arrows icon (far-most left icon) will "refresh" the key by generating a new key code. Please remember that by refreshing the API key any integrations that were previously using the old assigned key will no longer work.
| Open api | ||
|---|---|---|
| ||
...