Введение в API

Обзор

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

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

Requests format

Все обращения к API должны совершаться по адресу:
http://userecho.com/api/

Типовой формат запроса
http://userecho.com/api/[command].[format]?key=[api_key]
где
[command] - любая из поддерживаемых команд
[format] - формат вывода. Мы поддерживаем json и xml
[api_key] - Ваш ключ API. Вы можете получить свой ключ пройдя по ссылке Настройки->Расширенные функции->API

Вы доожны заменить [user_id],[feedback_id],[forum_id],... соответствующими значениями

Формат ответов

Мы поддерживаем JSON и XML форматы выдачи. Если Вам небходим другой формат запросите его на форуме поддержки. Замените [format] на json или xml.

Дополнительные параметры

Мы поддерживаем постраничную выдачу данных во всех запросах. По умолчанию выдача во всех запросах ограничена 50ю записями.
Для постраничной выдачи используются два параметра.
page - выберите страницу
limit - количество записей на странице

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

Для примера получим список пользователей Вашего форума.
http://userecho.com/api/users.json?key=[replace with your key] - возвращает всех пользователей. http://userecho.com/api/users.json?page=11&limit=2&key=[replace with your key] - возвратит 11ю страницу списка пользователей 

[
    {
        "first_name": "D C", 
        "is_staff": false, 
        "last_login": "2010-03-04 09:42:23", 
        "id": 171, 
        "date_joined": "2010-03-04 09:42:23"
    }, 
    {
        "first_name": "carlopires", 
        "is_staff": false, 
        "last_login": "2010-04-09 16:21:04", 
        "id": 175, 
        "date_joined": "2010-03-04 15:34:58"
    }
]

Документация по всем функциям.

XЯзык