Skip to main content
Liaison

Application Programming Interface (API)

  1. Last updated
  2. Save as PDF

While it's relatively simple to extract applicant data, you may need to import it into another system on your campus. Additionally, you may need to download applicant documents and move them to your institution's document management system. Using our APIs, you can simplify these processes and ensure your institution's data management systems and our application databases "talk" to each other by creating commands to perform specific tasks (i.e., extract this data/document, tell me when it’s ready, give me the file to download). 

By using our APIs, you just "set it and forget it," meaning you'll never have to worry that a download isn’t occurring, or that it was downloaded to the wrong location. With our APIs, it just works. Furthermore, because our APIs can be called on-demand, you decide when you want to run your downloads (e.g., every day, or even every few hours).

To effectively use an API, you'll need to:

  1. Identify what data you need (i.e., what applicants and what application data).
  2. Define where you need to send it.
  3. Determine how often you need to send it.

Generic API Min.png

Select Your API

Liaison knows how important integrations and automation are in making our solutions work on your campus. When deciding which of our APIs to use, we encourage you first to discuss with your admissions and IT teams on how you plan to manage your admissions process and how that may align with your institution's data management systems. This can then help you select which API is best for your institution. Refer to the table below for additional suggestions.

  • If your campus already uses WebAdMIT™ to manage your applicant data from one or more Centralized Application Services (CASs) and you’re interested in learning more about integrating applicant data and documents into your other on-campus CRM/SIS/document management systems, check out our WebAdMIT API!
  • If your campus has not adopted WebAdMIT™ for admissions management but you still need to integrate CAS data and documents into your CRM/SIS/document management systems on campus using technology, take a look at our JSON-based CAS API.
  • If you are a current user of SlideRoom and would like to explore the API toolset available to integrate data into your on-campus systems, review the information on the SlideRoom API site.

 

CAS API

WebAdMIT API

SlideRoom Classic API

Data Available

Applicant-entered CAS data and documents only

CAS data and documents + WebAdMIT data (e.g., decisions, scores, etc.)

SlideRoom data and documents

Usage Considerations

•  If your institution uses one or more Liaison CASs but does not heavily leverage WebAdMIT.

•  If you desire notification of real-time application changes via hooks.

•  If your SIS/CRM supports JSON data imports & notifications.

•  If your institution uses WebAdMIT significantly for application management.

•  If your SIS/CRM works better with batch flat file imports (CSV, fixed-width TXT).

•  If your school uses SlideRoom Classic for application management.

Architectural Style

REST

REST

REST

Response Format

JSON

JSON

JSON, XML

Application Format

JSON

CSV Flat File, PDF

JSON, PDF, CSV, TSV, TXT, TAB, XLSX, ZIP

File Format (application attachments)

PDF

PDF

PDF

Other Export Formats

N/A

Fixed-width TXT or XLS, Batch download ZIP of PDFs

JSON, PDF, CSV, TSV, TXT, TAB, XLSX, ZIP

Security

OAuth + API Key

API Key

OAuth

Payload Compression

GZIP

N/A

N/A

Rate Limiting

1 request/second + 10 request burst

5,000 requests/hour

60 requests/hour

Technical Skill Level Recommended

HTTP client programming experience with JSON

Basic scripting experience (e.g., cURL)

HTTP client programming experience with JSON

 

  1. Back to top
  • Was this article helpful?

Recommended articles

  1. Article type
    Category
  2. Tags
    This page has no tags.