In this article, we explain the API creation for the Veracross integration with Digistorm Apps.
To get started, create an OAuth Application record using the directions outlined below. Since Digistorm is enrolled as an Integrated Partner, you will want to find Digistorm in the list of Integrated Partners and click "Start Integration". Then, continue with step 4 in the following article:
Once you've created the OAuth Application, you'll need to add the following scopes. If Digistorm adds additional integration features with Veracross, you may need to add more scopes.
SSO (Single Sign On) - sso
List Academics: Enrollments - academics.enrollments:list
List Academics: Student Assignments - academics.student_assignments:list
List Academics: Student Daily Schedules - academics.student_daily_schedules:list
List Academics: Teacher Daily Schedules - academics.teacher_daily_schedules:list
List Directory: Staff/Faculty - directory.staff_faculty:list
List Events: Athletics - events.athletics:list
Read Events: Athletics - events.athletics:read
List Events - events.group_events:list
Read Events - events.group_events:read
Read Parents - parents:read
List Relationships - relationships:list
Read Students - students:read
List Calendars: Student Calendars - calendars.student_calendars:list
List Calendars: Parent Calendars - calendars.parent_calendars:list
List News - news:list
Read News - news:read
Create Student Logistics Request - student_logistics_requests:create
List Student Logistics Request - student_logistics_requests:list
Read Staff/Faculty - staff_faculty:read
List Directory: Student - directory.student:list
List Directory: Household - directory.household:list
We will also need a callback URL set, this will be customer-specific and can be provided by your onboarding contact.
The Client ID and Client Secret will be shared automatically with Digistorm once you submit your details.
Scope Change Log
Date | Scopes | Reason |
23 September 2024 | Reads News - news:read | Allow for more articles to be shown when filtering by channels |
01 July 2024 | Read Staff/Faculty - staff_faculty:read | Better support for faculty users of the app |
24 July 2024 | List Directory: Student - directory.student:list List Directory: Household - directory.household:list | Support for Household directory module |
07 Aug. 2024 | Read Events: Athletics - events.athletics:read | Support private athletic calendar events |