Skip to content

chore: Update Postman collection to 12.1.0 #202

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
avner-m merged 1 commit into from
Sep 24, 2025
Merged

chore: Update Postman collection to 12.1.0 #202

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 9 additions & 21 deletions postman/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# 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.
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

Expand All @@ -11,19 +11,19 @@ Visit the Postman [downloads page](https://www.postman.com/downloads/) to instal
### Step 2: Download collection and environment files

Save the following files locally:
- [`Platform API Collection`](./platform-v9.0.0-postman-collection.json): This Postman Collection includes API operations and some configuration.
- [`Tenant Environment`](./mattr-vii.postman_environment.json): This Postman Environment Variables hold specific values for your MATTR VII tenant.
- [`Platform API Collection`](./platform-v12.1.0-postman-collection.json): This Postman Collection includes API operations and some configuration.
- [`Tenant Environment`](./mattr-vii.postman_environment.json): 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_](./mattr-vii.postman_environment.json) and the [_Platform API Collection_](./platform-v9.0.0-postman-collection.json) files you saved earlier.
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 **Enviornments** button in the _My Workspace_ sidebar.
2. Select the _MATTR VII Tenant (Example ENV)_ environment from your environments list.
1. Select the **Environments** button in the _My Workspace_ sidebar.
2. Select the _MATTR VII Tenant_ 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.
Expand All @@ -32,26 +32,14 @@ Save the following files locally:
- `tenantAudience`: Replace with your tenant's URL.
4. Select the `Save` button.

If you are unsure of any of these details, please [contact us](http://mattr.globa/contact-us).
If you are unsure of any of these details, please [contact us](mailto:dev-support@mattr.global).

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

### Management API

To use the Management API collection, repeat steps 2-4 with the following adjustments:

1. In step 2, download the [Management API collection](./management-v1.11.0-postman-collection.json) file.
2. In step 3, import the [Management API collection](./management-v1.11.0-postman-collection.json) file.
3. In step 4, change the following variables:
- `baseUrl`: Replace with `https://manage.mattr.global`.
- `auth0Base`: Replace with `https://auth.manage.mattr.global`.
- `tenantClientId`: Replace with your Client ID for the Management API.
- `tenantClientSecret`: Replace with your Client Secret for the Management API.
5. The response should be displayed in the _Response_ pane (If this is a new tenant, the response is likely to be empty).

<p align="center"><a href="https://mattr.global" target="_blank"><img height="40px" src ="../docs/assets/mattr-logo-tm.svg"></a></p><p align="center">Copyright © MATTR Limited. <a href="./LICENSE">Some rights reserved.</a><br/>“MATTR” is a trademark of MATTR Limited, registered in New Zealand and other countries.</p>
Loading
Loading