This guide is for users who are interested in working with the API to help with data transfer.
Why Choose the CAS API?
The CAS API allows you to access applications and other data from any CAS. For example, if your institution participates in multiple CASs, you can use the CAS API to access any applications and related applicant files (e.g., transcripts, evaluations, etc.) from each of your CASs. It's also built on the same database that your applicants use to complete and submit their applications. This API is the closest you can get to the original source of applicant data. As applicants enter their information into the Applicant Portal, you can use the CAS API to call this data immediately.
From an integration standpoint, the CAS API endpoints are designed to simplify integration projects by your IT team, as they can more easily code against the API. For example, you can substitute a different ID into the HTTP request to retrieve applications from different CASs. In addition, the CAS API is built on AWS Cloud, which enables the CAS API to adopt new technical and security standards quickly and efficiently. You can be confident that your data is secure and available when you need it.
Lastly, the CAS API has a flexible, role-based security model that can be adapted for both association and institution users.
You can use the CAS API as part of a broader integration project. For example, you can download all applications that have been updated in the last 24 hours and import them into your institution's admissions management platform. Or, you can download all applicants' documents, such as transcripts and recommendations, and archive them in your document management system.
Requesting a CAS API Account
The CAS API currently supports two types of users:
- Association user: this user can view any institution that participates in a CAS and all applicants and applications.
- Organization user: this user can only view the applicants and applications for their specific institution.
To request a CAS API account, contact your Account Manager and provide the following information:
- First name
- Last name
- Email address
- Phone number
Liaison will then create an account for you with a default password, which you can change afterward. Since the password reset email is sent to the email address you provide, Liaison recommends using an email address account that you can check for these emails.
In addition, if your institution has multiple integration projects, then each CAS API account must have a unique email address. Creating separate API accounts for each integration application is a security best practice and is strongly recommended.
Testing the CAS API
You can test the CAS API using one of the following API client tools or sample codes from https://developer.liaisonedu.com. You must have an active CAS API account first before testing.
- Postman is a free, API testing tool; click here to download it. For steps on how to use Postman to generate an identity token and call an API endpoint, refer to Postman's Learning Center.
- cURL is a free, command-line tool for transferring data using various protocols and is available for Windows and Mac OS. To download and learn more about cURL, click here. If you have access to a bash shell, you can also try #curl --help.
We realize data integration can seem overwhelming, so we’re always happy to support you through the process. As you explore your data integration options, take note of the following resources: