Warning: These credentials allow API developers (or platforms such as Sourcewhale, Quil, Hirelogic, Metaview and Carv) to connect their code with your Ezekia firm's data, so they should only be given to trusted individuals.
API user credentials are controlled by your administrators. Credentials can be created with expiry dates, or can be left open-ended. They are assigned a permissions group of your choosing so that you can restrict their access if necessary.
Creating a new API user profile
These are created separately to standard users in the Settings, Integrations page (1), using the API Tokens tab (2). Click Generate New Token (3).
Enter a name (4) that will make it clear what the profile is for - for example, 'Website Integration', 'Sourcewhale', etc.
Select an expiration from the list (5). When a profile expires, the connection will stop working. There is an option to have no expiry on the profile. You will receive reminders when there is a month to go before the expiry, another a week before, and a final reminder on the day the profile expires. To renew credentials, you should create a completely new credentials record.
Enter a username (6). You can use an existing user, in which case, their permissions group will be used, and any changes made by the API code will be recorded as being by made by that profile, or you can enter a new username to be used (which can be anything you choose), and you will be given the opportunity to select a permissions group to be used.
Click 'Generate token' (7). An email will be sent to all administrators, advising them that the new API credentials have been created.
You will be taken to a new panel that will look like this.
Click the Copy icon arrowed and paste the details into a new text document. Send this document to your web developers or third party platform like Sourcewhale, who can use it to connect their API code to your Ezekia firm. You will not get another chance to copy the details after closing this panel.
You can revoke any profile at any time by using the 'Revoke' button on the profile, or the 'Revoke all' button.
Sandbox Environment
API Developers may sometimes want to create and test new code away from the live environment. Contact us to provide a temporary sandbox environment.