UserSide API Key UK

en | uk | ru

Для роботи API ERP UserSide і взаємодії зовнішніх модулів потрібен API-ключ.

Ключ - це довільний текстовий рядок, але він не може бути порожнім.

Нижче наведено налаштування API-ключа.

Для версії 3.18 і новіших

В основному файлі конфігурації

Для версій 3.19 і вище:

[USERSIDE_DIRECTORY]/legacy/Config/config.php

Для версій до 3.19:

[USERSIDE_DIRECTORY]/userside3/main/config/config.php

додайте (або налаштуйте) змінну $apiKeyArray, у якій можна налаштувати доступ за ключем та IP-адресою. Також можна вказати конкретні назви розділів API, які дозволено використовувати з цим ключем.

$apiKeyArray = [
   [
       'key' => 'mainKey',
       'ip' => '*'
   ],
   [
       'key' => 'key-local',
       'ip' => '127.0.0.1',
       'section' => [
           'customer',
           'node'
           'employee/get_data', //Для версії 3.20 і вище можна налаштовувати конкретні розділи
       ]
   ]
];

IP-адреси потрібно вказувати в текстовому вигляді. "*" означає використання будь-якої IP-адреси. Якщо для одного ключа потрібно використовувати кілька IP-адрес, додайте нові елементи масиву. Наприклад:

$apiKeyArray = [
   [
       'key' => 'mainKey',
       'ip' => '*'
   ],
   [
       'key' => 'key-local',
       'ip' => '127.0.0.1'
   ],
   [
       'key' => 'key-local',
       'ip' => '192.168.0.1',
       'section' => [
           'customer',
           'node'
           'employee/get_data', //Для версії 3.20 і вище можна налаштовувати конкретні розділи
       ]
   ],
   [
       'key' => 'key-local',
       'ip' => '192.168.0.50',
       'section' => [
           'task',
           'node'
       ]
   ]
];

Для версії 3.17

В основному файлі конфігурації [USERSIDE_DIRECTORY]/userside3/main/config/config.php додайте (або налаштуйте) змінну $apiKeyArray, у якій можна налаштувати доступ за ключем та IP-адресою.

$apiKeyArray = [
   [
       'key' => 'mainKey',
       'ip' => '*'
   ],
   [
       'key' => 'key-local',
       'ip' => '127.0.0.1'
   ]
];

IP-адреси потрібно вказувати в текстовому вигляді. "*" означає використання будь-якої IP-адреси. Якщо для одного ключа потрібно використовувати кілька IP-адрес, додайте нові елементи масиву. Наприклад:

$apiKeyArray = [
   [
       'key' => 'mainKey',
       'ip' => '*'
   ],
   [
       'key' => 'key-local',
       'ip' => '127.0.0.1'
   ],
   [
       'key' => 'key-local',
       'ip' => '192.168.0.1'
   ],
   [
       'key' => 'key-local',
       'ip' => '192.168.0.50'
   ]
];

Для версій до 3.17

В основному файлі конфігурації [USERSIDE_DIRECTORY]/userside3/main/config/config.php додайте (або налаштуйте) змінну $zapikey, у якій вкажіть ваш ключ.

$zapikey = 'key';