| Note |
|---|
| Table of Contents |
|---|
...
|
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.
...
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 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.
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
...
| Panel | ||||||
|---|---|---|---|---|---|---|
| ||||||
Next Step (Optional): Install and configure Postman |
...
Install & Configure Postman (Optional, but recommended)
| Panel | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
Using Postman API Client (Optional, but recommended). To visualize GraphQL queries and simplify the Fraud Report operations CCCTC highly recommends using an API client tool, such as Postman, to interface with the GraphQL API. |
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.
...
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
In the USER row of the CURRENT VALUE column, enter the account username provided by the CCCTC.
In the PASSWORD row of the CURRENT VALUE column, enter the account password provided by the CCCTC.
...
| Panel | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
Optional: Use Postman to Submit Fraud Reports via APIWith Postman installed and configured to the Fraud Data API schema, submitting fraud reports for your college will be greatly simplified. See the Fraud Data API Operations section below for query instructions, screenshots, and helpful tips with the three primary Fraud Report API requests. |
...