...
Once Postman is installed and the two Fraud Report Postman Collection files have been imported and configured with your API account credentials and environment specifications, the process for generating and refreshing your access token is managed on the Fraud Report OAuth tab. Once generated , Postman stores will automatically store the token as the Bearer
in the Authorization
head for all secured API requests.
On From Your Postman Workspace… Step 1: Expand the Fraud Report OAuth tab.Step 1: In your Postman Workspace, collection and click on the Collections icon to expand the Fraud Report collectionOAuth file.. Step 2: Click on See the Fraud Report OAuth file to open the in a tab in on your Workbench. Step 3: Ensure the appropriate environment is selected. In the adjacent example, the “GraphQL:Pilot” environment is selected (active). Step 4: Click the Send button to generate the access token. Access Token The 'access_token” becomes the Each time you refresh your authorization, the new ‘access_token’ is automatically saved to the header for the next API operation you intend to execute. Each token expires in 300 seconds (5 mins). |
...
...
Panel | ||||||
---|---|---|---|---|---|---|
| ||||||
The primary function of the API is to enable colleges to report suspected or identified fraudulent admission applications to the CCCTC which can then be used to identify other instances, notify those colleges, and ultimately prevent the bad actor/individual (CCCID) from committing additional fraud against colleges in the future. |
...
Submitting a Fraud Report Via API
The process for submitting reporting fraud reports to the CCCTC is defined in the Fraud Data API schema as the FraudReportSubmit operation, which is a query mutation is known as the FraudReportSubmit operation. The full schema is documented in the Apollo sandbox.
In GraphQL terms, the components of the operation are quite basic, which the documentation provided in the Apollo sandbox is comprehensive. The FraudReportSubmit query is a mutation type object that requires an Input argument (FraudReportSubmitInput!) where at least one variable input field variable is required must be provided, and a basic structured payload response is provideddefined (FraudReportSubmitPayload). In For the majority of casesfraud report submissions, only the input of the application ID Id (AppID) input is truly needed; however additional input fields can or should may also be added to the operation.
Panel | ||
---|---|---|
| ||
|
The FraudReportSubmit Operation
In the screenshot below, an example of a basic fraud submit FraudReportSubmit operation is built-out in the Apollo sandbox.
In the Operation section, a FraudReportSubmit mutation is built showing the default FraudReportSubmitPayload fields displayed. In the Documentation column, the Input argument - FraudReportSubmitInput - is selected and expanded showing the fields that can be used for the required input. In the Variables table, the “appId” field as been added as the only input variable for this basic operation (currently displaying a null value).
|
...