Skip to content

Swagger / OpenAPI

This API is described using an OpenAPI 3 specification and exposed via Swagger UI for interactive exploration and testing.

Swagger is especially useful to:

  • Browse all endpoints and request/response schemas
  • Try requests directly in the browser (“Try it out”)
  • Copy generated curl commands and request examples
  • Inspect validation rules (required params, min/max, enums, etc.)

Swagger UI (interactive docs)

Open Swagger UI in your browser: https://ua-api-solar-lake-enterprise.azurewebsites.net

Tip: If you get 403 Access denied, it usually means your subscription_key is missing/invalid. Swagger does not automatically attach your key to every request—you must provide it as a query parameter.

How to use Swagger UI with subscription_key

All endpoints require:

  • subscription_key (query parameter, 90 characters)

In Swagger UI:

  1. Expand an endpoint
  2. Click Try it out
  3. Fill in required parameters, including subscription_key
  4. Click Execute

Example parameters (illustrative):

  • subscription_key: YOUR_KEY
  • building_id: 01c02e568d94065d29c7fd9e

OpenAPI JSON (machine-readable spec)

The OpenAPI document is what Swagger UI renders.

Depending on deployment configuration, it is usually available at:

https://ua-api-solar-lake-enterprise.azurewebsites.net/openapi.json

If that URL is not exposed in your environment, you can still use the OpenAPI JSON that ships with this MkDocs project (the openapi.json you included alongside the docs build).

Typical uses of the OpenAPI JSON:

  • Generate clients (TypeScript, Python, Java, …)
  • Import into Postman / Insomnia
  • Validate requests/responses in tests
  • Create mocks or contract tests

Troubleshooting

  • 403 Access denied
    Your subscription_key is missing/invalid. Add it to the endpoint parameters.

  • 422 Validation Error
    One of the parameters/body fields does not match the required schema (wrong type, missing required field, out-of-range value, etc.).
    Swagger UI shows the exact schema and highlights required inputs.

  • CORS / browser issues
    Swagger UI calls the API directly from the browser. If you are building your own frontend and hit CORS errors contact Urban Analytica support.