Users API

Используйте Users REST Api для работы с учетными запиями. Здесь собраны все самые необходимые методы для удобной работы с пользователями. Пространство имен пользователей содержит, список подписок, подписчиков, понравившиеся записи, проверка пользователя, подробрая информация о пользователе и многое другое.

Вы можете разрешить пользователям редактировать индивидуальное имя пользователя. Для получения дополнительной информации см. Account

Заметки:

В Users API реализованы не все методы для пользовательских настроек. Они появятся в самое ближайшее время.

Вызовите эти методы для связанного пути:

Users (resource group)

Используйте ресурс /users для управления учетными записями.

Информация об учетной записи

GET /users/show

Возвращает информацию о пользователе и по возможности будет выводиться последняя запись автора. Вы должны следовать за защищенным пользователем, чтобы иметь возможность видеть их последние записи. Если вы не следуете за защищенным пользователем, учетная запись пользователя будет удалена.

Успешный запрос возвращает код состояния HTTP 200 OK и тело ответа JSON, которое показывает детали учетной записи.

Параметры

В URI запросе укажите идентификатор учетной записи, для которого будет отображаться подробная информация.
  • id

    integer

     

    ID пользователя.
     

Пример запроса

  curl -v -X GET https://www.steein.ru/api/v2.0/users/show?id=1234 \
-H "Content-Type:application/json" \
-H "Authorization: Bearer Access-Token" 

Результат

Успешный запрос возвращает код состояния HTTP 200 OK и тело ответа JSON, в котором отображаются данные пользователя.

  • id

    integer

    Идентификатор учетной записи.

     
  • created

    string

    Дата и время создания учетной записи.

     
  • description

    string

    Cтрока описывающая учетную запись.

     
  • name

    object

    Объектное представление отдельных компонентов имени и фамилии.

     
  • name.first_name

    string

    Имя, как его определили. Не обязательно должно быть имя человека.

    Максимальная длина: 25 символов

  • name.last_name

    string

    Фамилия, как его создали. Не обязательно должно быть фамилия человека.

    Максимальная длина: 30 символов

  • avatar

    string

    URL-адрес HTTP, указывающий на главную фотографию пользователя.

     
  • username

    string

    Имя пользователя, с которым пользователь идентифицируется. Имена пользователей уникальны, но могут быть изменены.

     
  • link

    string

    URL-адрес учетной записи.

     
  • verified

    integer

    Если возвращает 1, это означает, что пользователь имеет подтвержденную учетную запись.

     
  • kind

    string

    Определяет эту учетную запись как личность.

     
  • displayName

    string

    Имя и фамилия человека, которое подходит для отображения.

     
  • language

    string

    Предпочтительный язык пользователя.

     
  • email

    string

    Возвращает e-mail пользователя. E-mail адреса уникальны, но они могут быть изменены.

     
  • action

    object

    Объектное представление счетчиков.

     
  • action.posts

    integer

    Количество записей, которые пользователь добавил в свою учетную запись.

     
  • action.followers

    integer

    Количество подписчиков в учетной записе. При определенных условиях это поле временно указывает "0".

     
  • action.following

    integer

    Количество подписок в учетной записе. При определенных условиях это поле временно указывает "0".

     

Пример результата

  {
    "email": "support@steein.ru",
    "objectType": "account",
    "kind": "steein#account",
    "username": "shamsudin",
    "displayName": "Шамсудин Сердеров",
    "name": {
        "first_name": "Шамсудин",
        "last_name": "Сердеров"
    },
    "id": 1,
    "description": "Steein - developer",
    "country": "Russia, Moscow",
    "link": "https://www.steein.ru/shamsudin",
    "language": "ru-RU",
    "verified": 1,
    "action": {
        "followers": 5,
        "following": 3,
        "posts": 61
    },

    "avatar": "01041719__2109856473__010724422158dfd2008dc709.03341467.jpg"
}  

 

Проверка на существование пользователя.

GET /users/is

Успешный запрос возвращает код состояния HTTP 200 OK и тело ответа JSON, которое показывает результат работы.

Параметры

  • id

    integer

    required

    Идентификатор пользователя.
     

