This is an old revision of the document!
Blocks APIs
Programmatic interfaces for controlling the appearance or behavior of the Blocks editor or a Display Spot, for communicating with Blocks from custom web applications and for uploading images and other files to a Blocks server.
- URL Query parameters can be used to manipulate the behaviour of both the editor and display spots.
- Javascript APIs for communicating with Blocks from web pages, either used as part of a block (using a Web Block) or running as a separate web page (which may still be hosted on your Blocks server).
- File Upload APIs for uploading files, for example images to Blocks.
- Raw TCP socket API for communicating with Blocks from other control systems or programs capable of accessing TCP sockets.
- Custom API endpoints can be defined by User Scripts using the @resource decorator.
IMPORTANT Externally accessible APIs can be protected using API keys. If so, an apiKey query parameter must be appended to the URL, with the correct value. API keys and their values are defined in Blocks configuration file.