SuperGlue Fraud Data Reporting API Implementation Process

SuperGlue Fraud Data Reporting API Implementation Process

Overview

The SuperGlue Fraud Data Reporting API enables colleges to be able to identify potential fraud related to applications. When colleges submit a SuperGlue Fraud Data Report using the Apollo API, SuperGlue will deliver the fraud report objects to the college’s fraud-report staging table.

Decorative

 

Process Overview

 

Get Started With Enabling Services

To get started with the implementation process, an authorized representative from the college or district should engage with the CCCTC Enabling Services (ES) team and schedule an initial overview meeting.

Below is a summary of the steps that will be completed during the implementation overview meeting:

  • CCCTC creates API account for the authorized college user, configured with the appropriate roles, MIS code, and OAuth details.

  • CCCTC provides the college with the API account credentials.

  • CCCTC provides the college with Postman collection files customized with the SuperGlue Fraud Data Reporting API schema and queries (optional).

  • CCCTC provides support for Fraud Report staging table and College Adaptor schema update.

  • CCCTC provides API and schema documentation, integration recommendations, and supporting resources.

 

CCCTC Provides API Account & Credentials to College

The Enabling Services engineer will create an API account for the approved user during the implementation process and provides the credentials. The credentials provided include the account username and password, configured with the appropriate role(s) and college MIS Code(s).

Integrate with the SuperGlue Fraud Data Reporting API

Colleges and districts have options for integrating with the SuperGlue Fraud Data Reporting API, including:

  1. Install and use Postman to interface with the API (optional, but recommended)

  2. Set up standard templates in your preferred API tool (Python, cURL, Powershell, Ruby, Node, Java, etc.)

Install and Use Postman

The CCCTC recommends implementing Postman for use with the SuperGlue Fraud Data Reporting API. Instructions for downloading, installing and configuring Postman are available from your Enabling Services engineer.

Advantages of Using Postman

Using an API client tool, such as Postman, can greatly simplify the fraud reporting and querying processes for users that may not have experience with an API. The CCCTC has created templates based on the API schema that will simplify submitting and querying fraud reports for your college.

Please ask your Enabling Services engineer for a copy of Using Postman with the Fraud Data Reporting API for installation and user instructions.

 

Integrate / Update College Adaptor & Fraud Staging Table

The CCCTC enables a college to submit a fraud report and have it broadcast to other colleges that the student also applied to. For the colleges that have the College Adaptor installed and the appropriate configuration item enabled (within CCCTC systems), the fraud report is pushed into that college’s sis staging table for fraud reports.

For colleges that don't have the College Adaptor installed (or the configuration item is set to disabled), we are unable to share the fraud report with them in this way. Instead, It is expected that the college will use the SuperGlue Fraud Data Reporting API to retrieve the fraud reports associated with their college (by misCode).

By providing direct access to the SuperGlue Fraud Data Reporting API schema, the CCCTC has provided the districts with the ability to create and generate a custom user interface. That interface could, for example, be used to implement a more automated process for dealing with fraud application data in their district.