Наверх

Разделы API » Пресса

На этой странице описываются методы для получения статей о ресторане:

articles/getmany

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

Метод необходим для получения списка статей.

Параметры метода

Название параметра Обязательный Описание и возможные значения Пример значения
v да

Версия метода. Текущая версия метода - 2.

2

page да

Номер страницы со статьями. Номер первой страницы - 1.

1

limit да

Количество статей на одну страницу. Максимальное значение - 20.

10

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

Получить 10 статей ресторана:


<?php

include ('restobaza.class.php');  

$config = array(
  
"co_id" => 1,
  
"app_id" => 6,
  
"app_secret" => 'tc1a7g8b12dbd445'
);

$restobaza = new Restobaza($config);

$api_params = array(
  
"v" => 2,
  
"page" => 1
  
"limit" => 10
);

$rb_response $restobaza->api('articles/getmany'$api_params);

?>

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

Если в ресторане нет статей, то в ответе будет пустой массив. Если статьи есть:

{
    "pagination": {
        "page": 1,
        "limit": 2,
        "total_pages": 1,
        "total_items": 2
    },
    "list": [
        {
            "id": "17",
            "title": "name",
            "date": "2012-04-04",
            "publisher": "Timeout",
            "link": "http://www.kommersant.ru/doc/1219993",
            "pdf": "http://img.restobaza_local.ru/co/co25/articles/17/25_articles_17_517a69cf918e5.pdf",
            "text": "text",
            "images_count": "2",
            "cover": {
                "100": {
                    "width": 100,
                    "height": 67,
                    "source": "http://img.restobaza_local.ru/co/co25/articles/17/25_articles_17_100_517a69b0f18e2.jpg"
                },
                "150": {
                    "width": 150,
                    "height": 100,
                    "source": "http://img.restobaza_local.ru/co/co25/articles/17/25_articles_17_150_517a69b0f18e2.jpg"
                },
                "200": {
                    "width": 200,
                    "height": 133,
                    "source": "http://img.restobaza_local.ru/co/co25/articles/17/25_articles_17_200_517a69b0f18e2.jpg"
                },
                "300": {
                    "width": 300,
                    "height": 200,
                    "source": "http://img.restobaza_local.ru/co/co25/articles/17/25_articles_17_300_517a69b0f18e2.jpg"
                },
                "500": {
                    "width": 500,
                    "height": 333,
                    "source": "http://img.restobaza_local.ru/co/co25/articles/17/25_articles_17_500_517a69b0f18e2.jpg"
                },
                "1024": {
                    "width": 1024,
                    "height": 682,
                    "source": "http://img.restobaza_local.ru/co/co25/articles/17/25_articles_17_1024_517a69b0f18e2.jpg"
                }
            }
        },
        {...}
    ]
}

Описание ответа

Список статей содержится в ключе list, который представляет собой массив из объектов articles.

Объект articles:

Название поля Может быть пустым Описание Тип переменной
id

нет

Уникальный номер статьи.

string

name

нет

Название статьи.

string

date

нет

Дата публикации статьи в формате ISO-8601: 2017-07-26 (YYYYMMDD).

string

publisher

нет

Название журнала, газеты, или веб-сайта, где была опубликована статья. Например, Timeout.ru, или Коммерсант.

string

link

да

Ссылка на источник статьи.

string

pdf

да

Ссылка статью в формате PDF.

string

description

нет

Текст статьи или описание статьи.

string

images_count

нет

Количество фотографий статьи.

string

cover

да

Обложка статьи.

Ключи в массиве - 100, 150, 200, 300, 500, 1024 - обозначают максимальную ширину изображения.

Минимальная гарантированная ширина изображения - 200 пикселей. Т.е. изображение в ключах 300, 500, 1024 могут иметь ширину меньше заявленной.

Изображения не имеют фиксированной высоты.

ассоциативный array

Название поля Может быть пустым Описание Тип переменной
source

нет

Абсолютный URL адрес фотографии.

string

width

нет

Ширина фотографии в пикселях.

string

height

нет

Высота фотографии в пикселях.

string

Объект pagination содержит необходимую информацию для создания страниц со статьями:

Название поля Может быть пустым Описание Тип переменной
page

нет

