OpenAPI Integrations

Import the WindBorne API into Postman or Swagger to browse endpoints. Our OpenAPI specification describes each endpoint’s inputs, responses, and authentication in a standard, machine-readable format.

You can use the specification with a variety of tools and platforms that support OpenAPI; this guide provides instructions for two of them: Postman and Swagger.

Get the Specification

JSON URL
YAML URL

Download the same specification as JSON or YAML.

The specification covers all endpoints documented on this site. Webhook delivery schemas describe signed POSTs from WindBorne to your server.


Postman

Postman turns the specification into a collection of requests you can configure and run.

  1. In the Postman desktop app, open your workspace, choose File → Import, and paste either specification URL above.
  2. Choose Postman Collection, open View Import Settings, turn off Enable optional parameters, and import it. If an older version offers Parameter generation, choose Example before importing.
  3. Open the imported collection’s Authorization tab, select Bearer Token, and enter your WindBorne API key without the Bearer prefix.
  4. Check the Params tab and ensure only the inputs you need are enabled, leaving unused parameters unchecked. Otherwise, Postman may send generated values from optional fields, especially dates, that won’t work with the API. Then select Send.

If you see “Types and schemas failed to import” in local/Git mode, import into a regular Postman workspace instead.

See Postman’s import guide for more details.


Swagger

Swagger displays the specification as interactive API documentation.

  1. Download the JSON or YAML file above.
  2. Open Swagger Editor, choose File → Import File, and select the downloaded file.

If you host Swagger UI yourself, load the downloaded file using its configuration options.