Versions Compared

Key

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

...

Fraud Data API Operations


(blue star)

...

Reminder: Non-technical users have the option to use Postman for running each of the

...

operations

...

below

...

.

Getting the API Access Token

Panel
panelIconId

...

33bfe2b7-860e-4d5a-bd01-ea85976cc352
panelIcon:Postman-Logo:
panelIconText:Postman-Logo:
bgColor#F4F5F7

...

Required: An authorized API account with the appropriate credentials must be established by the CCCTC in order to query and submit fraud reports via API.

Getting the API Access Token

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

A&R Staff: Use Postman to Get Your API TokenNon-technical Users: Click here to Use Postman to Get Your API Token

With your API account created with the proper credentials in place, the request below returns a JSON block including an “access_token” field. This token becomes the Bearer token required in the Authorization head for secured requests to the API. (Note: An API account is configured by the CCCTC during the implementation process.)

...

Panel
panelIconIdatlassian-info
panelIcon:info:
bgColor#FFFFFF

Note: In the example above , the token request is made using cURL , however any preferred API tool can be used, such as Python, PowerShell, Ruby, Java, etc.

...

Use Postman to Get Your API Access Token

(blue star) If you are using Postman to query the Fraud Data API, your account credentials were configured in Postman when you imported with the CCCTC Fraud Report collection and configured with the Fraud Report OAuth file.

...

Panel
bgColor#F4F5F7

(blue star) Required: You must have Postman installed & configured with your API account credentials and authorized MIS code to continue with the steps below. See /wiki/spaces/GLUEPD/pages/2851438610 to get started.

Now that Postman has been installed and configured with your API account credentials and MIS code(s) for the pilot and production environments, the turn-key process for generating and refreshing your access token is as easy as clicking the “Send” button. The access token is generated and automatically stored as the Bearer token in the Authorization head for secured API requests (submitting and querying fraud reports).

Step 1: In your Workspace sidebar, click on the Collections icon and expand the Fraud Report collection.

Step 2: Click on the Fraud Report OAuth file which will open in a tab in your Workbench.

Step 3:

In the example below see the “GraphQL:Pilot” environment is selected (active). Click the Send button to get your access token.

...