Bitrix API

RestClient

Table of Contents

Constants

ERROR_NOTHING_FOUND  = 4
ERROR_SERVICE_UNAVAILABLE  = 3
ERROR_WRONG_INPUT  = 1
ERROR_WRONG_LICENSE  = 2
REGISTER_URI  = '/oauth/register/'
REST_URI  = '/rest/'
SCOPE  = 'sale'
SERVICE_ACCESS_OPTION  = 'saleservices_access'
UNSUCCESSFUL_CALL_OPTION  = 'sale_hda_last_unsuccessful_call'
UNSUCCESSFUL_CALL_TRYINGS  = 3
UNSUCCESSFUL_CALL_WAIT_INTERVAL  = 300

Methods

clearAccessSettings()  : void
Drops current stored access credentials.
getServiceHost()  : string
isServerAlive()  : bool
Check if server is alive.
signLicenseRequest()  : mixed

Constants

ERROR_NOTHING_FOUND

public mixed ERROR_NOTHING_FOUND = 4

ERROR_SERVICE_UNAVAILABLE

public mixed ERROR_SERVICE_UNAVAILABLE = 3

ERROR_WRONG_INPUT

public mixed ERROR_WRONG_INPUT = 1

ERROR_WRONG_LICENSE

public mixed ERROR_WRONG_LICENSE = 2

REGISTER_URI

public mixed REGISTER_URI = '/oauth/register/'

SERVICE_ACCESS_OPTION

public mixed SERVICE_ACCESS_OPTION = 'saleservices_access'

UNSUCCESSFUL_CALL_OPTION

public mixed UNSUCCESSFUL_CALL_OPTION = 'sale_hda_last_unsuccessful_call'

UNSUCCESSFUL_CALL_TRYINGS

public mixed UNSUCCESSFUL_CALL_TRYINGS = 3

UNSUCCESSFUL_CALL_WAIT_INTERVAL

public mixed UNSUCCESSFUL_CALL_WAIT_INTERVAL = 300

Methods

clearAccessSettings()

Drops current stored access credentials.

public clearAccessSettings() : void

getServiceHost()

public getServiceHost() : string
Return values
string

Host. Define const SALE_SRVS_RESTCLIENT_SRV_HOST to change server host.

isServerAlive()

Check if server is alive.

public static isServerAlive() : bool
Return values
bool

signLicenseRequest()

public static signLicenseRequest(array<string|int, mixed> $request, mixed $licenseKey) : mixed
Parameters
$request : array<string|int, mixed>
$licenseKey : mixed

        
On this page

Search results