# SSTI Box API

The box API is deprecated, ise [SSTI Server API](/doc/1cdd965d-2073-4e3e-9cd4-430ae768ab3c) instead.

## SSTI Box API Reference

| Command/Event | Description |     |
|---------------|-------------|-----|
| \### Commands |             |     |
| [SSTI_API_GET_GUESTS](/doc/142bf4e1-5e67-4fd5-9b74-12e41db5a1e2) | Requests the list of tenant's guests and partners from SSTI. |     |
| [SSTI_API_CUSTOM_BUTTON](/doc/00a9b113-2cfc-493a-8d7f-2895870c3e66) | Requests SSTI to set the title of unused menu button (usually marked with "--"). |     |
| \### Events   |             |     |
| [SSTI_EVENT_INITIALIZED](/doc/d0b51e6d-9f5b-4a58-b38e-a236f421a21b) | Event fires when SSTI plugin receives new configuration from server (for example, on group name change). |     |
| [SSTI_EVENT_GUESTS](/doc/8fd9c675-dce4-4f1d-b2cd-ae468ed69bf0) | Fires when SSTI plugin returns the guests/partners list (see SSTI_API_GET_GUESTS command). |     |
| [SSTI_EVENT_CUSTOM_BUTTON](/doc/7f8171a0-b909-48fe-a93d-000b46d6d812) | Fires when tenant presses the custom button (previously set up using SSTI_API_CUSTOM_BUTTON). |     |
| [SSTI_EVENT_NEW_TENANT](/doc/9a708d24-6c5d-4c2e-9197-37af27ee6c4d) | Fires when SSTI discovers a new Hippo box tenant. |     |

## Examples

* The SSTI API testing suite - [here](/doc/0529bddc-aecf-46c2-b082-7607a3bf9334). A rather complex code we use to test SSTI.
* [Adding a custom button to the rent box](/doc/15627443-01f6-468b-a4a2-adcc6a55f284)