Snapplify’s Engage registration API allows you to quickly and easily register an institution, by executing all of the steps for the registration via the API. With Engage, you’ll get access to collaborative, smart, and secure e-learning tools and content.
The API will do the following:
- Register a new Engage instance.
- Prompt the user (which must be the administrator of the institution) to log in or register a Snapplify account.
All institutions using the Engage registration API must be unique. If the institution is not unique it will be altered via a naming convention before registration, by adding a number to the end of the institution’s name.
Requests
A GET request is used to prepopulate the Engage registration forms.
The response to this API call is a HTML page, which will confirm all the details and prompt the user to authenticate and complete the registration.
Request: https://engage.snapplify.com/get-started/register?institution=<string>&customerPersona=<string>&userPersona=<string>&domain=<string>&country=<string>&phone=<string>
Parameters
These are the parameters that implement the Engage registration API:
Parameter: institution
Required: Yes
Type: <string>
Description: A descriptive name or title of the school or institution.
Example: Snapplify High School
Parameter: customerPersona
Required: Yes
Type: <string>
Description: The persona that best describes the institution.
Examples:
- Pre-school ECDPrimary school
- Secondary school
- Tertiary institution
- K-12
- TVET
- Corporate
- Government
- NGO
- Bookseller
- Publisher
- Homeschooling institution
Parameter: userPersona
Required: Yes
Type: <string>
Description: The persona that best describes the user.
Examples:
- Student
- Educator
- Librarian
- IT Administrator
- Principal
- Management
- Governing Body
- Financial Manager
- Parent
- CSR Manager
- Manager
- Employee
- Director
- Faculty Member
- Other
Parameter: domain
Required: Yes
Type: <string>
Description: The prefix for the domain name that will result in a Snapplify endpoint. For example, if the provided value is ‘myschool’, then the result will be ‘myschool.snapplify.com’.
Example: snapplifyhighschool
Parameter: country
Required: Yes
Type: <string>
Description: The ISO 3166-1 alpha-2 country code where the institution is located.
Example: ZA
Parameter: phone
Required: Yes
Type: <string>
Description: The contact number for the institution.
Example: +2721 975 7192
Endpoints
The following URL accesses the Engage registration:
Endpoint: https://engage.snapplify.com/get-started/register
Errors
Errors occurring during the registration process will result in the user being redirected to the normal registration process. Care must be taken to ensure that all required fields are populated.
Need help? Use the live chat in the bottom right corner of your screen or email us at [email protected].
