library.integration.alpina.set

Scope: library

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

Флаги apiKeySet, apiSecretSet вместо секретов.

HTTP: POST

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

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

Параметр Тип Обяз. Описание
active bool нет Включена. Алиасы: integration_lib_active
timeStart string нет HH:MM. Алиасы: integration_lib_time_start
apiKey string нет API Key. Алиасы: alpina_api_key
apiSecret string нет API Secret. Алиасы: alpina_api_secret
apiAddress string нет Адрес API. Алиасы: alpina_api_address
storeAddress string нет Адрес хранилища. Алиасы: alpina_api_store_address

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

integrationId, active, timeStart, apiKeySet, apiSecretSet, apiAddress, storeAddress.

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

Справочник кодов: 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.alpina.set.json"
          -H "Content-Type: application/json"
          -H "Accept: application/json"
          --data '{
          "active": false,
          "timeStart": "03:00",
          "apiAddress": "https://api.example.com",
          "storeAddress": "https://store.example.com"
        }'
        

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

{
          "result": {
            "result": {
              "integrationId": "ALPINA",
              "active": false,
              "timeStart": "03:00",
              "apiKeySet": true,
              "apiSecretSet": true,
              "apiAddress": "https://api.example.com",
              "storeAddress": "https://store.example.com"
            },
            "error": null
          }
        }
        

См. также

Предыдущая
Следующая