Web API Overview
============================================

Other than using Hub SDK, developers can access the Hub/Display from anywhere through a RESTful API.

Cloud-Based Web API
^^^^^^^^^^^^^^^^^^^^^^

This API is available on SyncSign Cloud. You may obtain a API Key from your SyncSign account and start integration.

.. image:: ../images/api-invoke-to-cloud.png

See: https://dev.sync-sign.com/webapi

On-Premise Server Web API (Coming Soon)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

This API is available on SyncSign On-Premise Server (SOPS). You may obtain an API Key by sign-in the SOPS. The SOPS's web API is the same as the cloud-based web API.

.. image:: ../images/api-invoke-to-sops.png

Hub-Based Web API
^^^^^^^^^^^^^^^^^^^^^^

This API is provided on the Hub itself. You can visit `http://<Hub's IP Address>/api` to get the API Key. Please note the hub's API is a subset of the cloud-based API.

.. image:: ../images/api-invoke-to-hub.png

Details coming soon.