library.integration.mif.set

Scope: library

Кто может вызывать: Администратор.

Секреты не возвращаются — только secretApiKeySet.

HTTP: POST

Побочные эффекты: Настройки MIF + агенты.

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

Параметр Тип Обяз. Описание
active bool нет Включена интеграция. Алиасы: integration_lib_active
timeStart string нет Время запуска агента HH:MM. Алиасы: integration_lib_time_start
libId string нет ID библиотеки MIF. Алиасы: mif_lib_id
adminEmail string нет Email администратора. Алиасы: loginId, mif_login_id
url string нет URL API MIF. Алиасы: mif_url
secretApiKey string нет Секретный ключ (write-only). Алиасы: mif_secret_api_key
companyName string нет Название компании. Алиасы: mif_company_name
useDateExpired bool нет Учитывать срок активности книг. Алиасы: mif_use_date_expired

Возвращаемые данные

integrationId, active, timeStart, libId, adminEmail, url, secretApiKeySet, companyName, useDateExpired (без сырого секрета).

Обработка ошибок

Справочник кодов: error-codes.md.

Код Описание
PERMISSION_DENIED Только администратор
VALIDATION_ERROR Некорректный timeStart (details.field)

Пример запроса (POST)

curl -X POST "https://76590.dev.wehive.digital/rest/1/{webhook_code}/library.integration.mif.set.json"
          -H "Content-Type: application/json"
          -H "Accept: application/json"
          --data '{
          "active": false,
          "timeStart": "04:00",
          "libId": "lib-demo",
          "adminEmail": "admin@example.com",
          "url": "https://mif.example.com",
          "companyName": "Demo",
          "useDateExpired": true
        }'
        

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

{
          "result": {
            "result": {
              "integrationId": "MIF",
              "active": false,
              "timeStart": "04:00",
              "libId": "lib-demo",
              "adminEmail": "admin@example.com",
              "url": "https://mif.example.com",
              "secretApiKeySet": true,
              "companyName": "Demo",
              "useDateExpired": true
            },
            "error": null
          }
        }
        

См. также

Предыдущая