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

API JustParty

Вы можете создать любое приложение и использовать API JustParty для доступа и обмена информацией с серверами JustParty.

Добавление своего приложения на сайт

Заявки на добавление приложения пожалуйста оставляйте здесь: http://justparty.ru/application.new/

Взаимодействие приложения с API

Стандартное взаимодействие приложения с API JustParty производится путем создания HTTP-запроса (метод GET) к адресу API-сервиса http://api.justparty.ru

Сервер принимает не более трёх запросов в секунду, содержащих одинаковые параметры api_id и api_user. То есть запущенное конкретным пользователем приложение не должно отправлять более трёх запросов в секунду.

При инициализации Flash-приложению через flashVars передаются следующие переменные (в IFrame-приложение эти переменные передаются посредством GET-параметров запроса):

Название переменнойОписание
api_userидентификатор текущего пользователя

Какие параметры необходимо передавать при запросе?

Название параметраОбязательный параметрОписание
api_id+идентификатор приложения
api_key+ключ приложения
api_user+идентификатор текущего пользователя

Значения api_id и api_key доступны после добавления приложения в каталог приложений.

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

http://api.justparty.ru/Users.getUser/?api_id=821&api_key=7a0c35b7c62c738da939d013680af535
&api_user=1001&user_id=1002

Пример ответа:

Ответ по умолчанию приходит в формате XML в кодировке UTF-8.

<?xml version="1.0" encoding="UTF-8"?>
<response version="1.0">
  <command name="Users.getUser" id="21" runtime="0,131">
    <record>
      <id>1002</id>
      <sex_id>1</sex_id>
      <sex_name>мужской</sex_name>
      <country_id>3159</country_id>
      <country_name>Россия</country_name>
      <region_id>4925</region_id>
      <region_name>Санкт-Петербург и область</region_name>
      <city_id>4962</city_id>
      <city_name>Санкт-Петербург</city_name>
      <online>false</online>
      <birthday>1983-05-02</birthday>
      <name_first>Сергей</name_first>
      <name_last>Николаевич</name_last>
      <avatar_small>storage.justparty.ru/0000/0000/0000/0006/avatar-50x75.jpg?15719</avatar_small>
      <avatar_medium>storage.justparty.ru/0000/0000/0000/0006/avatar-200x300.jpg?15719</avatar_medium>
      <avatar_large>storage.justparty.ru/0000/0000/0000/0006/avatar.jpg?15719</avatar_large>
      <link>http://justparty.ru/user.info/?id=6</link>
    </record>
  </command>
</response>

Описание методов API

Ниже приводятся все методы для работы с данными JustParty.

Приложения:

  • Apps.isAppUser — проверяет принадлежность пользователя к приложению

Пользователи:

  • Users.getUser — возвращает информацию о пользователе
  • Users.getCountUsers — возвращает количество пользователей, которые установили данное приложение
  • Users.getUsers — возвращает список пользователей, которые установили данное приложение

Друзья:

Мероприятия:

Желания:

Сообщения:

  • Messages.sendMessage — отправляет личное сообщение
  • Messages.sendEmail — отправляет email сообщение (появится в ближайшее время)
  • Messages.sendSms — отправляет sms сообщение (появится в ближайшее время)

Приглашения:

Приложения:

  • Apps.isAppUser — проверяет принадлежность пользователя к приложению

    Параметры

    Название параметраОбязательный параметрОписание
    api_id+идентификатор приложения
    api_key+ключ приложения
    api_user+идентификатор текущего пользователя
    user_id+идентификатор пользователя

    Результат

    Название поляОписание
    resulttrue — приложение установлено, false — приложение не установлено

Пользователи:

  • Users.getUser — возвращает информацию о пользователе

    Параметры

    Название параметраОбязательный параметрОписание
    api_id+идентификатор приложения
    api_key+ключ приложения
    api_user+идентификатор текущего пользователя
    user_id—идентификатор пользователя

    Результат

    Название поляОписание
    idидентификатор пользователя
    sex_idидентификатор пола (1 — мужской, 2 — женский)
    sex_nameназвание пола
    country_idидентификатор страны
    country_nameназвание страны
    region_idидентификатор региона
    region_nameназвание региона
    city_idидентификатор города
    city_nameназвание города
    onlineонлайн статус (true — в сети, false — не в сети)
    birthdayдата рождения
    name_firstимя
    name_patronymicотчество
    name_lastфамилия
    avatar_smallадрес изображения (небольшой вариант)
    avatar_mediumадрес изображения (средний вариант)
    avatar_largeадрес изображения (большой вариант)
    linkадрес страницы

  • Users.getCountUsers — возвращает количество пользователей, которые установили данное приложение

    Параметры

    Название параметраОбязательный параметрОписание
    api_id+идентификатор приложения
    api_key+ключ приложения
    api_user+идентификатор текущего пользователя
    referrer_id—идентификатор пользователя, который порекомендовал приложение

    Результат

    Название поляОписание
    resultколичество пользователей

  • Users.getUsers — возвращает список пользователей, которые установили данное приложение

    Параметры

    Название параметраОбязательный параметрОписание
    api_id+идентификатор приложения
    api_key+ключ приложения
    api_user+идентификатор текущего пользователя
    referrer_id—идентификатор пользователя, который порекомендовал приложение

    Результат

    см. метод Users.getUser

