Create and Authenticate an API


In order to create and authenticate an API, you must have three (3) things

  • An API Key
  • A Partition
  • A valid username and password with system admin permissions on the site

The API Key and Partition are provided by Support, and the System Admin user will need to be created by the client.

Important Note

  • Be default, the user token created through authentication of username and password remains active for 90 days and must be re-authenticated again after that time.

Why System Admin Permissions?

Since the API will access information from whichever module you want to build the API for, it needs access. When you give an API a System Admin user, you guarantee that it has the highest access level possible. 

I'd Like to Request an Enhancement

2 out of 2 found this helpful


Article Feedback