Главная > API

Livents API документация - Версия 2.0

Важное замечание: Использование API возможно только на некоммерческой основе. Если Вы хотите использовать API для коммерческих целей, пожалуйста обратитесь к администрации. Мы разрешим большинство запросов, но при условии сохранения авторских прав.

Краткий обзор

API-интерфейс Ливентса представляет собой RESTful interface, что означает что Вы можете отправлять HTTP-запросы методом GET или POST для вызова того или иного метода, а в качестве ответа на запрос Вы получите XML-документ.

Замечание: API Ливентса предоставляют все данные в кодировке UTF-8.

Когда Вы посылаете запрос, Вы получаете в ответ XML-документ в следующем виде:

<rsp result="ok">
	[Данные в XML-формате - индивидуально для каждого
	 из методов, перечисленных ниже]
</rsp>

В случае ошибки Ливентс пошлет ответ, содержаший описание произошедшей ошибки.

<rsp result="Event not found" />

Способ аутентификации на основе сеансового ключа (token)

Для того, чтобы начать работу с Ливентс-API, необходимо произвести регистрацию сеанса работы в системе и получить так называемый сеансовый ключ (token), который в дальнейшем будет необходим для вызова всех остальных методов. Сеансовый ключ генерируется и выдается на период 1 час с момента его активации. После получения сеансового ключа методом "token/get" его необходмо активизировать (привязать к определенному пользователю). Это позволяет сделать метода "token/activate".

После окончания работы сеансовый ключ можно деактивизировать "token/deactivate". В противном случае его время действия закончится через 1 час после активизации. Если пользователь по истечению 1 часа все еще работает с Ливентсом, то следует получить новый сеансовы ключ. Проверить текущее состояние сеансового ключа можно при помощи метода "token/check".

Как это сделать?

Вы можете использовать шлюз http://api.livents.ru/ для вызова API-методов при помощи HTTP-запросов в формате GET или POST. Для дострупа Вам необходимо знать свой API-ключ, сеансовый ключ, имя метода и некоторые другие возможные параметры.

Напирмер: вот пример GET-запроса (используется Ваш API-ключ и сеансовый ключ):

http://api.livents.ru/user/list/?api_key=<API Key>&token=<Token Code>&limit=10&offset=0

Если Вы знаете, как использовать cURL, вот POST-пример в синтаксисе командной строки cURL:

curl -d api_key=<API Key> -d token=<Token Code> http://api.livents.ru/user/list/

Методы

Методы представлены в виде двух (иногда трех) параметров, которые следует указывать в строке URL.
Например: вызов метода "user/info" будет выглядеть следущим образом: http://api.livents.ru/user/info/