MBIE Echo API

The MBIE Echo API is a basic service that demonstrates the process for subscribing and calling an API on MBIE's cloud API platform. Unlike most other MBIE APIs you can subscribe without requiring an access agreement and will have your subscription request automatically approved.

The API has six operations for testing connection to the MBIE API platform, using a range of different methods. The API technical definition can be viewed and downloaded here.

Using the API

Follow these steps to call the API:

  1. Login and register your user details as described here.

  2. Once logged in, click on the Subscribe button on the MBIE Echo API Product page.

  3. There are two options for subscription, one using subscription key only for authentication or one using OAuth2 in addition to a subscription key. More information about these options and subscribing to APIs is available here.

  4. Once subscribed you should receive two emails confirming you have successfully subscribed to the production and sandbox API products.

  5. While logged in, go to the My Subscriptions page to get the subscription keys to use with the API production and sandbox environments.

  6. The subscription key is used in the Ocp-Apim-Subscription-Key header of the API requests.

  7. If you have chosen the subscription method that requires additional security in the form of OAuth2 authentication, follow the steps described here to also generate a one-hour expiry JWT bearer token to additionally send with the requests.