UserSide API Key

en | 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, что разрешается использовать с этим ключом. Параметр "is_read" доступен только с версии 3.21

$apiKeyArray = [
   [
       'key' => 'mainKey',
       'ip' => '*'
   ],
   [
       'key' => 'readKey',
       'ip' => '*',
       'is_read' => true
   ],
   [
       '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';