GetStartedGuide.md
6/3/2021
5 / 12
The API doc is also available directly on the gateway or Internet. It can be accessed at the following URLs:
http://{hostname}/api-docs/interactive/index.html#/
http://api.squid.link/
The interactive documentation will allow you to try out the API calls directly from the browser.
The API can be accessed over HTTP or by connecting to a WebSocket or a raw socket. When using HTTP the
message pattern is request/response. The WebSocket and raw socket wrap the REST API and adds support for
push messages. Messages are pushed when a resource is: added, removed or updated.
The raw socket can be access on port 10000 and only from localhost. The WebSocket and HTTP interface is
available on port 80. The port number can be changed in the configuration file.
