Configure API Access

This article overviews the API Access tab of the School Profile within the Transferology® Lab and provides information regarding how to access and set up the Transferology application programming interfaces.

In this article:

Field Descriptions
Student Lead API
PeopleSoft Extractor
Banner Extractor

To begin:

Go to the School Profile menu.
Select School Management.
Select API Access.

Field Descriptions

The following fields appear within the API Access tab. School Administrators have read-only access to this tab unless they have more than one of the Products below, in which case they can update the Product field. School Admins cannot update any other fields.

Field	Description/Instructions
Product	The name of the interface tool: Student Lead API Access (default) PeopleSoft Extractor Banner Extractor
Version	The version of the product.
Status	Turns the API key on/off. Enabled Disabled
Status Mod Date	The last date the Status was updated.
API Key	The alphanumeric string used to access the product. Each API key will be unique.
Key Mod Date	The date the API key was created.
CasUniq	Course Applicability System (CAS) unique ID.
Instidq	The national coding scheme the institution has chosen to identify itself and other institutions. Generally, one of the following: Integrated Postsecondary Education Data System (IPEDS) institution ID number. ATP institution identifier code. American College Testing (ACT) institution identifier code. Federal Interagency Committee on Education (FICE) institution identifier code. College Entrance Examination Examination Board (CEEB) institution identifier code. US Department of Education Office of Postsecondary Education (OPE) institution ID number.
Instid	The unique code within the IDQ coding scheme that identifies the institution. If using the uAchieve transfer articulation tables, this value also identifies institutional courses versus transfer courses.
Instcd	An optional field to identify subsets of the institutional information and encoding.

Student Lead API

The Student Lead API grants access to an endpoint URL that can extract student lead data in JSON format from the Recruit Students page within the Transferology Lab. An API key is needed to make a successful request.

For further information, see Get Students Leads Documentation (a CollegeSource Support Center account is required).

PeopleSoft Extractor

The PeopleSoft Extractor sends equivalency data from a PeopleSoft database to Transferology. An API key is needed to make a successful request.

Contact CollegeSource through the Help button in the Transferology Lab for further information.

Coming Soon....

The Banner Extractor sends equivalency data from a Banner database to Transferology. An API key is needed to make a successful request.

Contact CollegeSource through the Help button in the Transferology Lab for further information.