Skip to main content
Liaison

Setting Up the CAS API to Deliver In Progress Applications

Before you can begin working with the CAS API, your programs should be configured, and at least one program must be active. Next, you'll need to request access to the CAS API and establish the CAS API subscription to enable the delivery of application data and documents to Slate. This documentation contains the established subscription configuration that will work with the standard Source Formats.

Once implemented, these instructions will accomplish the following:

  • Delivery of CAS applications to Slate when applicants first select one of your programs.

Note On In Progress Visibility Restrictions

A CAS can allow full, partial, or no view of In Progress applications. The CAS In Progress to Slate Inquiry integration only works if the CAS you're interested in allows you to view In Progress applications. Consult the documentation for your CAS to determine if there are any visibility restrictions on In Progress applications.

Creating a CAS API Subscription

You may use any tool for interacting with HTTPS endpoints to create your subscription. Here are some popular options:

  • cURL: A command-line tool for interacting with HTTPS endpoints available out of the box in most operating systems.
  • Coding languages: Versatile and powerful languages with a variety of tools for interacting with HTTPS endpoints, such as Python, Java, Perl, C#, and JavaScript.
  • Postman: A graphic user interface for interacting with HTTPS endpoints

To create a CAS API subscription:

  1. Select the target environment:
  2. Authenticate:
    • Hit the POST /v1/auth/token endpoint.
      • Send in username and password in the body of the request.
      • Send the API key as a header with key “x-api-key”.
    • The token retrieved must be passed in all subsequent requests as a header with key “Authorization.” Pass this token in addition to your API key. Authorization tokens are valid for 1 hour after generation.
  3. Retrieve identifiers – These will be provided at account creation. These identifiers are used in the URL string parameters.
    • Application Form - Definition: A CAS/cycle combination of interest (e.g. “CSDCAS 20-21”, “BusinessCAS 19-20”.)
    • Organization - Definition: An identifier unique to the institution within a CAS.
  4. Create the subscription.
    • Endpoint to create subscription: POST /v1/applicationForms/:applicationFormId/organizations/:organizationId/subscriptions. This subscription is created at the organization scope, which means that any time an event occurs on any application to any program at your organization, a payload will be delivered to the Slate SFTP by the CAS API. Subscribing at the organization scope means that you can freely add, open, and close CAS programs knowing that the application data and documents will be delivered to Slate.
    • URL string parameters: applicationFormId, organizationId
      • Add the relevant applicationFormId and organizationId values, referring to the values delivered to you upon CAS API account creation.
      • Note that you need to subscribe to each CAS separately. If you are interested in integrating applications from 3 different CAS to Slate, then you will need to create 3 CAS API subscriptions.
    • Submit a CAS API subscription creation request.
      • This subscription delivers application data at the point of program selection: when the applicant first selects one of your institution's programs on the Program Selection page in the CAS Applicant Portal.
      • The associated Slate standard Source Format will create Inquiry records for each In Progress application delivered.

Your request should be as follows. Remember to replace our [SAMPLE TEXT APPEARING IN BRACKETS] with the appropriate values.

POST /v1/applicationForms/[THE TARGET APPLICATIONFORMID >> CAS+CYCLE]/organizations/[THE RELEVANT ORGANIZATIONID FOR YOUR INSTITUTION WITHIN THAT CAS+CYCLE]/subscriptions
Authorization: [A VALID AUTHORIZATION TOKEN RETRIEVED FROM POST /v1/auth/token]
Content-Type: application/json
x-api-key: [YOUR CAS API KEY]
Host: [THE APPROPRIATE CAS API ROOT URL: PRODUCTION – api.liaisonedu.com, PRELAUNCH – api.prelaunch.liaisonedu.com]
{
    "notificationEmailAddress": "[ENTER A MONITORED EMAIL ADDRESS TO RECEIVE NOTIFICATIONS ABOUT YOUR SUBSCRIPTIONS]",
    "subscriptionDetails": [
        {
            "destinationType": "SFTP",
            "event": "application.program.selected",
            "responseLevel": "program",
            "responseType": "fullResponse",
            "responseOptions": "expand=all,contentType=text/csv,columnSeparator=COMMA,csvHeaderTruncationSize=4,csvShortName=question",
            "apiVersion": "v2",
            "sftpDestination": {
                "sftpHost": "ft.technolutions.net",
                "sftpPort": 22,
                "sftpUser": "[ENTER SFTP USERNAME HERE]",
                "sftpPassword": "[ENTER SFTP PASSWORD HERE]",
                "sftpBaseDirectory": "/incoming/liaison/[ENTER CAS NAME HERE]",
                "sftpPathTemplate": "casapi-app-started_<instanceId>_<organizationId>_<programId>_<applicationId>_<casApplicantId>.csv"
            }
        }
        ]
}
  • Was this article helpful?