The Registration API allows you to automate the process of registering a school or institution on the Snapplify platform. Instead of completing manual forms, this API streamlines onboarding by enabling seamless integration into your existing systems.
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 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.
Documentation Overview:
Visit the Snapplify Developer Portal: API Documentation.
Requests
A GET request is used to prepopulate the 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 registration API:
| Parameter | Required | Type | Description | Example(s) |
|---|---|---|---|---|
| institution | Yes | <string> | A descriptive name or title of the school or institution. | Snapplify High School |
| customerPersona | Yes | <string> | The persona that best describes the institution. | Pre-school ECD, Primary school, Secondary school, Tertiary institution, K-12, TVET, Corporate, Government, NGO, Bookseller, Publisher, Homeschooling institution |
| userPersona | Yes | <string> | The persona that best describes the user. | Student, Educator, Librarian, IT Administrator, Principal, Management, Governing Body, Financial Manager, Parent, CSR Manager, Manager, Employee, Director, Faculty Member, Other |
| domain | Yes | <string> | The prefix for the domain name that will result in a Snapplify endpoint. For example, if the value is myschool, the result will be myschool.snapplify.com. | snapplifyhighschool |
| country | Yes | <string> | The ISO 3166-1 alpha-2 country code where the institution is located. | ZA |
| phone | Yes | <string> | The contact number for the institution. | +2721 975 7192 |
Endpoints
The following URL accesses the 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? Reach out to developer@snapplify.com.
