API EN - История изменений

Admin: /* Categories */

2026-03-23T10:56:48Z

N.Skrypnik в 15:34, 1 ноября 2024

2024-11-01T15:34:56Z

← Предыдущая версия		Версия от 15:34, 1 ноября 2024
Строка 52:		Строка 52:
	* [[API device_EN\|device]] - Equipment		* [[API device_EN\|device]] - Equipment
	* [[API employee_EN\|employee]] - Employees ''(since 3.16dev2)'''		* [[API employee_EN\|employee]] - Employees ''(since 3.16dev2)'''
	* [[~~API fibre_EN~~\|fiber]] - Cable lines		* [[API_fiber_EN\|fiber]] - Cable lines
	* [[API gps_EN\|gps]] - GPS trackers		* [[API gps_EN\|gps]] - GPS trackers
	* [[API inventory_EN\|inventory]] - Warehouse		* [[API inventory_EN\|inventory]] - Warehouse

N.Skrypnik в 14:58, 16 августа 2024

2024-08-16T14:58:54Z

← Предыдущая версия		Версия от 14:58, 16 августа 2024
Строка 49:		Строка 49:
	* [[API cross_EN\|cross]] - ODF/Crosses		* [[API cross_EN\|cross]] - ODF/Crosses
	* [[API customer_EN\|customer]] - Users. Most actions are relevant for [[Supported_billings\|manual billing]]		* [[API customer_EN\|customer]] - Users. Most actions are relevant for [[Supported_billings\|manual billing]]
			* [[API cwdm_EN\|cwdm]] - CWDM
	* [[API device_EN\|device]] - Equipment		* [[API device_EN\|device]] - Equipment
	* [[API employee_EN\|employee]] - Employees ''(since 3.16dev2)'''		* [[API employee_EN\|employee]] - Employees ''(since 3.16dev2)'''

N.Skrypnik в 15:13, 30 октября 2023

2023-10-30T15:13:09Z

← Предыдущая версия		Версия от 15:13, 30 октября 2023
Строка 36:		Строка 36:
	== Basic setting ==		== Basic setting ==

	Configure the [[~~UserSide API Key~~\|API Key]].		Configure the [[UserSide_API_Key_EN\|API Key]].

	== Categories ==		== Categories ==

N.Skrypnik в 14:58, 1 августа 2023

2023-08-01T14:58:47Z

← Предыдущая версия		Версия от 14:58, 1 августа 2023
Строка 48:		Строка 48:
	* [[API commutation_EN\|commutation]] - Commutation of objects		* [[API commutation_EN\|commutation]] - Commutation of objects
	* [[API cross_EN\|cross]] - ODF/Crosses		* [[API cross_EN\|cross]] - ODF/Crosses
	* [[API customer_EN\|customer]] - Users. Most actions are relevant for [[~~Supported billing~~\|manual billing]]		* [[API customer_EN\|customer]] - Users. Most actions are relevant for [[Supported_billings\|manual billing]]
	* [[API device_EN\|device]] - Equipment		* [[API device_EN\|device]] - Equipment
	* [[API employee_EN\|employee]] - Employees ''(since 3.16dev2)'''		* [[API employee_EN\|employee]] - Employees ''(since 3.16dev2)'''

N.Skrypnik в 16:44, 13 июля 2023

2023-07-13T16:44:36Z

← Предыдущая версия		Версия от 16:44, 13 июля 2023
Строка 21:		Строка 21:
	customer_id - user id of the customer		customer_id - user id of the customer
	is_potential - flag. It can take the value 1 or 0. Most flags have the prefix '''is'''.		is_potential - flag. It can take the value 1 or 0. Most flags have the prefix '''is'''.

	Example request:		Example request:
	api.php?key=apikey&cat=abon&action=msg&usercode=1		api.php?key=apikey&cat=abon&action=msg&usercode=1

N.Skrypnik в 16:43, 13 июля 2023

2023-07-13T16:43:27Z

