API
What is WMS API?
The WMS API functionality is a simple way of allowing processes to transfer data to external systems that processes wouldn't otherwise be able to interact with. To put it another way, WMS - API allows systems outside of WMS to communicate with WMS processes.
There are 2 primary ways of talking to other systems; an API can go to the external system and ask for data to put into a process or it can wait for the external system to provide data to the process.
API's are WMS's way of communicating with the outside world however, external systems may refer to this functionality as webhooks so if you have used webhooks then you will have a good understanding of what and how API's work.
This API Key is used for authentication when using the API URLs
You can create a new API key for the process by clicking selecting a process design, in the right hand side bar selecting API which will open a page where you can generate an API key for the process. Please note that the API section in the right hand side is restricted via a user license.
Click the button at the top of the page to create an API key, in here you can give the API Key a name and a date for when it will expire (by default the expiration date will be set to a year from the date you are creating the key.
Once you click generate a pop up will appear stating this is your bearer token, save this as once you close the dialog box, the key is no longer visible to the user in the platform.
To view or edit the API key set up you can click on the API key in the grid when generated. You can update the name and expiry date of the API Key.
To delete (revoke) an existing API Key click button in the grid, a pop up will load confirming revoking the API Key, check the box to understand this cannot be undone and click Revoke