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

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 — возвращает список пользователей, которые установили данное приложение

Друзья:

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

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

  • Events.getEvent — возвращает информацию о мероприятие
  • Events.getCountEventsByUserId — возвращает количество мероприятий пользователя
  • Events.getEventsByUserId — возвращает список мероприятий пользователя

Желания:

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

Сообщения:

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

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

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

Приложения:

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

    Параметры

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

    Результат

    Название поля Описание
    result true — приложение установлено, 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 название приоритета
    confirmed true — подтверждено, false — не подтверждено
    executed true — исполнено, 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 + текст сообщения

    Результат

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

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

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

    Параметры

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

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

    Результат

    Название поля Описание
    result true — отправлено, false — не отправлено
  • Invitations.sendEventInvitation — отправляет приглашение на мероприятие

    Параметры

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

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

    Результат

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