(1.1.0) API Introduction

The ICE API is an API built on a URI messaging system used to execute commands in ICE. It exposes functionalities such as Workspace, Session and Layer management.

Connecting

To connect to the ICE API, you will need to establish a local UDP or TCP connection with the server. The server address and port should be provided by your system administrator.

Before you can start sending URI messages to execute commands in ICE, you need to connect to the server by sending a "connect" URI message. This message should include your API key as a query parameter. The API key is a unique identifier that will be provided to you.

connect?apiKey=x

In this example, "x" represents your API key.

Sending a URI Message

The ICE API is built on a URI (Uniform Request Identifier) messaging system. To execute commands in ICE you will send URI messages.

A URI message is subdivided into

• path (divided by /)

• queries (starting with ? and comprised of a key & value pair, divided by +)

For example

layer/setScale?id=x+xy=n+x=n+y=n

path - layer/setScale

queries - id=x , xy=n , x=n , y=n

The data identifier shows the expected data type i.e., how ICE will interpret the data

x - string

n - number