← Предыдущая версия		Версия от 16:43, 13 июля 2023
Строка 18:		Строка 18:
	skip_internal_api - flag - do not include internal system triggers ''(reasonable to use when your API method is a reaction to some trigger and it ends up looping itself during normal operation)''		skip_internal_api - flag - do not include internal system triggers ''(reasonable to use when your API method is a reaction to some trigger and it ends up looping itself during normal operation)''
	Other additional parameters, depending on the category ''(see below in the relevant categories)''.		Other additional parameters, depending on the category ''(see below in the relevant categories)''.
	For example:		For example:
	customer_id - user id of the customer		customer_id - user id of the customer
	is_potential - flag. It can take the value 1 or 0. Most flags have the prefix '''is'''.		is_potential - flag. It can take the value 1 or 0. Most flags have the prefix '''is'''.

N.Skrypnik в 16:42, 13 июля 2023

2023-07-13T16:42:13Z

← Предыдущая версия		Версия от 16:42, 13 июля 2023
Строка 1:		Строка 1:
	[[API_EN\|en]] \| [[API\|ru]]		[[API_EN\|en]] \| [[API\|ru]]

			This section describes the possibilities of using the inbuilt API in ERP "UserSide", which allows you to use the integrated functionality in your own projects.

			The API does not cover all functionality at the moment and is gradually being developed, so this page will have frequent changes and additions.

			== Operating principle ==

			The /api.php file is responsible for interaction.

			Both GET and POST requests can be used.

			Incoming Parameters:
			Mandatory:
			key - API key
			cat - category of the request
			Optional:
			skip_internal_api - flag - do not include internal system triggers ''(reasonable to use when your API method is a reaction to some trigger and it ends up looping itself during normal operation)''
			Other additional parameters, depending on the category ''(see below in the relevant categories)''.
			For example:
			customer_id - user id of the customer
			is_potential - flag. It can take the value 1 or 0. Most flags have the prefix '''is'''.

			Example request:
			api.php?key=apikey&cat=abon&action=msg&usercode=1

			Returned data:
			If the query involves some action or information return, information will be returned in JSON format:
			array(
			[Result] => OK / ERROR
			[ErrorText] => In case of an error, the error text
			)

			It is also reasonable to check the HTTP code of the response. In case of errors/incorrect requests - HTTP code will be different from 200

			== Basic setting ==

			Configure the [[UserSide API Key\|API Key]].

			== Categories ==
			* [[API address_EN\|address]] - Addresses
			* [[API attach_EN\|attach]] - Attachments
			* [[API additional_data_EN\|additional_data]] - Additional fields/data for objects
			* [[API advertising_EN\|advertising]] - Advertising campaigns
			* [[API billing_EN\|billing]] - Billing
			* [[API cable_route_EN\|cable_route]] - Cable routes and channels
			* [[API call_EN\|call]] - Calls
			* [[API commutation_EN\|commutation]] - Commutation of objects
			* [[API cross_EN\|cross]] - ODF/Crosses
			* [[API customer_EN\|customer]] - Users. Most actions are relevant for [[Supported billing\|manual billing]]
			* [[API device_EN\|device]] - Equipment
			* [[API employee_EN\|employee]] - Employees ''(since 3.16dev2)'''
			* [[API fibre_EN\|fiber]] - Cable lines
			* [[API gps_EN\|gps]] - GPS trackers
			* [[API inventory_EN\|inventory]] - Warehouse
			* [[API key_EN\|key]] - Keys
			* [[API map_EN\|map]] - Coverage maps
			* [[API module_EN\|module]] - External requests from modules
			* [[API newin_EN\|newin]] - Connection request
			* [[API node_EN\|node]] - Communication facilities ''(communication nodes, fiber optical junction boxes, poles, manholes)'''
			* [[API notepad_EN\|notepad]] - Notepad
			* [[API operator_EN\|operator]] - system operators ''( before 3.16dev2)'''
			* [[API owner_EN\|owner]] - Object Owners
			* [[API redirect_EN\|redirect]] - Redirects to an object card based on some attribute
			* [[API service_EN\|service]] - Additional services
			* [[API setting_EN\|setting]] - Setting
			* [[API sms_EN\|sms]] - SMS messages
			* [[API splitter_EN\|splitter]] - dividers/splitters
			* [[API staff_EN\|staff]] - Staff ''(up to 3.16dev2)'''
			* [[API system_EN\|system]] - System information and operations
			* [[API tariff_EN\|tariff]] - Tariffs
			* [[API task_EN\|task]] - Tasks
			* [[API trader_EN\|trader]] - Vendors
			* [[API vehicle_EN\|vehicle]] - Vehicles
			* [[API vlan_EN\|vlan]] - Vlan

