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é directly. Campus Café’s this API, software developers can create automated services to send to and retrieve data from Campus Cafe directly and automatically. 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
...
Data Element | Field Name (form question must be mapped to this value) | Max Length | Accepted Values (where applicable, form answers must be sent over as accepted STParm values listed in Campus Cafe) |
---|---|---|---|
Name (first) | firstName | 25 | alpha |
Name (middle) | middleName | alpha | |
Name (last) | lastName | 50 | alpha |
Name (preferred) | preferredName | ||
emailAddress | 60 | ||
Phone Number (mobile) | phoneNumber | 25 | Numbers only, no dashes or parentheses |
Phone Number (home) | homePhoneNumber | 25 | Numbers only, no dashes or parentheses |
Phone Number (work) | workPhoneNumber | 25 | Numbers only, no dashes or parentheses |
Date of Birth | dateOfBirth | 8 | Format YYYYMMDD |
Gender | gender | 1 | Use valid Campus Cafe Parameter Value Admin > STParm > Parameter Code SBSTSX |
In-house Ethnicity | ethnicityCode | ||
IPEDs Hispanic | ipedsHispanic | ||
IPEDs Ethnic | ipedsEthnic | ||
US Citizen | citizenStatus | ||
Citizenship Country | citizenCountry | ||
Visa Type | visa | 1 | Use valid Campus Cafe Parameter Value Admin > STParm > Parameter Code SBGDCD |
Social Security Number | socialSecurityNumber | 9 | Numbers only, no dashes or spaces |
Religion | religion | ||
Resident code | residenceCode | ||
Inquiry Source (marketing source) | inquirySource | 10 | Use Campus Café valid code associated with Source triggers set up in application |
Lead Url | leadUrl | None | See notes in section below. |
Major | majorCode | 10 | Use valid Campus Café Concentration Code from Majors |
Entering Semester | enteringSemester | 6 | Numbers only; Use valid Campus Cafe six-digit semester code Parameter Value Admin > STParm > Parameter Code SMDESC Semesters must also be added to the restapi Campus Cafe inquiry form/application in Adm Portal Configuration. |
Admissions Site | site | 2 | Numbers only; Use valid Campus Cafe Parameter Value Admin > STParm > Parameter Code SBCONO |
Admissions Billing Site | billingSite | 2 | Numbers only; Use valid Campus Cafe Parameter Value Admin > STParm > Parameter Code HOCONO |
Counselor | counselor | 3 | Use Campus Cafe valid code |
Texting Allowed | textAllowed | 1 | Use value Y for texting allowed. If allowed, send null value. |
Veteran Code | veteranCode | 1 | Use valid Campus Cafe Parameter Value Admin > STParm > Parameter Code SBVTCD |
Prior School Graduation Year | priorSchoolGradYear | 4 | Numbers only; Use four-digit year |
Prior School Graduation Month | priorSchoolGradMonth | 2 | Numbers only; Use values 1 to 12 |
Address (street 1) | street1 | 50 | alphanumeric |
Address (street 2) | street2 | 50 | alphanumeric |
Address (street 3) | street3 | 50 | alphanumeric |
Address (city) | city | 25 | alpha |
Address (state) | state | 2 | alpha - abbreviation only |
Address (Zip) | zipCode | 15 | numbers only |
Address (country) | country | 20 | |
Student type | studentMode | Use valid Campus Cafe Parameter Value Admin > STParm > Parameter Code SBMODE | |
Campus Café organization ID | 9 (exact) |
...
<Organization Code>: This is your 3-character school code that precedes "-web" in your Campus Cafe URL, like https://abc***-web.scansoftware.com/cafeweb/tl/login
...
Code Block |
---|
https://<Organization Code>-web.scansoftware.com/cafeweb/openAPI/v1/inquiries?portalConfig=<Portal Form Name>&value=<Application or Inquiry>&token=<OPEN_API_TOKEN value> |
As an example, if the ABC the *** school had an Open API form named "Web Inquiry", with a token of "Bosco" it would look like this:
Code Block |
---|
https://abc***-web.scansoftware.com/cafeweb/openAPI/v1/inquiries?portalConfig=Web%20Inquiry&value=Inquiry&token=Bosco |
leadUrl Field (UTM)
Campus Cafe can import UTM (Urchin Tracking Module) by adding parameters to the URL string that is passed to Campus Café through the API.
...
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.
...
Code Block | ||
---|---|---|
| ||
<form action="https://campusCafeURL/cafeweb/openAPI/v1/inquiries" method="POST"> <input type="hidden" name="portalConfig" value="WebInquiry" /> <input type="hidden" name="value" value="Inquiry" /> <input type="hidden" name="token" value="baseball" /> <input type="hidden" name="leadUrl" value="https://www.myschool.com/thisform?utm_medium=med&utm_source=google&utm_campgn=548&utm_conten=778&utm_term=online%20learning%20in%20social%20studies&gclid=KOFS_34_3423KI"/> <label for="firstName">First Name:</label><input type="text" name="firstName" id="firstName" /><br /> <label for="lastName">Last Name:</label><input type="text" name="lastName" id="lastName" /><br /> <label for="emailAddress">Email Address:</label><input type="text" name="emailAddress" id="emailAddress" /><br /> <label for="phoneNumber">Phone Number:</label><input type="tel" name="phoneNumber" id="phoneNumber" /><br /> <label for="inquirySource">Inquiry Source:</label><input type="text" name="inquirySource" id="inquirySource" /> <br /> <label for="majorCode">Major Code:</label><input type="text" name="majorCode" id="majorCode" /><br /> <label for="enteringSemester">Major>Entering CodeSemester:</label><input type="text" name="enteringSemester" id="enteringSemester"/><br /> <label for="streetAddress1">Street Address 1:</label><input type="text" name="streetAddress1" id="streetAddress1" /> <br /> <label for="streetAddress2">Street Address2:</label><input type="text" name="streetAddress2" id="streetAddress2" /> <br /> <label for="streetAddress3">Street Address3:</label><input type="text" name="streetAddress3" id="streetAddress3" /> <br /> <label for="city">City:</label><input type="text" name="city" id="city" /><br /> <label for="state">State:</label><input type="text" name="state" id="state" /><br /> <label for="zipCode">Zip Code:</label><input type="text" name="zipCode" id="zipCode" /><br /> <label for="country">Country:</label><input type="text" name="country" id="country" /><br /> <input type="submit" value="Submit"/> </form> |
...