Setting up Postman

In this step-by-step guide we will create a Postman Collection from our OpenAPI specification - and set up authentication.

Our OpenAPI spec is available for download in our API Reference.

What if it changes?

If the OpenAPI spec changes, you will have to change your collection as described in the API Reference, or you will have to go through this guide again.

For demonstration purposes, we are starting with a blank new workspace in Postman

Let's import the OpenApi Spec

Paste the link to our OpenAPI Spec, or upload - if you downloaded it.

https://docs.hubocean.earth/openapi/redoc/openapi.json

Click View Import Settings, there are some things we want to set so that Postman knows how to convert the spec properly.

Set parameter generation to Example

Folder Organization should be set to "Tags" because of how we have categorized the requests.

Make sure always inherit authentication is on, or else it will be hard to set up authorization later.

Now click the arrow to go back to save the settings.

Click import.

Now we have all the requests converted into a Postman Collection.

Let's set up auth. Click the top level of the collection, and then the authorization tab.

Select OAuth 2.0

Then, under Configure New Token, add these variables:

Token name:

ODCAT PROD

Set Grant Type to Implicit.

If you are using the Postman Desktop app, set Callback URL to:

https://oauth.pstmn.io/v1/callback

Set Auth URL to:

https://oceandataplatform.b2clogin.com/oceandataplatform.onmicrosoft.com/b2c_1a_signup_signin_custom/oauth2/v2.0/authorize

Set Client ID to:

87537127-da36-4326-bc54-f120f40c9665

Set Scope to:

https://oceandataplatform.onmicrosoft.com/odcat/API_ACCESS offline_access

The new token configuration should now look like this

And now, very importantly, click save, that way the authentication settings will be used for all the endpoints.

Inheriting Authentication

When we toggled on "Always inherit authentication" while importing the collection, the enpoints will inherit the same authflow as the one above it. So by saving the auth flow in the root object of the collection, it wil proapagate down to all the endpoints.

Scroll all the way down, and click Get New Access Token

A window should pop up and prompt you for your credentials.

After clicking log in, this window should appear.

Now that your token has been created, click Use Token to store it in Postman.

Token has been added, and will be used for requests.

A good endpoint to test is listing all resources in the catalog. Just find it, and click send.

Parameter generation

Since we set Parameter Generation Setting to Example when we imported the OpenAPI spec, the request body here is ready to use. This request example will always work, but most examples need some changes to work with your scenarios.