Skip to content

Latest commit

 

History

History
86 lines (69 loc) · 3.39 KB

employer_services.md

File metadata and controls

86 lines (69 loc) · 3.39 KB

Услуги API для работодателя

Информация по активным услугам API для платных методов

Для получения информации необходимо быть авторизованным под работодателем.

Запрос

GET /employers/{employer_id}/services/payable_api_actions/active

где employer_id - идентификатор работодателя, который можно узнать в информации о текущем пользователе.

Ответ

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

{
  "items": [
    {
      "id": "12345678",
      "service_type": {
        "id": "API_UNLIMITED",
        "name": "Доступ к API HH"
      },
      "activated_at": "2018-02-01T12:00:00+0300",
      "expires_at": "2019-01-31T12:00:00+0300",
      "balance": null
    },
    {
      "id": "12345680",
      "service_type": {
        "id": "API_LIMITED",
        "name": "Пакет запросов к API HH"
      },
      "activated_at": "2019-02-01T12:00:00+0300",
      "expires_at": "2020-01-31T12:00:00+0300",
      "balance": {
        "actual": 10000,
        "initial": 10000
      }
    }
  ]
}

Каждая подключенная услуга отображается отдельным объектом в массиве items, даже при условии, что подключено несколько услуг одного типа. Если у работодателя нет активных услуг, то в ответе придет пустой массив items.

Каждый элемент из items обладает следующими полями:

Имя Тип Описание
id строка Идентификатор услуги
service_type объект Тип услуги
activated_at строка Время активации услуги (в формате ISO 8601 с точностью до секунды YYYY-MM-DDThh:mm:ss±hhmm)
expires_at строка Время истечения услуги (в формате ISO 8601 с точностью до секунды YYYY-MM-DDThh:mm:ss±hhmm)
balance объект, null Значения баланса

Объект service_type

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

Объект balance

Баланс актуален для пакетных услуг.

Имя Тип Описание
initial число Значение баланса на момент активации услуги
actual число Текущее значение баланса

Ошибки

  • 403 Forbidden – текущий пользователь не является работодателем
  • 404 Not Found – указанный работодатель не существует
  • 404 Not Found – у текущего пользователя нет прав на просмотр информации