API Inventory

Some frontend applications need an easy way to list the available APIs in the API Management instance. To do so, a simple API was setup that provides this information.

INFO

Only APIs that have the visible tag attached to them are exposed using this utility!

Accessing the inventory

Use the table below to send your request to the correct API Management instance. You can access the URL with any valid Entra ID access token issued by the Haskoning tenant. There are no checks on audience, claims, etc.

URL	Environment
https://api.equation-acceptance.royalhaskoningdhv.com/inventory	acceptance
https://api.equation.royalhaskoningdhv.com/inventory	production

The response will be as follows:

[
    {
        "name": "WaterFuser API",
        "description": "Api service that to exposes the Haskoning_waterfuser python package. Endpoints in this service provide access to the design functions for the Design Tool Nereda.",
        "path": "waterfuser",
        "contact": {
            "name": "Marijn Drillenburg",
            "url": "",
            "email": "marijn.drillenburg@Haskoning.com"
        }
    }
]

Add your API to the inventory

To make your API available to the inventory API, it needs to have the visible tag assigned to it.

Use the following snippet to add this tag to you API:

# terraform.tfvars
apis = [
  {
    azure_managed_identity_object_id = ["<Managed Identity Object ID>"]
    api_name                         = "your-app-name"
    api_friendly_name                = "Your App Name"
    # ... your API configs
    tags                             = ["visible"]
  },
  # ...add more APIs as needed...
]

Now, apply your configuration.

INFO

Note that the API list is cached for 1 hour, so it may take up to 1 hour for your API to appear.