Using Postman
Postman is a widely used tool for testing web APIs. It allows you to make calls to APIs with no code. You can manually specify inputs, authorisation access keys, and see the responses.
Postman Setup
Get a postman account You can use the PostMan web application found at https://www.postman.com/ to call our API. First sign up for a postman account. The individual account is free and sufficient for using the blockage correction API. You can also install the Postman desktop application from https://www.postman.com/downloads/ if you would prefer. To try the WindFarmer API through postman then:
Import the Open API specification In Postman first select a workspace, then click Import.
Select the WindFarmer open API specification file e.g. WindFarmerAPI_openapi.json
Postman will recognise this specification and create a browser for you to explore each callable end point.
Check API connection in Postman
Get Status
The Get Status end point takes no inputs. Get status can be called even with expired or revoked access tokens to see if the service is running.
Postman process:
- Select Collections on the side bar
- Select Get Status end point.
- Authorization tab
- set type as bearer Token
- paste in your JWT access token key
- Click Send request to confirm you can connect to the API
- The response body confirms you can successfully use the API and the API version.