API and SDK Documentation

Echo360 provides two different public APIs for programmatic access to the system:

The current Capture API is version 3.0. The Capture Device API 3.0.1 Reference Guide is available in PDF form for download and use.

You are strongly encouraged to use the online Swagger Docs for the Echo360 public API, to familiarize yourself with the available calls.  It is fully up to date and provides the model  and schema for each call. See Using Swagger Docs UI for API Calls for more information.

If you prefer to use a static/printable version of the API documentation, we have generated a static version of the Swagger Docs, which you can download locally for your use. You have two options:

In both formats, the tags, paths, and JSON objects in the static file are linked throughout, so you can access the associated information quickly. We hope to develop a cleaner and even easier to navigate version of the static Swagger Docs file at some point in the future.

Echo360 also provides two different public Software Development Kits (SDKs) to assist with using the Echo360 API:

The SDK has complete interface documentation included in the downloadable zip file along  with examples showing how to use every single interface class. The documentation is located in the “Echo360 SDK Documentation” directory of the extracted zip file contents. There is also a quick start readme text file available for download here, as well as located in the top level of the zip file.

The SDK has complete interface documentation included in the downloadable zip file along with examples showing how to use every single interface class. The documentation is located in the “Echo360 SDK Documentation” directory of the extracted zip file contents. There is a link located at the top level of the zip file to launch the documentation. Alternately, you can double-click the index.htm file located in the Echo360 SDK Documentation directory, to launch the .NET SDK help.

The example projects provided for the .NET SDK require Visual Studio 2013 and, for security reasons, .NET 4.5.