README.md

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 categorised 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:

• MATTR VII API Collection: This Postman Collection includes API operations and some configuration.
• MATTR VII Tenant Environment: This Postman Environment Variables hold specific values for your MATTR VII tenant.

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 MATTR VII Tenant Environment and the [MATTR VII API Collection](https://github.com/mattrglobal/sample-apps/blob/am/update-postman-readme/postman/mattr-vii.postman_environment.json files you saved earlier.

Step 4: Update environment variables

1. Select the Enviornments button in the My Workspace sidebar.
2. Select the MATTR VII Tenant (Example ENV) environment from your environments list.
3. 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.
4. Select the Save button.

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 a list of DIDs endpoint (You can find it under Tenant configuration > DIDs).
4. Select Send in the top right corner of the request pane.
5. The response should be displayed in the Response pane.

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