Значение, которое было передано в параметре page в запросе. Обозначает номер текущей страницы.

string

limit

нет

Значение, которое было передано в параметре limit в запросе. Обозначает максимальное количество статей для одной страницы.

string

total_pages

нет

Общее количество страниц со статьями в ресторане.

string

total_items

нет

Общее количество статей в ресторане.

string

articles/getone

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

Метод необходим для создания отдельной страницы для статьи, а также для создания отдельной страницы для фотографий статьи.

Параметры запроса

Название параметра Обязательный Описание и возможные значения Пример
v да

Версия метода. Текущая версия метода - 2.

2

id да

Уникальный номер статьи.

77

photos_page нет

Необходимая страница для фотографий статьи. Данный параметр нужно указывать вместе с пареметром photos_limit. Чтобы получить первую страницу, указывайте значение 1.

1

photos_limit нет

Максимальное количество фотографий статьи на одну страницу. Данный параметр необходимо указывать вместе с пареметром photos_page.

Если в запросе указаны оба параметра photos_page и photos_limit, то в ответе в ключе images появятся фотографии статьи (если у статьи есть фотографии). Максимальное количество фотографий на одну страницу - 50.

10

other_limit нет

Количество других статей. Если этот параметр указан, то в ответе в ключе other появится список из последних статей ресторана. Указывайте этот параметр, если хотите создать ссылки на другие статьи ресторана со страницы открытой статьи. Максимальное количество других статей - 10.

6

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

Получить статью с уникальным номером 77, 10 фотографий этой статьи, а также 6 последних статей ресторана:


<?php

include ('restobaza.class.php');  

$config = array(
  
"co_id" => 1,
  
"app_id" => 6,
  
"app_secret" => 'tc1a7g8b12dbd445'
);

$restobaza = new Restobaza($config);

$api_params = array(
  
"v" => 2,
  
"id" => 77,
  
"photos_page" => 1,
  
"photos_limit" => 10,
  
"other_limit" => 6
);
$rb_response $restobaza->api('articles/getone'$api_params);

?>

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

Если были указаны только обязательные параметры, в ответ вы получите объект articles, при этом ключи images и other в объекте будут пустыми:

{
    "id": "17",
    "name": "name",
    "date": "2012-04-04",
    "publisher": "Timeout",
    "link": "http://www.kommersant.ru/doc/1219993",
    "pdf": "http://img.restobaza_local.ru/co/co25/articles/17/25_articles_17_517a69cf918e5.pdf",
    "description": "text",
    "images_count": "2",
    "cover": {
        "100": {
            "width": 100,
            "height": 67,
            "source": "http://img.restobaza_local.ru/co/co25/articles/17/25_articles_17_100_517a69b0f18e2.jpg"
        },
        "150": {
            "width": 150,
            "height": 100,
            "source": "http://img.restobaza_local.ru/co/co25/articles/17/25_articles_17_150_517a69b0f18e2.jpg"
        },
        "200": {
            "width": 200,
            "height": 133,
            "source": "http://img.restobaza_local.ru/co/co25/articles/17/25_articles_17_200_517a69b0f18e2.jpg"
        },
        "300": {
            "width": 300,
            "height": 200,
            "source": "http://img.restobaza_local.ru/co/co25/articles/17/25_articles_17_300_517a69b0f18e2.jpg"
        },
        "500": {
            "width": 500,
            "height": 333,
            "source": "http://img.restobaza_local.ru/co/co25/articles/17/25_articles_17_500_517a69b0f18e2.jpg"
        },
        "1024": {
            "width": 1024,
            "height": 682,
            "source": "http://img.restobaza_local.ru/co/co25/articles/17/25_articles_17_1024_517a69b0f18e2.jpg"
        }
    },
    "images": [ ],
    "other": [ ]
}


Если в запросе были указаны дополнительные параметры photos_limit и photos_page, то ключ images будет содержать список фотографий статьи. Если у статьи нет фотографий, то этот ключ будет пустым.

