API

API

Illiri's API (SAPI) allows you to establish a connection between two or more devices, computers, or websites by playing a short modulated sound that transmits a unique session id. The actual data transfer is carried out via a low-latency exchange server which manages sessions and redispatches messages.

A client application communicates with SAPI by using an instance of the SAPIConnection class that allows you to create a new session, attach to an existing one, confirm a counter-party, transfer data to a counter-party and to detach from a session. The entire API is asynchronous and the corresponding callback methods are invoked when a new event is received from the server.

Your application can use our public servers or you can deploy the server in your own cloud. In order to distinguish the applications between each other, the server requires a unique program id that can be obtained on this page.

Documentation

User Guide
User Guide describing the API, its features, methods, events and workflow.

License
End User license agreement for the API. Please read this agreement prior to downloading the software.

iOS API
Documentation describing classes, constants and meth ods available in the iOS API.

Android API
Documentation describing classes, constants and methods available in the Android API.

Web API
Documentation describing classes, constants and methods available in the WebAPI.

Downloads

iOS
Download sapi.tar.gz and follow the instructions in the User Guide.

Android
Download sapi.tar.gz and follow the instructions in the User Guide.

WebAPI
There is no download required, since this API is implemented as a javascript module. It should be included in your web pages as described in the User Guide. You can view the source code here.

  I have read and accepted the Illiri API license agreement.

Get a Program ID

Each program connecting to the public server requires a unique program id. You can obtain it by filling out a form below and pressing the Submit button.

Name*
Company
Email*
Captcha*

Please enter the text above into Captcha field to verify that you are human. The text is case insensitive.

 

Submit