Versions Compared

Old Version 40

changes.mady.by.user Le, Michelle

Saved on

compared with

New Version Current

changes.mady.by.user Le, Michelle

Saved on

Key

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

API keys and tokens can be found here: RDIMS #17999814

API

Swagger (

DEV

)

Swagger (

ACC

)

TRAINING

Swagger (

PROD

)

Info

NAPA API (OAuth)

NAPA-SNAPA API

NAPA-SNAPA API

NAPA-SNAPA API

MTOA

MTAPI DEV

MTAPI ACC

MTAPI

https://tcmarin.atlassian.net/wiki/spaces/MA

Service Inventory

SIAPI DEV

SIAPI ACC

SIAPI

Service Performance

SPAPI DEV

SPAPI ACC

SPAPI (STAPI)

Time Management

TMAPI DEV

TMAPI ACC

TMAPI

How-to Update API Custom Connectors

Expand
titleHow-to update API custom connectors

PowerApps custom connectors only work with Swagger version 2 definitions.

  1. Go to the ACC environment of the API and copy the swagger.json text.

  2. Open the APSD-PAPS repo and find the appropriate JSON file.

    • ~ Custom Connectors > JSON > [API].json

  3. Paste the json from step 1 into the file.

  4. Revert any changes made to the following properties, but update the version in the description if it has changed. The title needs to stay the same as this is used inside the Canvas app code. Host and basePath are set to environment variables so that the connectors don’t need to be updated during each deployment.

    Code Block
    languagejson
      "swagger": "2.0",
  "info": {
    "title": "MTAPI",
    "description": "MTOA Web Service APIs (v3.1.2.479)",
    "version": "v1"
  },
  "host": "@environmentVariables(\"ap_TCExternal_Host\")",
  "basePath": "/@environmentVariables(\"ap_MTAPI_BasePath\")"

  5. Open the Power Apps studio (ap-dev-tcd365 env) and go to the Custom Connectors.

  6. For the connector you want to update, click on ... → Update from OpenAPI file.

...

  1. Image Added

  2. Click Import and select the correct file, then click Continue.

  3. You will be brought to the connector details screen, click Update connector.

Info

The following steps seem to be necessary to get the Canvas app to recognize the updated connector.

  1. Go into the APSD-PAPS Canvas app editor.

Notes

...

PowerApps custom connectors only work with Swagger version 2 definitions.

Use the JSON from ACC when updating the custom connectors in our environments

...

MTAPI JSON - https://wwwappstestext.tc.gc.ca/Saf-Sec-Sur/13/MTAPI/swagger/docs/v1

...

  1. Click on the Data tab -> ... beside the connector you've updated -> Remove.

    Image Added

  2. Click Add data and re-add the custom connector.

  3. Save the canvas app.

Expand
titleHow to update secrets for NAPA API

Sometimes the secrets need to be updated for the NAPA API (e.g. if they expire).

image-20240412-134646.pngImage Added

Redirect URL shown above then needs to be added to the Redirect URIs in the App Reg in Azure if not already there.

image-20240412-134829.pngImage Added

Notes

  • MTAPI has 2 sets of environments: one for internal only & one that can be accessed outside of TC

    • The external one uses Kanga - http://wwwappstestext.tc.gc.ca

    • PowerApps is considered external, thus APSD connects to the Kanga environments

    • The JWT token is different for the 2 environments

...