Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Panel
panelIconId1f6a7
panelIcon:construction:
panelIconText🚧
bgColor#FFEBE6

This page was created to contain general notes/documentation for the CAS API and Slate integration that is CAS-agnostic. It is under construction.

...

Note

An Institution Manager (IM) for each CAS must reqest request either a new account or that access be given to an existing account for their CAS. However, the CAS API Account itself can have a different “owner” than the IM. If the owner will be different than the IM, the owner will need to have access to WebAdMIT prelaunch and/or production in order to be given access via the CAS API Account to those environments.

...

Once access for a CAS/organization is added to the account, it will “roll over” each year when the new cycle is added, so this process only needs to happen once per CAS/organization.

Access Timing for access to each cycle’s prelaunch environment and production environment will depend on when it is “opened” as part of the cycle (see Cycle Turnover Process). Typically, the Prelaunch API becomes available when the Configuration Portal opens, and Production API becomes available when applicants can select particular schools.

Sample Tickets

Send to apisupport@liaisonedu.com.

Expand
titleSample text to request a new API account

Subject: Request to create new API account

Hello,

I am writing to request a new API account be created for the following CAS and institution. If possible, I’d like to reqest that the account username be [xxxxx].

Institution Manager name and email address: [xxxxx]

Name of user to receive CAS API access: [xxxxx]

CAS API user phone number: [xxxxx]

CAS API user email address: [xxxxx]

The name of your institution (university/college/school/etc.): [xxxxx]

The CAS, one or many, that you're interested in (e.g. BusinessCAS): [xxxxx]

The CAS admissions cycles you're interested in (e.g., 2020-2021 and 2021-2022): [xxxxx]

The environment: [Prelaunch or Production]

Expand
titleSample text to request CAS/cycle added to existing API account:

Subject: Request adding CAS to existing API account

Hello,

This year we will be setting up a CAS API integration for CASPA for Tufts University (program ID 346115 for 23-24). We have existing API accounts for other integrations so I am writing to request that access to CASPA be granted to the below API accounts.

Prelaunch account username: TuftsUniPre

Production account username: TuftsUni

...

Username

Environment

CAS (Org) and Cycles

TuftsUni

Production

SOPHAS, PTCAS

TuftsUniPre

Prelaunch

PTCAS

TuftsVet

Production

VMCAS

REQUESTED

Prelaunch

VMCAS

CAS/

...

Liaison Service Account Configurations (Slate)

To enable automated delivery of CAS application data through the API, Slate requires each instance to have a “CAS/Liaison Service Account” (functionally a “user”) which is assigned a role that allows SFTP access. This “user” is what holds the permissions, allowed networks, and other security settings to allow the data to be transferred from the CAS environment into the Slate environment via SFTP.

...

View file
name_External_ CAS API Subscriptions - Whitelist New IP Addresses.msg
View file
nameCAS Migration to the Cloud.pdf
View file
name_External_ PTCAS_ PTCAS 23-24 Tufts University Destination Manager started failing 12_13- Case# 00329478- Ref_ Case ID_ _ ref_!00D5006gYH_!5004X01wUFrd_ref _.msg

image-20231221-142721.png

Allowed Networks (Deprecated January 2024)

Below are the IP addresses that are included in the “allowed networks” of existing CAS/Liaison Service accounts for future reference. It is unclear which exactly are used by the Liaison systems, the following list is provided for reference/troubleshooting.

...