Creating a New Apptegy API User:
Navigate to Account Management > Users in Sylogist/Wengage
Create a new user named “Apptegy” and set a password for the account.
Set the password expiration date far in the future to avoid needing to reset it annually.
While you'll set a plain text password, Apptegy requires the hashed password for our integration.
Retrieving the Hashed Password:
Open the newly created user account, and on the lower half of the screen, go to the Tools tab.
Select Get Password Hash. (Refer to the third screenshot below.)
Assigning User Roles:
The Apptegy API user will need the following roles, which can be assigned under the Roles tab while editing the user account:
DemographicsReader
AttendanceReader
Account/PayStatusReader
NotificationService
SIAPIUser
Activity/ScheduleReader
School Year and Building Access:
Under the Sites tab, ensure the Apptegy user has access to all school buildings. Without full access, we will not be able to retrieve data from certain buildings.
Also, verify the user has access to the correct school year.
Retrieving the User Lookup Value:
To retrieve the User Lookup Value, go to the Tools tab while viewing the user (bottom half of the screen).
Select Get User Lookup Value, which will be listed below the Get Password Hash option. This value is necessary for generating the JWT (JSON Web Token) we use to authenticate access to your data.
IMPORTANT: Make sure all required roles and permissions are assigned before generating the User Lookup Value. Any changes to the user will require regenerating this value.