...
Using Postman with the Fraud Data API
CCCTC highly recommends /wiki/spaces/GLUEPD/pages/2851438610. The Postman client - configured with ready-to-use templates provided by the CCCTC - will allow colleges that may not have the immediate resources or technical skills to integrate with the API initially to submit fraud reports and query the fraud database efficiently in order to participate in the fraud data reporting effort.
Links to install Postman, as well as the custom templates for submitting and querying fraud reports and the user authorization credentials are provided to the college during the implementation process. For more information see /wiki/spaces/GLUEPD/pages/2851438610.
| Panel | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
Postman is an API platform designed to “easily explore, debug, and test your complex API requests for HTTP, REST, SOAP, GraphQL, and WebSockets. The Postman client also includes built-in support for authentication protocols like OAuth 1.2/2.0, AWS Signature, Hawk, and more.” The CCCTC recommends using Postman as the preferred API client tool for interacting with the Fraud Data API. Learn more in the Postman Learning Center. |
Advantages of Using Postman
...
.0, AWS Signature, Hawk, and more.” Learn more in the Postman Learning Center. |
...
College Implementation Process
...
Below is an overview of the process:
Work Contact the CCCTC Enabling Services team to obtain your API account and credentials
Integrate with the Fraud Report (GraphQL) API
Install Postman tool and import event collections templates (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 the College Adaptor to receive a live stream of fraud notifications; , or use the GraphQL Fraud Report Query to receive a list of fraud notificationnotifications.
| Panel | ||||||
|---|---|---|---|---|---|---|
| ||||||
Click here for more information about the Fraud Data API Implementation Process. |
...
During the implementation process, one or more user accounts will be created for your college or district by a CCCTC implementation engineer. The account will be configured with the appropriate roles and attributes, and secured to the mis MIS codes authorized for the specific user. Users from multi-college districts may be authorized to submit and query fraud reports for each all or some of the individual colleges in their district. Single college districts will be restricted to their single mis college MIS code.
| Panel | ||||||
|---|---|---|---|---|---|---|
| ||||||
More information is provided to the district during the Fraud Data API Implementation Process overview meeting with CCCTC Enabling Services. |
...
| Panel | ||
|---|---|---|
| ||
We’ve created a developer ‘starter kit’ for making Fraud Data queries. See the Querying Fraud Data Using Postmanin the Using Postman with the Fraud Data API Guide sectionin /wiki/spaces/GLUEPD/pages/2851438610 guide for details. |
Using Postman to Query Fraud DataBack to Top
...
Documentation & Supporting Resources
...
Item | Description | File / Link | ||
|---|---|---|---|---|
Apollo API Sandbox | Fraud Data API Endpoint & Schema Documentation | Pilot: https://apollo-router.pilot.ccctechcenter.org/ | ||
GraphQL API Documentation | (Official) Online Introduction to GraphQL API | |||
About GraphQL | CCCTC-based Introduction to GraphQL API | |||
Postman Documentation | Introduction to Postman / Documentation | https://learning.postman.com/docs/getting-started/introduction/ | ||
Using Postman with the Fraud Data API | CCCTC Guide for Using Postman with the Fraud Data API | Postman Collection Files | Fraud Report Collection:
GraphQL:Pilot Environment Collection |