Versions Compared

Key

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

...

(blue star) The Documentation tab (in the sandbox) enables you to step into the Fraud Data API schema, 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.

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

Using Postman with the Fraud Data API

Postman is an API platform used for developing and using APIs. Postman has built-in support for sending GraphQL queries in the request body, using GraphQL variables, and introspection and importing GraphQL schemas. Postman includes a set of tools - such as the API Client -

The CCCTC recommends using Postman as the preferred API client tool for interacting with the Fraud Data API. 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.” Learn more in the Postman Learning Center.

(blue star) Postman supports working with GraphQL

Panel
bgColor#F4F5F7

Advantages of Using Postman: CCCTC highly recommends using Postman when interacting with the Fraud Data API. The advantages of Links to download and install Postman are provided in the Implementation Process section of this guide. In addition, a custom Postman collection (of files) can be imported containing your college OAuth configuration and ready-to-use fraud report queries.

...

College Implementation Process

...

From Your Postman Workspace…

Step 1: Expand the Fraud Report collection and click on the Fraud Report OAuth file..

Step 2: See the Fraud Report OAuth file open in a tab 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 Bearer required in the Authorization head for secured requests to the API. (Reminder: Your API account is provided by the CCCTC during the implementation process.)

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

...