Postman

Overview

(as of 2024-10-01)

Postman provide the ability to configure Workspaces which enable interaction with APIs.

The Postman app is not available in the Company Portal; but it has a browser-based interface.

Maximus Canada has a Team in Postman with 7 licenses. Maximus Canada’s secured workspaces are accessible only to the Maximus Canada Team members once they log in (SSO) to Postman.

The Postman Team members are:

• Mark Walle Mark.Walle@maximuscanada.ca
• Daniel Ginter daniel.ginter@maximuscanada.ca
• Matt Green matt.green@maximuscanada.ca
• Allison Baldwin allison.baldwin@maximuscanada.ca
• Matthew Sorensen matthew.sorensen@maximuscanada.ca
• Dianne Gabriel dianne.gabriel@maximuscanada.ca
• Evan Argenal evan.argenal@maximuscanada.ca

Workspace

The Verified-by-Video workspace is housed under and accessible to the Maximus Canada Team at:

• https://maximus-canada.postman.co/workspace/Verify-by-Video~fc9fd3a8-cd05-4e46-a5af-a96dccb3e68c/overview

The workspace provides the ability to easily interact with the Microsoft authorization server and the various MaxConf API Management Service endpoints for the VbV solution.

MaxConf Environments

MaxConf Environment	Deployment Slot	Base URL
Production	Production	https://api.vc.maxconf.ca
Production	Staging	N/A
Test	Test	https://api.test.vc.maxconf.ca
Test	Edge	https://api.test.vc.maxconf.ca/edge

Workspace Environments

The workspace provides several Environments:

• Local
  • Used only by developers when they are locally running the Function App code which backs our managed APIs, and before deploying anything to Azure. Calls the Test Pexip environment.
• Azure Edge
  • Used by developers as the first depoyment slot into which new code gets tested for its ability to be deployed to cloud, and as a pre-Test environment for developer use.
  • The Edge VbV API wraps the Test Pexip environment.
  • Only the BCGov IAS DEV environment accesses edge.
  • No BCSC App environment interacts with the Edge environment API
• Azure Test
  • The Test environment accessed by BCSC pre-Prod apps, as well as by Maximus Canada.
  • The Test VbV API wraps the Test Pexip environment.
  • The BCGov IAS environments interacting with this API are: DEV2, SIT, QA, PREPROD, Test.
  • The BCSC DEV, BCSC QA, and BCSC Test environments interact with this Test environment API.
• Azure Prod
  • The Prod environment wraps the Pexip production environment, and is accessed only by Production IAS and BCSC App environments.

Using the API

The MaxConf VC API is thoroughly documented in the MaxConf Virtual Conferencing API rev4 document shared under the External - Verify by Video Teams Channel, in the Files tab for the Pexip Solution channel; here is the share link to that file:

• https://maximusca.sharepoint.com/:b:/s/External-VerifybyVideo/Ed-e5dNMjfhAkRX34_Ueu6ABpeW3oCuGMUxonTj-3LuMjA?e=n8VGCU

Look under the MaxConf Environments section.

Quick Troubleshooting Tips

• Check the heartbeat endpoint to check that the managed API service is running correctly and can call the FA layer.
• Check the metrics endpoint to confirm if the FAs are able to reach the Pexip management API, and to return some statistics about the running service.
  • You must be authorized with a token to call the metics endpoint.