REST API and UI Settings
========================

Stamp comes with a fully functional REST API that allows easier integration with external services.
To enable the REST API, you need to set ``stamp.api.enabled`` to true.

You can set the port on which Stamp listens to requests with the ``stamp.api.port`` paramter. If not set, by default it is 4567.

The REST API has preconfigured CORS filter so that it will respond to CORS preflight requests 
(OPTIONS) and will allow access from any server.

Please note that without SSL enabled in Stamp exposing the UI and the REST API to public internet is a security risk.

``stamp.api.enabled``
--------------------

Set to true to enable REST API and UI. **Default:** false

``stamp.api.port``
-----------------

The port for the UI and the REST API. **Default:** 4567

``stamp.rest.api.authentication``
---------------------------------

Set to false if you want to allow talking to the API without any authentication. 
Currently Stamp comes with a session based authentication mechanism that is used 
by the UI's login form and an optionally configurable HTTP Basic authentication that has to be switched on. **Default:** true

``stamp.api.ssl.enabled``
------------------------

Set to true to enable SSL support in Stamp. 
When SSL is enabled, Stamp makes an attempt to find the keystore path and password from the VHost 
configuration in which the application is running. This means that if you have SSL set up in Wowza for streaming,
Stamp should be able to pick up the same configuration automatically. **Default:** false

The logs should show clearly if SSL is used or not:

.. code-block::

  Started Stamp UI on https://localhost:4567 with SSL enabled

or

.. code-block::

  Started Stamp UI on http://localhost:4567 without SSL enabled

``stamp.api.auth.basic``
-----------------------

Enables HTTP Basic authentication on the API. Please note that this is only secure if used in conjuction with SSL. 
 **Default:** false

``stamp.api.auth.basic.user``
----------------------------

This gives you the ability to define a single user that can use the UI or the REST API additionally to the normal Wowza admin users	

``stamp.api.auth.basic.password``
--------------------------------

This gives you the ability to define a single user password that can use the UI or the REST API additionally to the normal Wowza admin users

REST API Endpoints
------------------

The REST API of Stamp is documented using OpenAPI specification using Swagger. You can find the explorable, interactive API documentation 
here: 

http://streamtoolbox.com/swagger-ui/?url=http://streamtoolbox.com/api-docs/stamp.json

You can also find the API on SwaggerHub where you can download generated clients in various languages:

https://app.swaggerhub.com/apis/jantekb/Stamp/2020.04.13

The documentation generated from the above swagger is also available as static document.

.. openapi:: openapi.yaml