Общее
Этот раздел API посвящён настройкам учётной записи пользователей (то есть тех, кто хоть раз оплатил подписку):
- вызов /users/anonymous для того, чтобы сохранить запись о незалогиненном пользователе
- вызов /users/show для того, чтобы отобразить данные пользователя в профиле
- вызов /users/set для установки параметров записи пользователя
- вызов /users/add_search_ads_info для сохранения данных о связи с Search Ads
/anonymous
Описание: записывает данные об анонимном пользователе без покупок
Полный путь к методу: https://www.s1eep.app/com/api/users/anonymous
Полный путь к методу: https://www.s1eep.app/com/api/users/anonymous
Тип запроса: POST
Требования безопасности: API-ключ
Дополнительные ожидаемые параметры:
- gender — пол пользователя (1 — male, 2 — female, 3 — other), необязательно
- push_key — ключ доступа к пуш-нотификациям
- locale — локаль пользователя (например, "en")
- version — номер сборки приложения пользователя (например, 35)
- random_string — случайная строчка, генерируемая копией приложения на всю свою жизнь
Дополнительные возвращаемые параметры:
- нет
Пример успешного ответа:
{"_code":200,"_msg":"OK","_need_payment":false,"_data":[]}
Пример ошибки:
{"_code":400,"_msg":"push key","_need_payment":false,"_data":[]}
/show
Описание: возвращает данные о пользователе
Полный путь к методу: https://www.s1eep.app/api/users/show
Полный путь к методу: https://www.s1eep.app/api/users/show
Тип запроса: POST
Требования безопасности: API-ключ + пользовательский токен
Дополнительные ожидаемые параметры:
- нет
Дополнительные возвращаемые параметры:
- id — идентификатор пользователя
- aims — массив целей использования приложения (1 — "sleep better", 2 — "get rid of snoring" и т.д.)
- push_notifications — флаг того, включены или выключены пуш-нотификации у пользователя (true или false)
- push_time — предпочитаемое время отправки пуш-нотификаций в формате H:i
- locale — языковая локаль пользователя, строка
- timezone — часовой пояс пользователя, строка
Пример ответа:
{ "_code": 200, "_msg": "OK", "_need_payment": false, "_data": { "id": 831, "aims": {1, 2, 3}, "push_notifications": true "push_time": "08:00", "locale": "ru", "timezone": "Europe/Lisbon" } }
/set
Описание: устанавливает параметры пользователя
Полный путь к методу: https://www.s1eep.app/api/users/set
Тип запроса: POST
Требования безопасности: API-ключ + пользовательский токен
Дополнительные ожидаемые параметры:
- aims — массив из integer'ов, означающих цели пользователя (1 — "better sleep", 2 — "increase happiness" и т.д.), необязательно
- gender — пол пользователя (1 — male, 2 — female, 3 — other), необязательно
- push_key — ключ для пуш-нотификаций, строка, необязательно
- push_time — время отправки пуш-нотификаций в формате H:i, необязательно
- locale — локаль пользователя, строка, необязательно
- version — используемый номер сборки приложения, integer, необязательно
- birth_year — год рождения пользователя, unsigned integer, больше 1900 и меньше 2100, необязательно
- timezone — часовой пояс пользователя, строка, необязательно
- push_notifications — флаг того, нужно ли отправлять пуш-нотификации пользователю (true или false)
- idfa — идентификатор устройства, строка, необязательно
ad_tracking — идентификатор устройства, boolean, необязательно - random_string — случайная строка для атрибуции к установкам, необязательно
- store_country — трёхсимвольный код валюты пользователя, например RUB, необязательно
Дополнительные возвращаемые параметры:
- нет
Пример успешного ответа:
{ "_code": 200, "_msg": "OK", "_need_payment": false, "_data": "{}" }
Пример ошибки:
{ "_code": 400, "_msg": "Data validation error: The aims field should be an array", "_need_payment": false, "_data": "{}" }
/add_search_ads_info
Описание: сохраняет атрибуцию пользователя к кампании SearchAds
Полный путь к методу: https://www.s1eep.app/api/users/add_search_ads_info
Тип запроса: POST
Требования безопасности: API-ключ + пользовательский токен
Дополнительные ожидаемые параметры:
- iad-conversion-date — дата и время конверсии (обычно — скачивание) по рекламному объявлению, формат Y-m-d H:i:s (например 2017-01-31 23:26:59), необязательно
- iad-keyword — ключевое слово, по которому пользователь увидел объявление, строка, необязательно
- iad-keyword-id, ID ключа, по которому пользователь увидел объявление, строка, необязательно
- iad-country-or-region — страна AppStore, необязательно, необязательно
- iad-creativeset-id — идентификатор набора граифческих материалов, число, необязательно
- iad-conversion-type — тип конверсии, строка, необязательно
- iad-click-date — дата и время клика по рекламному объявлению, формат Y-m-d H:i:s (например 2017-01-31 23:26:59), необязательно
- iad-adgroup-name — название группы объявлений, строка, необязательно
- iad-campaign-id — идентификатор рекламной кампании, число, необязательно
- iad-org-name — название организации, от имени которой запущена реклама, строка, необязательно
- iad-lineitem-id — идентификатор хрен знает чего, число, необязательно
- iad-keyword-matchtype — тип метчинга по ключевому слову, строка, необязательно
- iad-org-id — идентификатор организации, от имени которой запущена реклама, число, необязательно
- iad-lineitem-name — хрен знает чего, строка, необязательно
- iad-attribution — флаг атрибуции, boolean, необязательно
- iad-purchase-date — дата и время покупки, формат Y-m-d H:i:s (например 2017-01-31 23:26:59), необязательно
- iad-campaign-name — название рекламной кампании, строка, необязательно
- iad-adgroup-id — идентификатор группы объявлений, число, необязательно
- iad-creativeset-name — название набора графических материалов, необязательно
Дополнительные возвращаемые параметры:
- нет
Пример успешного ответа:
{ "_code": 200, "_msg": "OK", "_need_payment": false, "_data": "{}" }
Пример ошибки:
{ "_code": 400, "_msg": "Data validation error: The campaign id field is required.", "_need_payment": false, "_data": "{}" }