Пример запроса

  curl -v -X GET https://www.steein.ru/api/v2.0/users/is?id=1234 \
-H "Content-Type:application/json" \
-H "Authorization: Bearer Access-Token" \ 

Результат

Успешный запрос возвращает код состояния HTTP 200 OK и тело ответа JSON.

  • response.user

    integer

    Результат проверки

    • 0 - существует
    • 1 - не существует
     

Пример результата

  {
    "response": {
        "user": 1
    }
} 

 

Список подписчиков

GET /users/followers

Успешный запрос возвращает код состояния HTTP 200 OK и тело ответа JSON, которое выводит список подписчиков пользователя.

Параметры

  • id

    integer

    required

    Идентификатор пользователя.
     
  • count

    integer

    Указывает, какое максимальное число которые следует возвращать, но не более 100. По умолчанию 70.
     
  • page

    integer

    Постраничная навигация, для того, чтобы получить следующую часть
     

Пример запроса

  curl -v -X GET https://www.steein.ru/api/v2.0/users/followers?id=1234 \
-H "Content-Type:application/json" \
-H "Authorization: Bearer Access-Token" \ 

Результат

Успешный запрос возвращает код состояния HTTP 200 OK и тело ответа JSON.

  • total

    integer

    Общее количество подписчиков
     
  • count

    integer

    Количество подписчиков на странице
     
  • items

    array (contains the user object)

    Данные пользователей. Используйте для сбора необходимой информации о пользователях.
     

Пример результата

  {
    "total": 8,
    "count": 8,
    "items": [
        {
            "objectType": "account",
            "kind": "steein#account",
            "username": "steein_official",
            "displayName": "Steein Official",
            "name": {
                "first_name": "Steein",
                "last_name": "Official"
            },
            "id": 2,
            "description": "",
            "country": "",
            "link": "https://www.steein.ru/steein_official",
            "verified": 0,
            "avatar": "https://www.steein.ru/media/i/p/27111608__1249380765__2501243914583a9bba7dd570.47114212.jpg",
            "action": {
                "followers": 5,
                "following": 2,
                "posts": 8
            }
        }
    ]
} 

 

Список подписок

GET /users/following

Успешный запрос возвращает код состояния HTTP 200 OK и тело ответа JSON, которое выводит список подписок пользователя.

Параметры

  • id

    integer

    required

    Идентификатор пользователя.
     
  • count

    integer

    Указывает, какое максимальное число которые следует возвращать, но не более 100. По умолчанию 70.
     
  • page

    integer

    Постраничная навигация, для того, чтобы получить следующую часть
     

Пример запроса

  curl -v -X GET https://www.steein.ru/api/v2.0/users/following?id=1234 \
-H "Content-Type:application/json" \
-H "Authorization: Bearer Access-Token" \ 

Результат

Успешный запрос возвращает код состояния HTTP 200 OK и тело ответа JSON.

  • total

    integer

    Общее количество подписок
     
  • count

    integer

    Количество подписок на странице
     
  • items

    array (contains the user object)

    Данные пользователей. Используйте для сбора необходимой информации о пользователях.
     

Пример результата

  {
    "total": 8,
    "count": 8,
    "items": [
        {
            "objectType": "account",
            "kind": "steein#account",
            "username": "steein_official",
            "displayName": "Steein Official",
            "name": {
                "first_name": "Steein",
                "last_name": "Official"
            },
            "id": 2,
            "description": "",
            "country": "",
            "link": "https://www.steein.ru/steein_official",
            "verified": 0,
            "avatar": "https://www.steein.ru/media/i/p/27111608__1249380765__2501243914583a9bba7dd570.47114212.jpg",
            "action": {
                "followers": 5,
                "following": 2,
                "posts": 8
            }
        }
    ]
} 

 

Список понравившихся записей

GET /users/favorites

Успешный запрос возвращает код состояния HTTP 200 OK и тело ответа JSON, которое выводит список понравившихся записей пользователя.

Параметры

  • id

    integer

    required

    Идентификатор пользователя.
     
  • count

    integer

    Указывает, какое максимальное число которые следует возвращать, но не более 100. По умолчанию 70.
     
  • page

    integer

    Постраничная навигация, для того, чтобы получить следующую часть
     

