Fraud Data API Implementation Process

Overview

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

• Integrate with the Fraud Report (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: Engage with CCCTC 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:

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

2. CCCTC provides the college with the API account credentials via secure process.

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

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

5. 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.

CCCTC Provides Postman Collection for the Fraud Data API

To support your fraud report data submissions and queries for your college, two Postman collection files have been created containing all the JS code and environment information you need to automate your requests and workflows. Download and save these two files locally and import once your Postman install is complete. The two files are detailed in the Install & Configure Postman section below.

College Configures New Fraud Report Staging Table

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.

CCCTC Delivers College Adaptor Schema v.4.4 Update

Install & Configure Postman (Optional, but recommended)

To support the use of the Fraud Report API, the CCCTC recommends using a tool such as Postman API client to automatically detects the language of the response, links, and format text inside the body to make inspection easy.

Step 1: Download & Install Postman

• Sign up: Click here to Sign up and start using Postman now for free.

• Download & Install: Follow the instructions to download and install Postman.

Download the latest version of Postman for your platform.

Step 2: Import the Fraud Report Postman Collection

Once installed, Postman is configured to authenticate your access and greatly simplify your to the Fraud Report API submissions and requests. CCCTC will provide two Postman collection files containing all the JS code and environment information needed to automate your requests and workflows to the Fraud Report API.

Postman Collections: Through the Postman API client, requests can be organized into Collections which help organize your requests for reuse so that time isn’t wasted rebuilding everything from scratch. Collections can contain JavaScript code to tie requests together to automate common workflows, and you can use scripting to visualize your API responses as charts and graphs.

1. Download and save the Fraud Report API Collection file attached below to your local Downloads folder.

1. From your

My Workspace page in Postman, import the Fraud Report Postman Collection files.

• Click on the Collections button from the left menu, then click the Import button in the top right of the column.

• Select the Fraud Report Postman Collection file in your Downloads folder and complete the Collection import process.

• Once imported, expand the Fraud Report collection heading to display the three fraud report files included. These files are named:

  • Fraud Report OAuth

  • Fraud Report Submit

  • Fraud Report Query

• Repeat the process to import the GraphQL:Pilot Environment file. This file contains the parameters specific to your account authorization, including the appropriate role(s) and your college MIS code, which identifies the specific fraud report data your college is authorized to access.

• Once imported, click on the Environments icon from the upper right side menu in the workspace and select the appropriate environment (GraphQL:Pilot). The parameters for the GraphQL:Pilot environment will display in the center of your workspace.

Step 3: Configure Account Credentials

1. In the USER row of the CURRENT VALUE column, enter the account username provided by the CCCTC.

2. In the PASSWORD row of the CURRENT VALUE column, enter the account password provided by the CCCTC.

Expand the link below to get your API Access Token via Postman

 Get Your API Access Token Using Postman

Once your account credentials (username and password) have been configured in the appropriate environment, open the Fraud Report OAuth tab and click the Send button.

In the lower half of the workspace see the JSON code displayed adjacent to the “access_token” variable. This token information will automatically fill the BEARER token in the Authorization header for each fraud report API request.