UserSide API Key UK: различия между версиями

Материал из WiKi - UserSide
([IronBot] Sync EN/UK localization from RU)
 
([IronBot] Fix UK localization text)
 
Строка 1: Строка 1:
[[UserSide_API_Key_EN|en]] | '''uk''' | [[UserSide_API_Key|ru]]
[[UserSide_API_Key_EN|en]] | '''uk''' | [[UserSide_API_Key|ru]]


An '''[[API_EN|API]]''' ERP ''UserSide'' and the interaction of external [[Modules_EN|modules]] requires an API key.
Для роботи '''[[API_UK|API]]''' ERP ''UserSide'' і взаємодії зовнішніх [[Модулі|модулів]] потрібен API-ключ.


The key is a completely arbitrary text string, but it cannot be empty.
Ключ - це довільний текстовий рядок, але він не може бути порожнім.


The API key configuration is shown below.
Нижче наведено налаштування API-ключа.


== From version 3.18 and newer ==
== Для версії 3.18 і новіших ==


In the main configuration file
В основному файлі конфігурації


For versions '''3.19 and above''':
Для версій '''3.19 і вище''':


  [USERSIDE_DIRECTORY]/legacy/Config/config.php
  [USERSIDE_DIRECTORY]/legacy/Config/config.php


For versions '''up to 3.19''':
Для версій '''до 3.19''':


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


add ''(or configure)'' a $apiKeyArray variable where you can configure access by key and IP address. You can also specify specific names of API sections that are allowed to be used with this key.
додайте ''(або налаштуйте)'' змінну $apiKeyArray, у якій можна налаштувати доступ за ключем та IP-адресою. Також можна вказати конкретні назви розділів API, які дозволено використовувати з цим ключем.


  $apiKeyArray = [
  $apiKeyArray = [
Строка 32: Строка 32:
             'customer',
             'customer',
             'node'
             'node'
             'employee/get_data', //For version 3.20 and above - specific partitions can be configured
             'employee/get_data', //Для версії 3.20 і вище можна налаштовувати конкретні розділи
         ]
         ]
     ]
     ]
  ];
  ];


IP addresses must be specified in text form. "*" - means the use of any IP-address. If you need to use several IP addresses for one key - then add new array elements. For example:
IP-адреси потрібно вказувати в текстовому вигляді. "*" означає використання будь-якої IP-адреси. Якщо для одного ключа потрібно використовувати кілька IP-адрес, додайте нові елементи масиву. Наприклад:


  $apiKeyArray = [
  $apiKeyArray = [
Строка 54: Строка 54:
             'customer',
             'customer',
             'node'
             'node'
             'employee/get_data', //For version 3.20 and above - specific partitions can be configured
             'employee/get_data', //Для версії 3.20 і вище можна налаштовувати конкретні розділи
         ]
         ]
     ],
     ],
Строка 67: Строка 67:
  ];
  ];


== For version 3.17 ==
== Для версії 3.17 ==


In the main configuration file ''[USERSIDE_DIRECTORY]/userside3/main/config/config.php'' add ''(or configure)'' a $apiKeyArray variable where you can configure access by key and IP address.
В основному файлі конфігурації ''[USERSIDE_DIRECTORY]/userside3/main/config/config.php'' додайте ''(або налаштуйте)'' змінну $apiKeyArray, у якій можна налаштувати доступ за ключем та IP-адресою.


  $apiKeyArray = [
  $apiKeyArray = [
Строка 82: Строка 82:
  ];
  ];


IP addresses must be specified in text form. "*" - means the use of any IP-address. If you need to use several IP addresses for one key - then add new array elements. For example:
IP-адреси потрібно вказувати в текстовому вигляді. "*" означає використання будь-якої IP-адреси. Якщо для одного ключа потрібно використовувати кілька IP-адрес, додайте нові елементи масиву. Наприклад:


  $apiKeyArray = [
  $apiKeyArray = [
Строка 103: Строка 103:
  ];
  ];


== For versions before 3.17 ==
== Для версій до 3.17 ==


In the main configuration file ''[USERSIDE_DIRECTORY]/userside3/main/config/config.php'' add ''(or customise)'' a $zapikey variable where you type in your key.
В основному файлі конфігурації ''[USERSIDE_DIRECTORY]/userside3/main/config/config.php'' додайте ''(або налаштуйте)'' змінну $zapikey, у якій вкажіть ваш ключ.


  $zapikey = 'key';
  $zapikey = 'key';

Текущая версия от 19:52, 23 мая 2026

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';
Источник — https://wiki.userside.eu/index.php?title=UserSide_API_Key_UK&oldid=21958