Пример запроса

  curl -v -X GET https://www.steein.ru/api/v2.0/users/favorites?id=1234 \
-H "Content-Type:application/json" \
-H "Authorization: Bearer Access-Token" \ 

Результат

Успешный запрос возвращает код состояния HTTP 200 OK и тело ответа JSON.

  • total

    integer

    Общее количество записей
     
  • count

    integer

    Количество записей на странице
     
  • items

    array (contains the items object)

    Данные записей. Используйте для сбора необходимой информации о записях.
     

Пример результата

  {
    "total": 5,
    "count": 5,
    "items": [
        {
            "id": 3909,
            "text": "Начиная с сегодняшнего дня к этому списку добавляются новые пользовательские темы — это значит, что вы сможете изменить внешний вид своей учетной записи в Steein так, как захотите. Например, сделать гламурный голубой текст, или чёрные буквы на чёрном фоне, и никто не сможет вас остановить! Это только начало, в ближайшее время появится глобальный конструктор тем.",
            "created": "Wed, Mar 1, 2017 10:20 PM",
            "link": "https://www.steein.ru/steein_official/posts/3909",
            "user": {
                "objectType": "account",
                "kind": "steein#account",
                "username": "steein_official",
                "displayName": "Steein Official",
                "name": {
                    "first_name": "Steein",
                    "last_name": "Official"
                },
                "id": 2,
                "description": "",
                "country": "",
                "link": "https://www.steein.ru/steein_official",
                "verified": 0,
                "avatar": "https://www.steein.ru/media/i/p/27111608__1249380765__2501243914583a9bba7dd570.47114212.jpg",
                "action": {
                    "followers": 5,
                    "following": 2,
                    "posts": 8
                }
            },
            "media": {
                "image": null,
                "files": []
            },
            "hashtags": [],
            "urls": [],
            "user_definition": [],
            "action": {
                "likes": 1,
                "comments": 0,
                "reposts": 0
            }
        }
    ]
} 

 

Account (resource group)

Используйте ресурс /account для настроек учетной записи.

Проверка имени пользователя

GET /account/check_username

Проверяет имя пользователя и проверяет наличие.

Успешный запрос возвращает код состояния HTTP 200 OK и тело ответа JSON, которое показывает детали учетной записи.

Параметры

В URI запросе укажите имя пользователя, которую желаете использовать.
  • username

    string

    required

    Принимаемые символы: Az (без учета регистра), 0-9 и символы подчеркивания.

    Минимальная длина: 5.

    Максимальная длина: 32.

Пример запроса

  curl -v -X GET https://www.steein.ru/api/v2.0/account/check_username?username=shamsudin \
-H "Content-Type:application/json" \
-H "Authorization: Bearer Access-Token" 

Результат

Успешный запрос возвращает код состояния HTTP 200 OK и тело ответа JSON, в котором отображаются данные.

  • status

    integer

    Результат проверки

    • 1 - занят
    • 0 - свободен
     

Пример результата

  {
    "response": {
        "status": 1
    }
}  

 

Редактирование имени пользователя

POST /account/update_username

Изменяет имя пользователя для текущего пользователя.

Успешный запрос возвращает код состояния HTTP 200 OK и тело ответа JSON, которое показывает детали учетной записи.

Параметры

В URI запросе укажите имя пользователя, которую желаете зарегистрировать.
  • username

    string

    required

    Принимаемые символы: Az (без учета регистра), 0-9 и символы подчеркивания.

    Минимальная длина: 5.

    Максимальная длина: 32.

Пример запроса

  curl -v -X POST https://www.steein.ru/api/v2.0/account/update_username \
-H "Content-Type:application/json" \
-H "Authorization: Bearer Access-Token"
-d '{
  "username": "shamsudin"
  }' 

Результат

Успешный запрос возвращает код состояния HTTP 200 OK и тело ответа JSON, в котором отображаются данные.

  • status

    integer

    Результат проверки

    • 1 - занят
    • 0 - свободен
     
  • username

    string

    Получаем новое имя пользователя

     

Пример результата

  {
    "response": {
        "status": 1
    }
}