Skip to content

Latest commit

 

History

History
205 lines (173 loc) · 12.1 KB

employers.md

File metadata and controls

205 lines (173 loc) · 12.1 KB
Raw

Работодатели/компании

Поиск компаний

GET /employers вернёт результаты поиска компаний.

Возможные дополнительные параметры:

  • text - текстовое поле, переданное значение ищется в названии и описании компании
  • area - идентификатор региона работодателя, множественный параметр. Идентификаторы регионов можно узнать в справочнике регионов
  • type - типы работодателей, множественный параметр. Разрешенные значения - ключи в справочнике employer_type
  • only_with_vacancies - возвращать только работодателей у которых есть в данный момент открытые вакансии (true) или же всех (false). По умолчанию - false.
  • page - номер страницы с работодателями (считается от 0, по умолчанию - 0)
  • per_page - количество элементов на страницу (по умолчанию - 20, максимум - 100 )

При указании параметров пагинации (page, per_page) работает ограничение: глубина возвращаемых результатов не может быть больше 2000. Например, возможен запрос per_page=10&page=199 (выдача с 1991 по 2000 компанию), но запрос с per_page=10&page=200 вернёт ошибку (выдача с 2001 до 2010 компанию).

Ответ

Успешный ответ приходит с кодом 200 OK и содержит тело:

{
    "per_page": 20,
    "page": 0,
    "pages": 1,
    "found": 1,
    "items": [
        {
            "id": "1455",
            "name": "HeadHunter",
            "url": "https://api.hh.ru/employers/1455",
            "alternate_url": "https://hh.ru/employer/1455",
            "vacancies_url": "https://api.hh.ru/vacancies?employer_id=1455",
            "open_vacancies": 19,
            "logo_urls": {
              "90":  "https://hh.ru/employer-logo/289027.png"
            }
        }
    ]
}
Имя Тип Описание
per_page number количество отображаемых на страницу элементов
page number номер отображаемой страницы
pages number количество страниц с данными
found number количество работодателей, найденных по переданному поисковому критерию
items array найденные работодатели (максимум per_page элементов)

Каждый элемент массива items содержит в себе короткое представление работодателя с дополнительным указанием количества открытых вакансий.

Имя Тип Описание
id string идентификатор работодателя
name string название работодателя
url string url для получения полного описания работодателя
alternate_url string ссылка на описание работодателя на сайте
vacancies_url string url для получения поисковой выдачи с вакансиями данной компании
open_vacancies number количество открытых вакансий у работодателя
logo_urls object или null логотипы компании

Ошибки

  • 400 Bad Request – ошибка в параметрах запроса. В теле ответа могут быть подробности того, в каком поле ошибка.

Работодатель / компания

GET /employers/{employer_id} возвращает данные о компании со ссылкой на выдачу вакансий этой компании.

Ответ

Успешный ответ приходит с кодом 200 OK и содержит тело:

{
    "name": "HeadHunter",
    "type": "company",
    "id": "1455",
    "site_url": "https://hh.ru",
    "description": "...",
    "branded_description": "<style>...</style><div>...</div><script></script>",
    "vacancies_url": "https://api.hh.ru/vacancies?employer_id=1455",
    "open_vacancies": 19,
    "trusted": true,
    "alternate_url": "https://hh.ru/employer/1455",
    "insider_interviews": [
        {
            "url": "https://hh.ru/interview/12345?employerId=1455",
            "id": "12345",
            "title": "Лучшие из лучших"
        },
        {
            "url": "https://hh.ru/interview/54321?employerId=1455",
            "id": "54321",
            "title": "История успеха"
        }
    ],
    "logo_urls": {
        "90": "https://hh.ru/employer-logo/289027.png",
        "240": "https://hh.ru/employer-logo/289169.png",
        "original": "https://hh.ru/file/2352807.png"
    },
    "area": {
        "url": "https://api.hh.ru/areas/113",
        "id": "113",
        "name": "Россия"
    },
    "relations": [],
    "industries": [
        {
            "id": "7.540",
            "name": "Разработка программного обеспечения"
        },
        {
            "id": "9.399",
            "name": "Мобильная связь"
        }
    ]
}
Имя Тип Описание
id string идентификатор компании
name string название компании
type string или null тип компании (прямой работодатель, кадровое агентство и т.п.). Возможные значения описаны в коллекции справочников под ключом employer_type. Возможно значение null, если тип компании скрыт.
site_url string адрес сайта компании
description string или null описание компании в виде строки с кодом HTML (без <script/> и <style/>)
branded_description string или null брендированное описание компании в виде строки с кодом HTML
vacancies_url string ссылка на поисковую выдачу вакансий данной компании.
open_vacancies number количество открытых вакансий у работодателя
trusted boolean флаг, показывающий, прошла ли компания проверку на сайте.
alternate_url string ссылка на представление компании на сайте
insider_interviews array список интервью или пустой список, если интервью отсутствуют
insider_interviews[].id string идентификатор интервью
insider_interviews[].title string заголовок интервью
insider_interviews[].url string адрес страницы, содержащей интервью
logo_urls object или null логотипы компании
area object информация о регионе работодателя
area.id string id региона из справочника
area.name string название региона
area.url string ссылка на информацию о регионе
relations array если работодатель добавлен в черный список, то вернется ['blacklisted'] иначе []
industries array Cписок отраслей компании. Элементы справочника индустрий.

Объект с именем и идентификатором

Имя Тип Описание
id string идентификатор поля
name string название поля

Брендированное описание компании

branded_description - строка с кодом HTML (возможно наличие <script/> и <style/>), которая является альтернативой стандартному описанию компании. HTML адаптирован для мобильных устройств и корректно отображается без поддержки javascript. При этом:

  • Контент тянется по ширине на 100% ширины контейнера и умещается без прокрутки в 300px.
  • Контент рассчитан на то, что он будет вставлен в обвязку, в которую входит название, логотип, сайт и ссылка на вакансии компании.
  • Изображения, которые могут встретиться в таком описании, адаптированы под retina-дисплеи.
  • Размер шрифта не меньше 12px, размер межстрочного интервала не меньше 16px.

Значение может быть null, если у компании отсутствует индивидуальное описание.

Логотипы компании

logo_urls — изображения логотипа компании разных размеров. original — это необработанный логотип, который может быть большого размера. Если изначально загруженный компанией логотип меньше, чем 240px и/или 90px по меньшей стороне, то в соответствующих ключах будут ссылки на изображения оригинального размера. Объект может быть null, если компания не загрузила логотип. Клиент должен предусмотреть возможность отсутствия логотипа по указанной ссылке (ответ с кодом 404 Not Found).

Ошибки

  • 404 Not Found - если компания не найдена