Page Comparison

...

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

...

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

...

...

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

Expand
title 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. Image Removed

Panel
panelIconId atlassian-warning panelIcon :warning: bgColor #FFFFFF
NOTE: The access token must be active to successfully authenticate to the API. The access token must be refreshed frequently to maintain authorized access. In Postman, the token must be refreshed every 300 seconds (5 minutes).

Panel
panelIconId 33bfe2b7-860e-4d5a-bd01-ea85976cc352 panelIcon :Postman-Logo: panelIconText :Postman-Logo: bgColor #FFFFFF
Optional Recommended: Use Postman to Submit Fraud Reports via API With 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.