| Panel | ||||||
|---|---|---|---|---|---|---|
| ||||||
| Info | ||||||
This document provides an overview of the process for integrating with the Bi-Directional Fraud Data API. |
...
The ES engineer will create an API account for the approved user during the implementation process and passes their credentials via a 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(s).
Integrate with the Bi-directional Fraud Data API
...
Install and use Postman to interface with theAPI (optional, but recommended)
Set up standard templates in your preferred API tool (Python, cURL, Powershell, Ruby, Node, Java, etc.)
Install and Use Postman
The CCCTC recommends implementing Postman for use with the Bi-directional Fraud Data API. Instructions for downloading, installing and installing configuring 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 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 enabledappropriate configuration item enabled (within CCCTC systems), 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 configuration item is set to 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 empowered provided the districts with the ability to create and generate a custom user interface. That interface could, for example, be used to implement a more automated process for dealing with fraud application data in their district.
...