For Practice Engine Users
We only need read-only access to PE for the sandbox. The sandbox does not write back or actually send any emails. It is a safe environment to trial out Apxium.
Go to your Practice Engine site and go to Admin → API Authentication Administrator, or go directly to https://XXXXX.pehosted.com/PE/Admin/APIAuth:
Practice Engine allows other applications to call into its web API's just like any other user. This is done with an AppId and AppKey.
On this page, you can administer and create AppId's and AppKey's which can be used when calling the /API functions. AppId's simply map to a standard user so that all normal security measures still apply.
- Choose a user to map the API Access to.
- Click on “Create New App ID”, Enter the User ID of the chosen user and click Save.
- Please note the App ID, App Key and the hostname of the PE instance and provide these to Apxium.
Creating a user with permission (if required)
The Apxium integration requires the following permissions to work:
- API_Admin
- API_Banking
- API_Billing
- API_Client
- API_Export
- ClientDRS
- ClientSearch
- LodgeHeader
The user that the API key is mapped to must have at least these permissions. If needed, please go to https://XXXX.pehosted.com/PE/Admin/Security (Admin → Task Pad → Security Administration).
Go to Permissions to view which groups have these permissions already or create a new group and assign the permissions if desired.
If necessary, create a new user (Staff Member) to use for the integration or choose an existing user.
Go to the Members tab to assign the user to a group with these permissions if required.