API

Для получения API KEY необходима авторизация


Список закладок

GET http://www.zvtra.ru/bookmarks?api_key={api_key}&limit={limit}&offset={offset}
api_key string(32) Ваш API KEY
limit integer Максимальное количество (по умолчанию возвращаются все)
offset integer Пропустить количество записей (по умолчанию 0)

Примеры ответов сервера (JSON):
{
    "success": true,
    "data": [{
        "id": "4d32c57069758927c400005c",
        "title": "Яндекс / Компании / Хабрахабр",
        "url": "http://habrahabr.ru/company/yandex/",
        "domain": "habrahabr.ru",
        "content_exists": true,                          //наличие текстовой версии
        "created_at": "1125626956"
    }, {
        "id": "6312457c6932192735d00cca3",
        "title": "Agito переименована в Type-0",
        "url": "http://squarefaction.ru/games/page/final-fantasy-agito-xiii/blog/1710",
        "domain": "squarefaction.ru",
        "content_exists": false,
        "created_at" : "1045626956"
    }]
}


Добавление закладки

POST http://www.zvtra.ru/bookmarks
api_key string(32) Ваш API KEY
url string(100) URL страницы
grab_title string(yes/no) Взять заголовок с источника (по умолчанию yes)
title string(100) Задать свой заголовок
grab_content string(yes/no) Взять текст источника (по умолчанию yes)
content text(10000) Задать свой текст (html очищается)

Примеры ответов сервера (JSON):
{
    "success": true,
    "data": {
        "id": "4d32c57069758927c400005c"
    }
}
{
    "success": false,
    "error": "Неправильный формат URL"
}


Запрос на текст статьи

GET http://www.zvtra.ru/bookmarks/{bookmark_id}?api_key={api_key}
api_key string(32) Ваш API KEY

Примеры ответов сервера (JSON):
{
    "success": true
    "data": {
        "title": "Vogue-Tec News #1",
        "text": "Обзор нововведений, интересностей{...полный текст статьи}"
    }
}


Редактирование закладки

PUT http://www.zvtra.ru/bookmarks/{bookmark_id}?api_key={api_key}
api_key string(32) Ваш API KEY
url string(100) URL страницы
title string(100) Заголовок
content text(10000) Текст (html очищается)


Удаление закладки

DELETE http://www.zvtra.ru/bookmarks/{bookmark_id}?api_key={api_key}
api_key string(32) Ваш API KEY


Примеры ответов сервера (JSON):
{
    "success": true
    "data": {
        "title": "Vogue-Tec News #1",
        "text": "Ежечекпоинтовый обзор нововведений, интересностей и общих событий {...полный текст статьи}"
    }
}


Восстановление из удаленных

GET http://www.zvtra.ru/bookmarks/restore/{bookmark_id}?api_key={api_key}
api_key string(32) Ваш API KEY

Примеры ответов сервера (JSON):
{
    "success": true                
}
{
    "success": false,
    "error": "Закладку уже нельзя восстановить"
}


Получение ApiKey

GET/POST http://www.zvtra.ru/api/get_key?email={email}&password={password}
email string(100) Email аккаунта
password string(100) Пароль аккаунта

Примеры ответов сервера (JSON):
{
    "success": true,
    "data": {
        "key" : "6312457c6932192735d00cca3", 
    }
}




Формат JSON-ответов сервера

Ответ сервера всегда отправляется в JSON и единую структуру

success boolean(true/false) TRUE в случае удачного совершения операции
error string(200) Текст ошибки (отсутсвует, если ошибок нет)
data JSON-object Объект с запрашиваемыми данными (отсутсвует, если есть ошибка)


Пример библиотеки на PHP: скачать ZvtraApi.zip