| Table of Contents | ||
|---|---|---|
|
About Campus
...
Cafe Open API
Campus Café exposes Cafe has an open application programming interface (API). With this API, software developers can create automated services to send to and retrieve data from Campus Café Cafe directly and automatically. Campus Café’s For example, you may wish to exchange course registration information with your learning management system or send information about those who submit an admissions application in Campus Cafe to your marketing system.
Campus Cafe has built API integrations to send data to many systems such as Canvas, PayPal and MessageMedia. But if we haven’t, you may be able to use our Open API to build a connection.
Campus Cafe’s Open API adheres to REST syntax and semantics using JavaScript Object Notation (JSON) and Hypertext Transfer Protocol (HTTP) actions, such as POST, GET, DELETE, etc.
...
Admissions Portal Configuration Screen Campus Café Cafe accepts inquiry and application data through an Open API. In this documentarticle, an inquiry is defined as a prospective student who has expressed interest in the given school and should be contacted to begin the process of applying. The API relies upon an admissions portal. Although the API does not provide a user interface, it is necessary to configure a portal to set the appropriate major codes available, entering semesters available, and defining required fields.
...
Once the inquiry or application form has been created in admissions portal configuration, set the Custom Control ‘REST_INQ’ to the name of the default inquiry or application form created for use with the Open API.
Navigate Go to Admin > Custom Control
In the Search box enter " REST_INQ"
If control "REST_INQ" 1-1 already exists, click edit and enter the name of the rest API inquiry form exactly as it appears in the portal configuration. Example below is for a form titled restapi_inq.
Click Save
If control "REST_INQ" 1-1 does not exist, Enter REST_INQ in the Prog ID box
In the Seq # box enter 1
In the Context drop down, select Admissions
Click Add
In the Parameter Value 1 box enter the name of the admissions portal
Click Save
...
Below is an example of the URL string. In this case, we are passing utm_medium, utm_source, utm_campaign, utm_content and utm_term
https://www.yourschool.edu/my-utmcodes-ip?utm_medium=cpc&utm_source=google&utm_campaign=1053902585&utm_content=389973371894_c_1t1&utm_term=online%20masters%20in%20social%20entrepreneurship
If a parameter value of leadUrl is passed into the Open API form, Campus Café will look for an included tracking record in Admissions Portal Config with a trigger name of LEADURL. The record must be checked as included and be placed in a tab at a location to be included on the form. The tracking record will be added with a the entire leadUrl value stored in the tracking record’s comment box.
...