Skip to content
DemoFree trial

Interactive API documentation (Swagger)

Browse endpoints and send test requests directly in your browser - authenticated with an API key.

Last updated:

What is Swagger UI?

Swagger UI is the interactive BakePilot API documentation available in your browser. It is generated directly from the API specification, so it always shows the current state: all endpoints, required fields, data types and sample responses. You can also send real requests from it - without writing a single line of code.

  • An always up-to-date list of endpoints and fields - generated from the specification
  • Sample requests and responses for each endpoint
  • Sending test requests straight from the browser
  • Machine-readable OpenAPI specification at https://app.bakepilot.pl/api/v1/openapi

Open the interactive API documentation (Swagger) (opens in a new tab)

Authenticating with an API key in Swagger UI

To send requests, you need to authenticate with an API key generated in Settings. In Swagger UI you do this with the “Authorize” button in the top right corner. You can enter the key in the “bearerAuth” field (Authorization: Bearer header) or in the “apiKeyHeader” field (X-API-Key header) - both work the same way.

  1. In Settings, in the “API keys” section, enter a name and click “Generate”, then copy the key
  2. Open https://app.bakepilot.pl/api/v1/docs and click “Authorize”
  3. Paste the key in the “bearerAuth” (or “apiKeyHeader”) field and confirm
  4. Close the window - from now on every request from the documentation is signed with your key

Tip: Without authentication, requests return error 401. If you see 401 even though you pasted the key, check that you copied all of it and that it has not been revoked in Settings.

Sending test requests

Each endpoint has a “Try it out” button. After clicking it, you fill in the parameters or the request body and click “Execute” - Swagger sends a real request to the API and shows the response (HTTP code, headers and JSON). Remember: these are requests against your organization's real data. GET only reads, but POST really creates a customer, an order or an attachment, and PATCH changes an order.

  • “Try it out”, fill in the parameters, “Execute”
  • You see the full response: HTTP code and JSON
  • GET is safe - it only reads data
  • POST and PATCH create and change real records in your organization

Tip: Start with GET /products or GET /customers to safely check authentication before you test creating orders.

Frequently asked questions

Do requests from Swagger work on real data?

Yes. Swagger sends requests to the same API as your integrations. GET only reads data, but POST and PATCH create and change real records (e.g. an order with the Draft status) that you will see in the app.

Do I need a developer account to open Swagger?

No. The documentation is publicly available at app.bakepilot.pl/api/v1/docs. To send requests you only need an API key generated in Settings.

Related articles