Skip to content

README.md

Latest commit

 

History

History
46 lines (31 loc) · 2.58 KB

README.md

File metadata and controls

46 lines (31 loc) · 2.58 KB

MATTR VII Postman Collection

Postman is a collaboration platform for API development. This postman collection provides a simple interface to use MATTR VII API. Its categorized endpoints, sample request body and pre-request scripts make it easier and quicker to interact with your tenant.

Getting started

Step 1: Install Postman

Visit the Postman downloads page to install a desktop client for your system.

Step 2: Download collection and environment files

Save the following files locally:

  • Platform API Collection: This Postman Collection includes API operations and some configuration.
  • Tenant Environment: This file defines variables for your MATTR VII tenant. You will need to update it with your own tenant variables later.

Step 3: Import collection and environment files into Postman

  1. Open Postman.
  2. Select the Import button in the My Workspace area.
  3. Select the local versions of the Tenant Environment and the Platform API Collection files you downloaded in the previous step.

Step 4: Update environment variables

  1. Select the Environments button in the My Workspace sidebar.
  2. Hover over the MATTR VII Tenant name in the environments list and select Set Active (you should see it marked as active).
  3. Select the MATTR VII Tenant environment.
  4. Update the following variables with your tenant details:
    • baseUrl: Replace with your tenant's URL.
    • auth0Base: Replace with your Authentication server URL.
    • tenantClientId: Replace with your Client ID.
    • tenantClientSecret: Replace with your Client Secret.
    • tenantAudience: Replace with your tenant's URL.

If you are unsure of any of these details, please contact us.

Step 5: Try it out

  1. Select the Collections button in the My Workspace sidebar.
  2. Select the MATTR VII API collection.
  3. Select the Retrieve all IACAs endpoint (You can find it under Tenant configuration > Identifiers > IACA).
  4. Select Send in the top right corner of the request pane.
  5. The response should be displayed in the Response pane (If this is a new tenant, the response is likely to be empty).

Copyright © MATTR Limited. Some rights reserved.
“MATTR” is a trademark of MATTR Limited, registered in New Zealand and other countries.