"images": {
        "pagination": {
            "page": 1,
            "limit": 2,
            "total_pages": 1,
            "total_items": "2"
        },
        "list": [
            {
                "id": "24",
                "caption": null,
                "sizes": {
                    "100": {
                        "width": 100,
                        "height": 151,
                        "source": "http://img.restobaza_local.ru/co/co25/articles/17/25_articles_17_100_517a69e8cf831.jpg"
                    },
                    "150": {
                        "width": 150,
                        "height": 226,
                        "source": "http://img.restobaza_local.ru/co/co25/articles/17/25_articles_17_150_517a69e8cf831.jpg"
                    },
                    "200": {
                        "width": 200,
                        "height": 301,
                        "source": "http://img.restobaza_local.ru/co/co25/articles/17/25_articles_17_200_517a69e8cf831.jpg"
                    },
                    "1600": {
                        "width": 1328,
                        "height": 2000,
                        "source": "http://img.restobaza_local.ru/co/co25/articles/17/25_articles_17_1600_517a69e8cf831.jpg"
                    }
                }
            },
            {...}
        ]
    },

В ответе, список фотографий содержится в ключе list, который представляет собой массив из объектов photo.

Объект photo:

Название поля Описание Может быть пустым Тип переменной
id

Уникальный номер фотографии.

нет

string

caption

Описание фотографии.

да

string

sizes

Ссылки на разные размеры фотографии.

Ключи в массиве - 100, 150, 200, 1600 - обозначают максимальную ширину изображения.

Минимальная гарантированная ширина изображения - 480 пикселей. Т.е. изображение в ключе 1600 может иметь ширину от 480 до 1024 пикселей.

Изображения не имеют фиксированной высоты.

нет

ассоциативный array

Название поля Описание Может быть пустым Тип переменной
source

Абсолютный URL адрес фотографии.

нет

string

width

Ширина фотографии в пикселях.

нет

string

height

Высота фотографии в пикселях.

нет

string

Объект pagination содержит необходимую информацию для создания страниц с фотографиями:

Название поля Может быть пустым Описание Тип переменной
page

нет

Значение, которое было передано в параметре photos_page в запросе. Обозначает номер текущей страницы.

string

limit

нет

Значение, которое было передано в параметре photos_limit в запросе. Обозначает максимальное количество фотографий для одной страницы.

string

total_pages

нет

Общее количество страниц с фотографиями в ресторане.

string

total_items

нет

Общее количество фотографий в статьи.

string



Если был указан дополнительный параметр other_limit, то ключ other будет содержать список последних статей ресторана. Если статей в ресторане нет, то этот ключ будет пустым.

"other": {
        "pagination": {
            "page": 1,
            "limit": 2,
            "total_pages": 1,
            "total_items": 2
        },
        "list": [
            {
                "id": "17",
                "name": "name",
                "date": "2012-04-04",
                "publisher": "Timeout",
                "link": "http://www.kommersant.ru/doc/1219993",
                "pdf": "http://img.restobaza_local.ru/co/co25/articles/17/25_articles_17_517a69cf918e5.pdf",
                "description": "text",
                "images_count": "2",
                "cover": {
                    "100": {
                        "width": 100,
                        "height": 67,
                        "source": "http://img.restobaza_local.ru/co/co25/articles/17/25_articles_17_100_517a69b0f18e2.jpg"
                    },
                    "150": {
                        "width": 150,
                        "height": 100,
                        "source": "http://img.restobaza_local.ru/co/co25/articles/17/25_articles_17_150_517a69b0f18e2.jpg"
                    },
                    "200": {
                        "width": 200,
                        "height": 133,
                        "source": "http://img.restobaza_local.ru/co/co25/articles/17/25_articles_17_200_517a69b0f18e2.jpg"
                    },
                    "300": {
                        "width": 300,
                        "height": 200,
                        "source": "http://img.restobaza_local.ru/co/co25/articles/17/25_articles_17_300_517a69b0f18e2.jpg"
                    },
                    "500": {
                        "width": 500,
                        "height": 333,
                        "source": "http://img.restobaza_local.ru/co/co25/articles/17/25_articles_17_500_517a69b0f18e2.jpg"
                    },
                    "1024": {
                        "width": 1024,
                        "height": 682,
                        "source": "http://img.restobaza_local.ru/co/co25/articles/17/25_articles_17_1024_517a69b0f18e2.jpg"
                    }
                }
            },
            {...}
        ]
    }

Информация в ключе other ничем не отличается от той, которую можно получить с помощью метода articles/getmany.