Друзья:

  • Friends.getCountFriendsByUserId — возвращает количество друзей пользователя

    Параметры

    Название параметраОбязательный параметрОписание
    api_id+идентификатор приложения
    api_key+ключ приложения
    api_user+идентификатор текущего пользователя
    user_id+идентификатор пользователя
    app_id—идентификатор приложения

    Результат

    Название поляОписание
    resultколичество друзей

  • Friends.getFriendsByUserId — возвращает список друзей пользователя

    Параметры

    Название параметраОбязательный параметрОписание
    api_id+идентификатор приложения
    api_key+ключ приложения
    api_user+идентификатор текущего пользователя
    user_id+идентификатор пользователя
    app_id—идентификатор приложения
    limit—лимит
    offset—смещение

    Результат

    см. метод Users.getUser

Мероприятия:

  • Events.getEvent — возвращает информацию о мероприятие

    Параметры

    Название параметраОбязательный параметрОписание
    api_id+идентификатор приложения
    api_key+ключ приложения
    api_user+идентификатор текущего пользователя
    event_id+идентификатор мероприятия

    Результат

    Название поляОписание
    idидентификатор мероприятия
    user_idидентификатор пользователя (владелец)
    access_idидентификатор уровня доступа
    access_nameназвание уровня доступа
    category_idидентификатор категории
    category_nameназвание категории
    country_idидентификатор страны
    country_nameназвание страны
    region_idидентификатор региона
    region_nameназвание региона
    city_idидентификатор города
    city_nameназвание города
    subway_idидентификатор метро
    subway_nameназвание метро
    place_idидентификатор места проведения
    place_nameназвание места проведения
    location_nameназвание места проведения (введенное пользователем)
    location_addressадрес места проведения (введенное пользователем)
    nameназвание
    descriptionописание
    avatar_smallадрес изображения (небольшой вариант)
    avatar_mediumадрес изображения (средний вариант)
    avatar_largeадрес изображения (большой вариант)
    linkадрес страницы

  • Events.getCountEventsByUserId — возвращает количество мероприятий пользователя

    Параметры

    Название параметраОбязательный параметрОписание
    api_id+идентификатор приложения
    api_key+ключ приложения
    api_user+идентификатор текущего пользователя
    user_id+идентификатор пользователя

    Результат

    Название поляОписание
    resultколичество мероприятий

  • Events.getEventsByUserId — возвращает список мероприятий пользователя

    Параметры

    Название параметраОбязательный параметрОписание
    api_id+идентификатор приложения
    api_key+ключ приложения
    api_user+идентификатор текущего пользователя
    user_id+идентификатор пользователя
    limit—лимит
    offset—смещение

    Результат

    см. метод Events.getEvent

Желания:

  • Wishes.getWish — возвращает информацию о желание

    Параметры

    Название параметраОбязательный параметрОписание
    api_id+идентификатор приложения
    api_key+ключ приложения
    api_user+идентификатор текущего пользователя
    wish_id+идентификатор желания

    Результат

    Название поляОписание
    idидентификатор желания
    user_idидентификатор пользователя (владелец)
    access_idидентификатор уровня доступа
    access_nameназвание уровня доступа
    priority_idидентификатор приоритета
    priority_nameназвание приоритета
    confirmedtrue — подтверждено, false — не подтверждено
    executedtrue — исполнено, false — не исполнено
    price_fromцена (от)
    price_toцена (до)
    urlадрес страницы с описанием
    nameназвание
    descriptionописание
    avatar_smallадрес изображения (небольшой вариант)
    avatar_mediumадрес изображения (средний вариант)
    avatar_largeадрес изображения (большой вариант)
    linkадрес страницы

  • Wishes.getCountWishesByUserId — возвращает количество желаний пользователя

    Параметры

    Название параметраОбязательный параметрОписание
    api_id+идентификатор приложения
    api_key+ключ приложения
    api_user+идентификатор текущего пользователя
    user_id+идентификатор пользователя

    Результат

    Название поляОписание
    resultколичество желаний

  • Wishes.getWishesByUserId — возвращает список желаний пользователя

    Параметры

    Название параметраОбязательный параметрОписание
    api_id+идентификатор приложения
    api_key+ключ приложения
    api_user+идентификатор текущего пользователя
    user_id+идентификатор пользователя
    limit—лимит
    offset—смещение

    Результат

    см. метод Wishes.getWish

Сообщения:

  • Messages.sendMessage — отправляет личное сообщение

    Параметры

    Название параметраОбязательный параметрОписание
    api_id+идентификатор приложения
    api_key+ключ приложения
    api_user+идентификатор текущего пользователя
    recipient_id+идентификатор получателя
    subject—тема сообщения
    message+текст сообщения

    Результат

    Название поляОписание
    resulttrue — отправлено, false — не отправлено

Приглашения:

  • Invitations.sendSiteInvitation — отправляет приглашение на сайт

    Параметры

    Телефон и адрес электронной почты являются необязательными параметрами, но наличие одного из них — обязательно.

    Название параметраОбязательный параметрОписание
    api_id+идентификатор приложения
    api_key+ключ приложения
    api_user+идентификатор текущего пользователя
    phone—телефон получателя
    email—адрес электронной почты получателя
    name_first—имя получателя
    name_last—фамилия получателя

    Результат

    Название поляОписание
    resulttrue — отправлено, false — не отправлено

  • Invitations.sendEventInvitation — отправляет приглашение на мероприятие

    Параметры

    Идентификатор, телефон и адрес электронной почты являются необязательными параметрами, но наличие одного из них — обязательно.

    Название параметраОбязательный параметрОписание
    api_id+идентификатор приложения
    api_key+ключ приложения
    api_user+идентификатор текущего пользователя
    event_id+идентификатор мероприятия
    recipient_id—идентификатор получателя
    phone—телефон получателя
    email—адрес электронной почты получателя
    name_first—имя получателя
    name_last—фамилия получателя

    Результат

    Название поляОписание
    resulttrue — отправлено, false — не отправлено
© 2010 JustParty - все для праздника. Все права защищены.