API синхронизации предназначено для "толстого клиента" — т.е. для клиента, который хранит у себя снапшот базы данных (разумеется, не всей базы с сервера, а только необходимые наборы данных).
Предупреждение: В фактических данных, отдаваемых сервером API, могут встречаться лишние недокументированные поля. Использование недокументированных полей недопустимо, т.к. они могут быть удалены в будущем. В то же время, клиент не должен считать ошибкой наличие таковых полей.
API удовлетворяет принципам REST.
Относительные адреса API запросов в данной документации даны относительно Базового адрес API.
В таблице ниже также приведены адреса серверов для хранения файлов пользователей. Файловый сервер используется для устаревшего способа загрузки изображений, и оставлен только для обратной совместимости.
| Сервер ↓ \ Окружение → | Рабочий | Тестовый |
|---|---|---|
| Базовый адрес API | https://app.cubux.net/ |
https://test.cubux.net/ |
| Хранилище файлов пользователей | https://file.cubux.net/ |
https://filetest.cubux.net/ |
Данные в теле запросов и ответов передаются в JSON, если явно не документирован иной формат.
HTTP запросы используют HTTP кеширование, где это допустимо.