UCAS Undergraduate applications (one-way)
The API is used to send information from your Student Records System (SRS) into Student CRM. Students and their applications can be sent into an occurrence of the Applications (Passive) App. Please note that this API cannot be used to retrieve information from Student CRM.
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 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.
International, Postgraduate and Direct applications (two-way)
The API helps your Student Record System (SRS) and Student CRM to stay in sync when processing Active Applications created online and managed inside Student CRM in the Applications (Active) App.
The API is used to both get information from Student CRM into your SRS, and to send information from your SRS into Student CRM.
You need to get information from Student CRM into your SRS because you want to create any new or updated applications in Student CRM, in your SRS.
You need to send information from your SRS into Student CRM, because you want to update the applications in Student CRM, with your SRS Student IDs.
Typical use: you create a script that calls this API, and this resides on your server. Using API credentials your script calls 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 your SRS and Student CRM stay in sync. You choose the frequency - from every 10 minutes to every day.
Take a deeper look at how this works with the Developer Documentation.
See more related topics.