Доступность платформы
- Состояние за 24 ч
- Норма
За последние 30 дней
Доступные возможности
Все действия Yelp: что делает каждое, сколько стоит и как работало за последние 24 часа. Откройте действие, чтобы увидеть параметры, поля ответа и примеры кода.
| Возможность | Описание | За 1000 | Состояние за 24 часа |
|---|---|---|---|
Поискsearch | Ищите местные компании на Yelp в городе или по ZIP-коду. | $1.39 за 1 000 запросов | Норма |
Сведенияprofile | Откройте страницу компании на Yelp по ссылке /biz/. | $1.39 за 1 000 запросов | Норма |
Отзывыreviews | Читайте отзывы Yelp об одной компании, по 10 на странице. | $1.39 за 1 000 запросов | Норма |
Откройте возможность, чтобы посмотреть её параметры, поля ответа и примеры кода, а также попробовать её в работе.
Какие параметры принимает каждое действие API Yelp?
Каждый ответ ниже описывает одно вызываемое действие и его фактические входные данные. Значение параметров и допустимые значения зависят от действия: знакомое имя параметра не обязательно означает одно и то же на всех платформах.
Ссылки на официальные источники приводятся только для пояснения расположенного рядом термина, принятого на платформе. Они не означают, что платформа предоставила разрешение или выразила одобрение. Функции официального сайта не входят в API EveryInfra, если они не перечислены на этой странице.
| Действие | Обязательные | Необязательные | Способ получения результата | Лимит | За 1 000 | Поля ответа |
|---|---|---|---|---|---|---|
searchПоиск Ищите местные компании на Yelp в городе или по ZIP-коду. Получите рейтинг, число отзывов, ценовую категорию, категории, контакты, часы работы и статус подтверждения страницы. Всегда указывайте | keyword | location | Режим выдачи: Sync | Значения в каталоге: defaultLimit=10, maxLimit=50. В некоторых действиях limit задаёт число страниц или число вложенных элементов на родительский объект, поэтому это не всегда итоговое количество записей. | $1.39 за 1 000 запросов | id · name · url · rating · rating_scale · review_count · price_range · categories · image_url · platform · phone · website · cuisine · description · address · city · region · postal_code · country · is_claimed · is_verified · health_score · established_year · images · amenities · highlights · hours |
profileСведения Откройте страницу компании на Yelp по ссылке /biz/. Получите рейтинг, ценовую категорию, категории, контакты, адрес, часы работы, удобства, основные особенности и фото. Неподтверждённая страница, что видно по | url | — | Режим выдачи: Sync | — | $1.39 за 1 000 запросов | id · name · url · rating · rating_scale · review_count · price_range · phone · website · categories · cuisine · description · address · city · region · postal_code · country · is_claimed · is_verified · health_score · established_year · image_url · platform · images · amenities · highlights · hours |
reviewsОтзывы Читайте отзывы Yelp об одной компании, по 10 на странице. Для каждого отзыва возвращаются текст, оценка, дата, автор, число фото и голоса «Полезно», «Смешно» и «Круто». Для следующей страницы передайте | url | page_token | Режим выдачи: Sync | Значения в каталоге: defaultLimit=10, maxLimit=10. В некоторых действиях limit задаёт число страниц или число вложенных элементов на родительский объект, поэтому это не всегда итоговое количество записей. Можно передать большее значение limit, но оно будет ограничено значением 10. Чтобы получить следующую страницу, передайте next_page_token как page_token, не меняя остальные параметры; каждая страница — отдельный вызов. Записей на странице: до 100; если записей больше 50, запрашивайте страницу с mode=async. | $1.39 за 1 000 запросов | id · text · rating · rating_scale · posted_at · author_name · useful_count · photo_count · business_name · business_url · platform · funny_count · cool_count |
Что означают параметры действия search в API Yelp?
Ищите местные компании на Yelp в городе или по ZIP-коду. Получите рейтинг, число отзывов, ценовую категорию, категории, контакты, часы работы и статус подтверждения страницы. Всегда указывайте location, потому что по умолчанию поиск идёт по Нью-Йорку. health_score есть только у ресторанов.
keywordОбязательный- Поисковый запрос по местным компаниям или услугам (например, coffee) для действия search в Yelp. Чтобы поиск не шёл по умолчанию по Нью-Йорку, указывайте вместе с ним явное значение location.
locationНеобязательный- Город, район или почтовый индекс для поиска компаний, например Austin, TX или 78701. Описывает местоположение компании, а не автора отзыва.
Что означают параметры действия profile в API Yelp?
Откройте страницу компании на Yelp по ссылке /biz/. Получите рейтинг, ценовую категорию, категории, контакты, адрес, часы работы, удобства, основные особенности и фото. Неподтверждённая страница, что видно по is_claimed, может содержать устаревшие данные. Эти данные не доказывают право собственности или наличие лицензий.
urlОбязательный- URL компании на Yelp с сегментом /biz/ в пути для действий profile и reviews, которые возвращают метаданные компании или отзывы пользователей. Ссылки на профили пользователей не поддерживаются.
Что означают параметры действия reviews в API Yelp?
Читайте отзывы Yelp об одной компании, по 10 на странице. Для каждого отзыва возвращаются текст, оценка, дата, автор, число фото и голоса «Полезно», «Смешно» и «Круто». Для следующей страницы передайте next_page_token обратно как page_token. Токены действуют 24 часа.
urlОбязательный- URL компании на Yelp с сегментом /biz/ в пути для действий profile и reviews, которые возвращают метаданные компании или отзывы пользователей. Ссылки на профили пользователей не поддерживаются.Yelp: как нерекомендованные отзывы связаны с общим рейтингом — Yelp указывает, что отзывы, которые сейчас не рекомендуются, не учитываются в общем звёздном рейтинге и числе отзывов заведения; поэтому число записей и среднюю оценку в любой собранной выборке нельзя напрямую выдавать за официальные сводные показатели сайта. · Проверено
page_tokenНеобязательный- Токен пагинации: чтобы получить следующую страницу, передайте next_page_token из предыдущего ответа; для первой страницы не указывайте его. Остальные параметры не меняйте. Токены действуют 24 часа, каждая страница — это один вызов.
Как использовать API Yelp
- 01Выберите действие платформы в публичном каталоге.
- 02Передайте платформу, действие и обязательные параметры в POST-запросе на эндпоинт /api/v1/social.
- 03Получите результат из ответа. Для асинхронного действия опрашивайте статус по возвращённому ID задачи.
- 04Сохраните поля ответа, которые нужны вашему приложению.
curl -X POST https://api.everyinfra.com/api/v1/social \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"platform":"yelp","action":"search","params":{"keyword":"<keyword>"}}'
Вопросы об API Yelp
Какие данные можно получить через API Yelp?
Укажите в platform значение yelp. В текущем каталоге: поиск, сведения и отзывы. Эти названия действий соответствуют разным объектам или представлениям Yelp; это не взаимозаменяемые режимы поиска.
Какие входные данные нужны для запроса search к платформе Yelp?
Поисковый запрос по местным компаниям или услугам (например, coffee) для действия search в Yelp. Чтобы поиск не шёл по умолчанию по Нью-Йорку, указывайте вместе с ним явное значение location. Передайте это значение в поле keyword объекта params.
Какие поля может вернуть search на платформе Yelp?
Объявленная схема включает name, rating, rating_scale и review_count. Объявленное поле может отсутствовать в отдельной записи, а у каждого другого действия свой список полей.
Все ли действия Yelp возвращают результат сразу?
Действия с пометкой «асинхронное» возвращают ID задачи, по которому нужно опрашивать статус. Любое другое действие тоже можно запустить асинхронно: добавьте "mode": "async" в тело запроса, чтобы сразу получить ID задачи. Это удобно для длительных задач или запросов с большим лимитом. В текущем каталоге: режим выдачи: sync.