Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  1. Install and use Postman to interface with theAPI (optional, but recommended)

  2. Set up standard templates in your preferred API tool (Python, CURL, Powershell, Ruby, Java, etc.)

Install and Use Postman

See the Using The CCCTC highly recommends implementing Postman for use with the Bi-directional Fraud Data API guide . Instructions for download and installation of Postman.

...

downloading and installing Postman can be found here: /wiki/spaces/GLUEPD/pages/2851438610.

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 API. The CCCTC has created templates based on the API schema that will simplify submitting and querying fraud reports for your college.

(blue star) See Using Postman with the Fraud Data API for installation and user instructions.

Integrate / Update College Adaptor & Fraud Staging Table

...

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).

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 API. The CCCTC has provided and configured to the API schema, submitting fraud reports for your college will be greatly simplified. See the API Operations section below for query instructions, screenshots, and helpful tips with the three primary Fraud Report API requests.

(blue star) See /wiki/spaces/GLUEPD/pages/2851438610 for installation and user instructions.

Panel
panelIconId33bfe2b7-860e-4d5a-bd01-ea85976cc352
panelIcon:Postman-Logo:
panelIconText:Postman-Logo:
bgColor#F4F5F7

Recommended: Install & Configure Postman

With Postman installed and configured to the 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.

(lightbulb) 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, for example, that could be used to implement a more automated process for dealing with fraud application data in their district.

...

Update College Adaptor Schema to v.4.4 Panel

panelIconId33bfe2b7-860e-4d5a-bd01-ea85976cc352
panelIcon:Postman-Logo:
panelIconText:Postman-Logo:
bgColor#FFFFFF

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.