N.Skrypnik: Новая страница: «en | ru»

2023-07-13T14:51:11Z

Новая страница: «en | ru»

Новая страница

[[API_EN|en]] | [[API|ru]]

← Предыдущая версия		Версия от 10:56, 23 марта 2026
Строка 58:		Строка 58:
	* [[API map_EN\|map]] - Coverage maps		* [[API map_EN\|map]] - Coverage maps
	* [[API module_EN\|module]] - External requests from modules		* [[API module_EN\|module]] - External requests from modules
	* [[API newin_EN\|newin]] - Connection request		* [[API newin_EN\|newin]] - Connection request ''( before 3.18)'''
	* [[API node_EN\|node]] - Communication facilities ''(communication nodes, fiber optical junction boxes, poles, manholes)'''		* [[API node_EN\|node]] - Communication facilities ''(communication nodes, fiber optical junction boxes, poles, manholes)'''
	* [[API notepad_EN\|notepad]] - Notepad		* [[API notepad_EN\|notepad]] - Notepad

← Предыдущая версия		Версия от 15:34, 1 ноября 2024
Строка 52:		Строка 52:
	* [[API device_EN\|device]] - Equipment		* [[API device_EN\|device]] - Equipment
	* [[API employee_EN\|employee]] - Employees ''(since 3.16dev2)'''		* [[API employee_EN\|employee]] - Employees ''(since 3.16dev2)'''
	* [[~~API fibre_EN~~\|fiber]] - Cable lines		* [[API_fiber_EN\|fiber]] - Cable lines
	* [[API gps_EN\|gps]] - GPS trackers		* [[API gps_EN\|gps]] - GPS trackers
	* [[API inventory_EN\|inventory]] - Warehouse		* [[API inventory_EN\|inventory]] - Warehouse

← Предыдущая версия		Версия от 14:58, 16 августа 2024
Строка 49:		Строка 49:
	* [[API cross_EN\|cross]] - ODF/Crosses		* [[API cross_EN\|cross]] - ODF/Crosses
	* [[API customer_EN\|customer]] - Users. Most actions are relevant for [[Supported_billings\|manual billing]]		* [[API customer_EN\|customer]] - Users. Most actions are relevant for [[Supported_billings\|manual billing]]
			* [[API cwdm_EN\|cwdm]] - CWDM
	* [[API device_EN\|device]] - Equipment		* [[API device_EN\|device]] - Equipment
	* [[API employee_EN\|employee]] - Employees ''(since 3.16dev2)'''		* [[API employee_EN\|employee]] - Employees ''(since 3.16dev2)'''

← Предыдущая версия		Версия от 14:58, 1 августа 2023
Строка 48:		Строка 48:
	* [[API commutation_EN\|commutation]] - Commutation of objects		* [[API commutation_EN\|commutation]] - Commutation of objects
	* [[API cross_EN\|cross]] - ODF/Crosses		* [[API cross_EN\|cross]] - ODF/Crosses
	* [[API customer_EN\|customer]] - Users. Most actions are relevant for [[~~Supported billing~~\|manual billing]]		* [[API customer_EN\|customer]] - Users. Most actions are relevant for [[Supported_billings\|manual billing]]
	* [[API device_EN\|device]] - Equipment		* [[API device_EN\|device]] - Equipment
	* [[API employee_EN\|employee]] - Employees ''(since 3.16dev2)'''		* [[API employee_EN\|employee]] - Employees ''(since 3.16dev2)'''

← Предыдущая версия		Версия от 16:42, 13 июля 2023
Строка 1:		Строка 1:
	[[API_EN\|en]] \| [[API\|ru]]		[[API_EN\|en]] \| [[API\|ru]]

			This section describes the possibilities of using the inbuilt API in ERP "UserSide", which allows you to use the integrated functionality in your own projects.

			The API does not cover all functionality at the moment and is gradually being developed, so this page will have frequent changes and additions.

			== Operating principle ==

			The /api.php file is responsible for interaction.

			Both GET and POST requests can be used.

			Incoming Parameters:
			Mandatory:
			key - API key
			cat - category of the request
			Optional:
			skip_internal_api - flag - do not include internal system triggers ''(reasonable to use when your API method is a reaction to some trigger and it ends up looping itself during normal operation)''
			Other additional parameters, depending on the category ''(see below in the relevant categories)''.
			For example:
			customer_id - user id of the customer
			is_potential - flag. It can take the value 1 or 0. Most flags have the prefix '''is'''.

			Example request:
			api.php?key=apikey&cat=abon&action=msg&usercode=1

			Returned data:
			If the query involves some action or information return, information will be returned in JSON format:
			array(
			[Result] => OK / ERROR
			[ErrorText] => In case of an error, the error text
			)

			It is also reasonable to check the HTTP code of the response. In case of errors/incorrect requests - HTTP code will be different from 200

			== Basic setting ==

			Configure the [[UserSide API Key\|API Key]].

			== Categories ==
			* [[API address_EN\|address]] - Addresses
			* [[API attach_EN\|attach]] - Attachments
			* [[API additional_data_EN\|additional_data]] - Additional fields/data for objects
			* [[API advertising_EN\|advertising]] - Advertising campaigns
			* [[API billing_EN\|billing]] - Billing
			* [[API cable_route_EN\|cable_route]] - Cable routes and channels
			* [[API call_EN\|call]] - Calls
			* [[API commutation_EN\|commutation]] - Commutation of objects
			* [[API cross_EN\|cross]] - ODF/Crosses
			* [[API customer_EN\|customer]] - Users. Most actions are relevant for [[Supported billing\|manual billing]]
			* [[API device_EN\|device]] - Equipment
			* [[API employee_EN\|employee]] - Employees ''(since 3.16dev2)'''
			* [[API fibre_EN\|fiber]] - Cable lines
			* [[API gps_EN\|gps]] - GPS trackers
			* [[API inventory_EN\|inventory]] - Warehouse
			* [[API key_EN\|key]] - Keys
			* [[API map_EN\|map]] - Coverage maps
			* [[API module_EN\|module]] - External requests from modules
			* [[API newin_EN\|newin]] - Connection request
			* [[API node_EN\|node]] - Communication facilities ''(communication nodes, fiber optical junction boxes, poles, manholes)'''
			* [[API notepad_EN\|notepad]] - Notepad
			* [[API operator_EN\|operator]] - system operators ''( before 3.16dev2)'''
			* [[API owner_EN\|owner]] - Object Owners
			* [[API redirect_EN\|redirect]] - Redirects to an object card based on some attribute
			* [[API service_EN\|service]] - Additional services
			* [[API setting_EN\|setting]] - Setting
			* [[API sms_EN\|sms]] - SMS messages
			* [[API splitter_EN\|splitter]] - dividers/splitters
			* [[API staff_EN\|staff]] - Staff ''(up to 3.16dev2)'''
			* [[API system_EN\|system]] - System information and operations
			* [[API tariff_EN\|tariff]] - Tariffs
			* [[API task_EN\|task]] - Tasks
			* [[API trader_EN\|trader]] - Vendors
			* [[API vehicle_EN\|vehicle]] - Vehicles
			* [[API vlan_EN\|vlan]] - Vlan