Bitrix API

Rest

Table of Contents

Methods

getApplicationClientId()  : string|null
Returns REST Application Client id by Application code.
getApplicationCode()  : string|null
Returns REST Application code by id (you can take this during REST execution).
getAuthInfo()  : array<string|int, mixed>|null
Returns Application's auth information.
getMarketKits()  : array<string|int, mixed>
Returns all Market Kits keys.
installMarketKit()  : void
Install Market kit (set of applications) by kit code.
isApplicationExpired()  : bool
Returns true if REST application is expired.
isMarketKitInstalled()  : bool
Checks that Market kit (set of applications) is installed.

Methods

getApplicationClientId()

Returns REST Application Client id by Application code.

public static getApplicationClientId(string $applicationCode) : string|null
Parameters
$applicationCode : string

REST Application code.

Return values
string|null

getApplicationCode()

Returns REST Application code by id (you can take this during REST execution).

public static getApplicationCode(string|null $applicationId) : string|null
Parameters
$applicationId : string|null

REST Application id.

Return values
string|null

getAuthInfo()

Returns Application's auth information.

public static getAuthInfo(string $applicationCode) : array<string|int, mixed>|null
Parameters
$applicationCode : string

Application code.

Return values
array<string|int, mixed>|null

getMarketKits()

Returns all Market Kits keys.

public static getMarketKits() : array<string|int, mixed>
Return values
array<string|int, mixed>

installMarketKit()

Install Market kit (set of applications) by kit code.

public static installMarketKit(string $kitCode[, Error|null &$error = null ]) : void
Parameters
$kitCode : string

Kit code.

$error : Error|null = null

Error instance for getting error if occurred.

isApplicationExpired()

Returns true if REST application is expired.

public static isApplicationExpired(string $applicationCode) : bool
Parameters
$applicationCode : string

Application code.

Return values
bool

isMarketKitInstalled()

Checks that Market kit (set of applications) is installed.

public static isMarketKitInstalled(string $kitCode) : bool
Parameters
$kitCode : string

Kit code.

Return values
bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results