Fraud Data API Implementation Process

Overview

• Work with the CCCTC Enabling Services team to obtain API account and credentials

• Integrate with the Fraud Data (GraphQL) API

  • Install Postman tool and import event collections (optional, but recommended)

  • Or set up standard templates in preferred API tool (Python, cURL, Powershell, Ruby, Java, etc.)

• Install the Fraud Report staging table and deploy latest version of College Adaptor to receive a live stream of fraud notifications; or use the GraphQL Fraud Report Query to receive a list of fraud notification

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 via secure process.

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

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

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

CCCTC Provides API Account & Credentials to College

The ES engineer will create an API account for the approved user during the implementation process and passes their credentials via secure process such as PrivNote. The credentials passed include the account username and password, configured with the appropriate role(s) and college MIS Code, to ensure the user access is restricted to their college or district.

Integrate with the Bi-directional Fraud Data API

Colleges and districts have options for integrating with the Bi-directional Fraud Data 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, Java, etc.)

Install and Use Postman

See the Using Postman for the Bi-directional Fraud Data API guide for download and installation of Postman.

Or they can simply use Postman and the templates configured for the Bi-directional Fraud Data API provided to educate themselves on the GraphQL language and/or visualize the data structure.

Integrate / Update College Adaptor & Fraud Staging Table

In our current flow of bi-directional fraud reporting, the CCCTC enables a college to submit (via the Bi-directional Fraud Data API) a fraud report and have it broadcast to other colleges (those colleges that the student also applied to). For the colleges that have the College Adaptor installed and the fraud-staging-table config enabled, the fraud report is pushed into that college’s sis staging table.

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

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 a GraphQL API. The CCCTC has provided and configured to the API schema, submitting fraud reports for your college will be greatly simplified. See the API Operations section below for query instructions, screenshots, and helpful tips with the three primary Fraud Report API requests.

See /wiki/spaces/GLUEPD/pages/2851438610 for installation and user instructions.

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

Configure Fraud Report Staging Table for SIS

Update College Adaptor Schema to v.4.4