.. _swagger: OpenAPI docs ============ .. .. raw:: html
Check out current version docs here
- **Visit the Interactive OpenApi specification using the link on top of the page** - You should see an interactive list of endpoints as shown bellow - Don't forget to authorize before trying out requests (details in next section). .. - Similar docs are available for each environment at ``{API_BASE_URL}/docs``. |swagger| Authorization ------------- To authorize your requests inside the interactive docs click the button |authorize button| placed top right. A modal window with available authorizations will pop up. Service (read-only) ################### - **Customer (apiKey)** -- use your ``api_key`` - **Authorization (OAuth2, implicit)** -- skip, used for admin only - **None Authorization (apiKey)** -- type in value ``None`` Admin ##### - **Customer (apiKey)** -- use your ``api_key`` - **Authorization (OAuth2, implicit)** -- use your ``client_id``, ``username`` and ``password`` to login - **None Authorization (apiKey)** -- skip, used for service only .. |authorize button| image:: _static/authorize.png :width: 100 .. |swagger| image:: _static/swagger.png :width: 100%