Общее
Этот раздел API содержит пару методов для базовых проверок аутентификационных данных приложения и пользователя:
- вызов /check/api_key — этот endpoint проверяет валидность API-ключа, нужен скорее для теста чем для чего бы то ни было ещё
- вызов /check/user_token — этот endpoint служит для проверка пользовательского токена. Проверяется его валидность, а также срок действия.
/api_key
Описание: служит для проверки API-ключа. Если API-ключ корректный, клиент получает код возврата 200
Полный путь к методу: https://www.s1eep.app/api/check/api_key
Полный путь к методу: https://www.s1eep.app/api/check/api_key
Тип запроса: POST
Требования безопасности: API-ключ
Дополнительные ожидаемые параметры: нет
Дополнительные возвращаемые параметры: нет
Примеры ответов:
{"_code":200,"_msg":"OK","_need_payment":false,"_data":"{}"}
{"_code":500,"_msg":"API token mismatch","_need_payment":false,"_data":"{}"}
/user_token
Описание: проверяет помимо API-ключа также и пользовательский токен. Сообщает о том, валидный ли токен, а также не просрочен ли он.
Полный путь к методу: https://www.s1eep.app/api/check/user_token
Полный путь к методу: https://www.s1eep.app/api/check/user_token
Тип запроса: POST
Требования безопасности: API-ключ + пользовательский токен
Дополнительные ожидаемые параметры: нет
Дополнительные возвращаемые параметры:
- user_token — пользовательский токен (тот же, что был на входе, он при этом продлевается на год вперёд)
- active_subscription — индикатор наличия у пользователя доступа к платному контенту
- user_id — идентификатор пользователя в базе данных (для передачи во внешние системы, к примеру, аналитического трекера Amplitude)
Примеры ответов:
{ "_code": 200, "_msg": "OK", "_need_payment": false, "_data": { "user_token": "GD7jfqt06qk2wrRU4Ppu2SZqqqyeonc66AhZn0xxJQlnhSBGQoB1sUMhIO5AEyGXEqiGlIvQu4GKMH6xv2RHogAzWI7z4mBLWnZFftFrYM7jni7yQU3mIeypDdvZSdme", "active_subscription": false, "user_id": 43 } }
{"_code":401,"_msg":"User token expired","_need_payment":false,"_data":"{}"}