Bitrix API

Client

Table of Contents

Constants

HTTP_SOCKET_TIMEOUT  = 15
HTTP_STREAM_TIMEOUT  = 15
METHOD_APPLICATION_ADD  = 'application.add'
METHOD_APPLICATION_DELETE  = 'application.delete'
METHOD_APPLICATION_INSTALL  = 'application.install'
METHOD_APPLICATION_INSTALL_SUBSCRIPTION  = 'application.install.subscription'
METHOD_APPLICATION_LIST  = 'application.list'
METHOD_APPLICATION_STAT  = 'application.stat'
METHOD_APPLICATION_UNINSTALL  = 'application.uninstall'
METHOD_APPLICATION_UPDATE  = 'application.update'
METHOD_APPLICATION_USAGE  = 'application.usage.add'
METHOD_APPLICATION_VERSION_DELETE  = 'application.version.delete'
METHOD_APPLICATION_VERSION_UPDATE  = 'application.version.update'
METHOD_BATCH  = 'batch'
METHOD_METHODS  = 'methods'
METHOD_REST_AUTHORIZE  = 'rest.authorize'
METHOD_REST_CHECK  = 'rest.check'
METHOD_REST_CODE  = 'rest.code'
METHOD_REST_EVENT_CALL  = 'rest.event.call'
SERVICE_PATH  = "/rest/"
SERVICE_URL  = BITRIXREST_URL

Methods

__construct()  : mixed
addApplication()  : mixed
batch()  : mixed
call()  : bool|mixed
Low-level function for REST method call. Returns method response.
checkAuth()  : mixed
deleteApplication()  : mixed
getApplicationList()  : mixed
getAuth()  : mixed
getCode()  : mixed
installApplication()  : mixed
sendApplicationUsage()  : mixed
sendEvent()  : mixed
unInstallApplication()  : mixed
updateApplication()  : mixed

Constants

HTTP_SOCKET_TIMEOUT

public mixed HTTP_SOCKET_TIMEOUT = 15

HTTP_STREAM_TIMEOUT

public mixed HTTP_STREAM_TIMEOUT = 15

METHOD_APPLICATION_ADD

public mixed METHOD_APPLICATION_ADD = 'application.add'

METHOD_APPLICATION_DELETE

public mixed METHOD_APPLICATION_DELETE = 'application.delete'

METHOD_APPLICATION_INSTALL

public mixed METHOD_APPLICATION_INSTALL = 'application.install'

METHOD_APPLICATION_INSTALL_SUBSCRIPTION

public mixed METHOD_APPLICATION_INSTALL_SUBSCRIPTION = 'application.install.subscription'

METHOD_APPLICATION_LIST

public mixed METHOD_APPLICATION_LIST = 'application.list'

METHOD_APPLICATION_STAT

public mixed METHOD_APPLICATION_STAT = 'application.stat'

METHOD_APPLICATION_UNINSTALL

public mixed METHOD_APPLICATION_UNINSTALL = 'application.uninstall'

METHOD_APPLICATION_UPDATE

public mixed METHOD_APPLICATION_UPDATE = 'application.update'

METHOD_APPLICATION_USAGE

public mixed METHOD_APPLICATION_USAGE = 'application.usage.add'

METHOD_APPLICATION_VERSION_DELETE

public mixed METHOD_APPLICATION_VERSION_DELETE = 'application.version.delete'

METHOD_APPLICATION_VERSION_UPDATE

public mixed METHOD_APPLICATION_VERSION_UPDATE = 'application.version.update'

METHOD_BATCH

public mixed METHOD_BATCH = 'batch'

METHOD_METHODS

public mixed METHOD_METHODS = 'methods'

METHOD_REST_AUTHORIZE

public mixed METHOD_REST_AUTHORIZE = 'rest.authorize'

METHOD_REST_CHECK

public mixed METHOD_REST_CHECK = 'rest.check'

METHOD_REST_CODE

public mixed METHOD_REST_CODE = 'rest.code'

METHOD_REST_EVENT_CALL

public mixed METHOD_REST_EVENT_CALL = 'rest.event.call'

SERVICE_PATH

public mixed SERVICE_PATH = "/rest/"

SERVICE_URL

public mixed SERVICE_URL = BITRIXREST_URL

Methods

__construct()

public __construct(mixed $clientId, mixed $clientSecret, mixed $licenseKey) : mixed
Parameters
$clientId : mixed
$clientSecret : mixed
$licenseKey : mixed

addApplication()

public addApplication(array<string|int, mixed> $applicationSettings) : mixed
Parameters
$applicationSettings : array<string|int, mixed>

batch()

public batch(mixed $actions) : mixed
Parameters
$actions : mixed

call()

Low-level function for REST method call. Returns method response.

public call(string $methodName[, array<string|int, mixed>|null $additionalParams = null ][, bool|false $licenseCheck = false ]) : bool|mixed
Parameters
$methodName : string

Method name.

$additionalParams : array<string|int, mixed>|null = null

Method params.

$licenseCheck : bool|false = false

Send license key in request (will be sent automatically on verification_needed error).

Tags
throws
SystemException
Return values
bool|mixed

checkAuth()

public checkAuth(mixed $accessToken) : mixed
Parameters
$accessToken : mixed

deleteApplication()

public deleteApplication(array<string|int, mixed> $applicationSettings) : mixed
Parameters
$applicationSettings : array<string|int, mixed>

getApplicationList()

public getApplicationList() : mixed

getAuth()

public getAuth(mixed $clientId, mixed $scope[, array<string|int, mixed> $additionalParams = array() ]) : mixed
Parameters
$clientId : mixed
$scope : mixed
$additionalParams : array<string|int, mixed> = array()

getCode()

public getCode(mixed $clientId, mixed $state, mixed $additionalParams) : mixed
Parameters
$clientId : mixed
$state : mixed
$additionalParams : mixed

installApplication()

public installApplication(array<string|int, mixed> $applicationSettings) : mixed
Parameters
$applicationSettings : array<string|int, mixed>

sendApplicationUsage()

public sendApplicationUsage(array<string|int, mixed> $usage) : mixed
Parameters
$usage : array<string|int, mixed>

sendEvent()

public sendEvent(array<string|int, mixed> $eventItems) : mixed
Parameters
$eventItems : array<string|int, mixed>

unInstallApplication()

public unInstallApplication(array<string|int, mixed> $applicationSettings) : mixed
Parameters
$applicationSettings : array<string|int, mixed>

updateApplication()

public updateApplication(array<string|int, mixed> $applicationSettings) : mixed
Parameters
$applicationSettings : array<string|int, mixed> 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results