There are two main ways to get Applications into Student CRM:
Automatically via an API between your Student Record System and the Platform
Manually via the Data Importer Tool
โ Please note: An occurrence of Applications (Passive) is locked in to using one method at a time. Talk to your Account Manager if you need to switch.
Using the One-way API
Our API is currently integrated with:
The API is used to send information from your Student Records System (SRS) into Student CRM. Applications and Applicant details are sent into an occurrence of the Applications (Passive) App. Please note that this API cannot be used to retrieve information from the Platform.
Typical use:
You create a script that queries your SRS for students and applications, and this resides on your server. This would typically be new and updated applications, however, you may add extra selection criteria to omit certain applications. Using API credentials supplied by us your script connects to Student CRM so that the results of your query can immediately be sent into Student CRM.
You call this API at a regular frequency. If you use cron you would set up a cron task to call your script every 20 minutes, 1 hour, 24 hours etc, so the latest data is always sent into Student CRM. You choose the frequency - from every 10 minutes to every day.
Take a deeper look at how this works with the Developer Documentation (use your CRM Login details).
To start your API integration, use the Project Guide to lead you through each step of planning and setting up a new API integration.
Using the Importer Tool
The Importer tool is used to manually bring Applications data into the platform via a CSV (comma separated values) file. It uses the same methods as the API to map fields, and match Applicants and courses.
Typical use:
You have Applications data you need to bring onto the Platform and don't have the resources to implement the API, or your API isn't set up yet.
In this situation, you'd download your data from your SRS as a CSV file, convert it to match our schema, and import the data into Applications using the Data Importer Tool.
To get started with this method, check out how the Data Importer works and understand how to format your data into the correct schema.
FAQ
Q. How often can the API update?
A. The maximum update speed of the API is every 10 minutes and the minimum is 24 hours.