...
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, Node, 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
...
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.
...
Install and use Postman to interface with theAPI (optional, but recommended)
Set up standard templates in your preferred API tool (Python, CURLcURL, Powershell, Ruby, Node, Java, etc.)
Install and Use Postman
The CCCTC highly recommends implementing Postman for use with the Bi-directional Fraud Data API. Instructions for downloading and installing Postman are available from your Enabling Services Implementation Configuration Engineer (ICE).
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 an API. The CCCTC has created templates based on the API schema that will simplify submitting and querying fraud reports for your college.
...
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 fraud reports.
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).
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. That interface could, 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
...