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

Версия от 12:17, 10 мая 2026

en | uk | ru

This section describes how to use the built-in ERP "UserSide" API in your own projects.

The API does not currently cover all functionality and is being expanded gradually, so this page may change frequently.

Operating principle

The /api.php file is responsible for interaction.

Both GET and POST requests can be used.

Input parameters:
Required:
 key - API key
 cat - request category
Optional:
 skip_internal_api - flag - do not run internal system triggers (useful when an API method is called from a trigger and would otherwise trigger itself during normal operation)
Other additional parameters, depending on the category (see below in the relevant categories). 
For example:
 customer_id - customer id
 is_potential - flag. It can be 1 or 0. Most flags use the is prefix.

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

Returned data:
 If the request performs an action or returns data, the response is returned in JSON format:
  array(
   [Result] => OK / ERROR
   [ErrorText] => Error text, if an error occurred
  )

Also check the HTTP response code. For errors or invalid requests, the HTTP code will differ from 200.

Basic setup

Configure the API Key.

@@ Строка 36: / Строка 36: @@
 == Basic setup ==
-Configure the [[UserSide_API_Key_EN|API Key]].
+Configure the [[UserSide_API_Key|API Key]].
 == Categories ==
@@ Строка 49: / Строка 49: @@
 * [[API_commutation_EN|commutation]] - Commutation of objects
 * [[API_cross_EN|cross]] - Distribution frames
-* [[API_customer_EN|customer]] - Customers. Most actions are relevant for [[Supported_billings_EN|manual billing]]
+* [[API_customer_EN|customer]] - Customers. Most actions are relevant for [[Supported_billings|manual billing]]
 * [[API_cwdm_EN|cwdm]] - CWDM
 * [[API_device_EN|device]] - Equipment