...
Apollo API documentation & sandbox (see links below)
Raw code examples are provided for each operation
Postman API tool and custom collections configured to the fraud report operations.
...
API Documentation, Tools & Sandbox
One of the benefits of a GraphQL API is its inherent ability to provide cohesive documentation for exposed fields, types, schemas and operations. Users are able to easily explore the data through the description field that provides supplementary notes and supports strings and markdown.
To better understand and visualize the schema and available queries and mutations of the GraphQL-based Fraud Data API, the CCCTC offers colleges a variety of API development, documentation, and testing resources to use and interact with.
Explore & View the API in the Apollo Sandbox
...
The Apollo sandbox supports all GraphQL operation types (
Query,Mutation, andSubscription) and allows you to explore the Fraud Data API schema documentation.
Access & explore the Fraud Data API schema and operations available in each environment.
PILOT: https://apollo-router.pilot.ccctechcenter.org/
PROD: https://apollo-router.ccctechcenter.org/
Access All the Fraud Data API Documentation
One of the benefits of a GraphQL API is its inherent ability to provide cohesive documentation for exposed fields, types, schemas and operations. Users are able to easily explore the data through the description field that provides supplementary notes and supports strings and markdown.
...
The Documentation tab enables you to step into the Fraud Data API schema
...
PILOT: https://apollo-router.pilot.ccctechcenter.org/
PROD: https://apollo-router.ccctechcenter.org/
, beginning at one of its entry points. Click the ⊕ button next to any field in the Documentation tab to add that field to the operation editor, at your current path. By default, the Explorer automatically generates variables for that field's arguments.
Using Postman with the Fraud Data API
...
| Panel | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
Using Postman API Client (Optional, but recommended). To visualize GraphQL queries and simplify the Fraud Report operations CCCTC highly recommends using an API client tool, such as Postman, to interface with the GraphQL API. |
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 for Postman: Click here to Sign up and start using Postman now for free.
...
...
Download & Install Postman
To download:
Visit (https://www.postman.com/downloads/ ) and select for your platform. Postman is available as a native desktop app for Mac (Intel and Apple), Windows (32-bit / 64-bit), and Linux (64-bit) operating systems.
To install Postman:
...
Installing Postman on the desktop
...
...
Import Fraud Report Collections & Configure Postman
Step 2: Import Fraud Report Collections & Configure Postman
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.
...
GraphQL:Pilot Environment: This file contains the parameters specific to your account authorization credentials, the appropriate user role(s) and college MIS code, which identifies the fraud data your college has access to.
...
| panelIconId | 33bfe2b7-860e-4d5a-bd01-ea85976cc352 |
|---|---|
| panelIcon | :Postman-Logo: |
| panelIconText | :Postman-Logo: |
| bgColor | #F4F5F7 |
...
...
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.
...
Expand for steps to import Fraud Report Postman Collection files:
| Expand | ||||
|---|---|---|---|---|
| ||||
My Workspace page in Postman, click on the Collections button from the left menu, then click the Import button in the top right of the column.
Fraud Report Postman Collection file in your Downloads folder (or wherever the files were downloaded to) and complete the Collection import process.
Fraud Report collection heading to display the three fraud report files included. These files are named:
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.
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.  Configure Account Credentials
 |
Click the Fraud Report Postman Collection file below to save to your local Downloads directory.
...