Поддержка серверов

REST: методы, функции, константы класса Битрикс


Блог разработчика

9 августа 2016 ResizeImageGet и простой водяной знак налету

Сегодня поговорим о том как проще всего воткнуть водяной знак на картинки в Битрикс. Например, на все изображения каталога.

21 июля 2016 Добавление вкладки в CRM коробки Битрикс24

В этом посте я покажу, как легко и просто добавить вкладку в сущность CRM. И не просто добавить, а вывести там свой контент.

21 июля 2016 Как просто обращаться из коробки Битрикс24 на сайт на базе Битрикс

К примеру вам хочется внутренним скриптом дернуть с сайта-магазина информацию, которая там, в свою очередь, закрыта некоторыми правами. Например, админскими. Можно конечно мутить свой REST, или иной формат общения, но проще всего воспользоваться штатным инструментом:

События модуля rest

СобытиеВызывается
OnAfterAppPaidAppTable::callAppPaymentEvent
OnRestAppDeleteCRestUtil::CleanApp
OnRestAppInfoCRestProvider::appInfo
OnRestAppInstallAppTable::install
OnRestAppMethodConfirmNotifyIm::receive
OnRestAppTestEvent::eventTest
OnRestAppUpdateCRestUtil::UpdateApp
OnRestCheckAuthCRestUtil::checkAuth
OnRestServiceBuildDescriptionCRestProvider::getDescription
onFindMethodDescriptionCRestServer::getMethodDescription

Константы модуля rest

КонстантаПроверяется
BX_COMP_MANAGED_CACHEAppTable::setAccess
REST_APAUTH_ALLOW_HTTPAuth::onRestCheckAuth

Список функций и методов модуля rest

Метод
AccessException::__construct()
AppConfiguration::checkRequiredParams()
AppConfiguration::clearApp()
AppConfiguration::exportApp()
AppConfiguration::getEntityList()
AppConfiguration::getManifestList()
AppConfiguration::importApp()
AppConfiguration::onEventClearController()
AppConfiguration::onEventExportController()
AppConfiguration::onEventImportController()
AppLangTable::deleteByApp()
AppLangTable::getMap()
AppLangTable::getTableName()
AppLangTable::validateLanguageId()
AppLangTable::validateMenuName()
AppLogTable::getMap()
AppLogTable::getTableName()
AppLogTable::log()
AppTable::callAppPaymentEvent()
AppTable::canUninstallByType()
AppTable::checkUninstallAvailability()
AppTable::cleanLocalPermissionList()
AppTable::clearClientCache()
AppTable::getAccess()
AppTable::getAppStatusInfo()
AppTable::getAppType()
AppTable::getByClientId()
AppTable::getLicenseLanguage()
AppTable::getMap()
AppTable::getTableName()
AppTable::install()
AppTable::onAfterAdd()
AppTable::onAfterDelete()
AppTable::onAfterUpdate()
AppTable::onBeforeAdd()
AppTable::onDelete()
AppTable::setAccess()
AppTable::setSkipRemoteUpdate()
AppTable::uninstall()
AppTable::updateAppStatusInfo()
AppTable::validateAccess()
AppTable::validateAppName()
AppTable::validateClientId()
AppTable::validateClientSecret()
AppTable::validateCode()
AppTable::validateScope()
AppTable::validateSharedKey()
AppTable::validateUrl()
AppTable::validateUrlDemo()
AppTable::validateUrlInstall()
AppTable::validateVersion()
Application::generateAppPassword()
Application::getAuthProvider()
Application::getDefaultAuthProvider()
Application::initialize()
Application::onApplicationsBuildList()
Application::setAuthProvider()
Auth::authorizeClient()
Auth::check()
Auth::checkCookieAuth()
Auth::checkHttpAuth()
Auth::checkOldPassword()
Auth::checkPermission()
Auth::convertOldPassword()
Auth::get()
Auth::getAuthKey()
Auth::getPasswordScope()
Auth::getStorage()
Auth::getTokenParams()
Auth::isAccessAllowed()
Auth::onRestCheckAuth()
Auth::requireHttpAuth()
Auth::setLastActivityDate()
Auth::setStorage()
Auth::storeRegisteredAuth()
Auth::updateTokenParameters()
Base::checkArguments()
Base::checkFieldsAdd()
Base::checkFieldsList()
Base::checkFieldsUpdate()
Base::checkRequiredFields()
Base::checkRequiredFieldsAdd()
Base::checkRequiredFieldsUpdate()
Base::convertKeysToCamelCase()
Base::convertKeysToSnakeCase()
Base::convertKeysToSnakeCaseArguments()
Base::convertKeysToSnakeCaseFields()
Base::convertKeysToSnakeCaseFilter()
Base::convertKeysToSnakeCaseOrder()
Base::convertKeysToSnakeCaseSelect()
Base::externalizeDateTimeValue()
Base::externalizeDateValue()
Base::externalizeExtendedTypeValue()
Base::externalizeFields()
Base::externalizeFieldsGet()
Base::externalizeFileValue()
Base::externalizeListFields()
Base::externalizeResult()
Base::externalizeValue()
Base::getListFieldInfo()
Base::internalizeArguments()
Base::internalizeDate()
Base::internalizeDateTime()
Base::internalizeDateTimeValue()
Base::internalizeDateValue()
Base::internalizeExtendedTypeValue()
Base::internalizeFields()
Base::internalizeFieldsAdd()
Base::internalizeFieldsList()
Base::internalizeFieldsUpdate()
Base::internalizeFileValue()
Base::internalizeFilterFields()
Base::internalizeListFields()
Base::internalizeOrderFields()
Base::internalizeSelectFields()
Base::internalizeValue()
Base::parserFileValue()
Base::prepareFieldAttributs()
Base::prepareFieldInfos()
CBitrixRestEntity::Clean()
CBitrixRestEntity::OnRestServiceBuildDescription()
CBitrixRestEntity::checkEntity()
CBitrixRestEntity::checkFilter()
CBitrixRestEntity::checkIblockType()
CBitrixRestEntity::checkItemParams()
CBitrixRestEntity::checkItemProperty()
CBitrixRestEntity::checkItemPropertyParams()
CBitrixRestEntity::checkParams()
CBitrixRestEntity::checkRights()
CBitrixRestEntity::checkSectionFilter()
CBitrixRestEntity::checkSectionParams()
CBitrixRestEntity::entityAdd()
CBitrixRestEntity::entityDelete()
CBitrixRestEntity::entityGet()
CBitrixRestEntity::entityItemAdd()
CBitrixRestEntity::entityItemDelete()
CBitrixRestEntity::entityItemGet()
CBitrixRestEntity::entityItemPropertyAdd()
CBitrixRestEntity::entityItemPropertyDelete()
CBitrixRestEntity::entityItemPropertyGet()
CBitrixRestEntity::entityItemPropertyUpdate()
CBitrixRestEntity::entityItemUpdate()
CBitrixRestEntity::entityRights()
CBitrixRestEntity::entitySectionAdd()
CBitrixRestEntity::entitySectionDelete()
CBitrixRestEntity::entitySectionGet()
CBitrixRestEntity::entitySectionUpdate()
CBitrixRestEntity::entityUpdate()
CBitrixRestEntity::getEntityIBlockCode()
CBitrixRestEntity::getFile()
CBitrixRestEntity::getIBlock()
CBitrixRestEntity::getIBlockType()
CBitrixRestEntity::getIBlocks()
CBitrixRestEntity::getItemProperties()
CBitrixRestEntity::getItemProperty()
CBitrixRestEntity::parseEntity()
CBitrixRestEntity::prepareItem()
CBitrixRestEntity::prepareSection()
CRestEventCallback::__callStatic()
CRestEventHandlers::OnBeforeProlog()
CRestEventSession::Get()
CRestEventSession::Set()
CRestProvider::OnAppEvent()
CRestProvider::OnAppPayment()
CRestProvider::appInfo()
CRestProvider::appOptionGet()
CRestProvider::appOptionSet()
CRestProvider::getApp()
CRestProvider::getBitrix24LicenseName()
CRestProvider::getDescription()
CRestProvider::getProfile()
CRestProvider::getScope()
CRestProvider::getServerTime()
CRestProvider::methodsBatch()
CRestProvider::methodsList()
CRestProvider::scopeList()
CRestProvider::userOptionGet()
CRestProvider::userOptionSet()
CRestServer::__construct()
CRestServer::appendDebugInfo()
CRestServer::canUseConnectors()
CRestServer::checkAuth()
CRestServer::checkScope()
CRestServer::checkSite()
CRestServer::getAppId()
CRestServer::getApplicationSignature()
CRestServer::getAuth()
CRestServer::getAuthData()
CRestServer::getAuthScope()
CRestServer::getAuthType()
CRestServer::getClientId()
CRestServer::getMethod()
CRestServer::getMethodCallback()
CRestServer::getMethodDescription()
CRestServer::getMethodOptions()
CRestServer::getPasswordId()
CRestServer::getQuery()
CRestServer::getScope()
CRestServer::getScopeList()
CRestServer::getServiceDescription()
CRestServer::getTokenCheckSignature()
CRestServer::getTransport()
CRestServer::init()
CRestServer::instance()
CRestServer::isTokenCheck()
CRestServer::makeSignature()
CRestServer::output()
CRestServer::outputError()
CRestServer::outputJson()
CRestServer::outputXml()
CRestServer::process()
CRestServer::processCall()
CRestServer::processTokenCheckCall()
CRestServer::requestConfirmation()
CRestServer::sendHeaders()
CRestServer::setSecurityState()
CRestServer::setStatus()
CRestServer::transportSupported()
CRestServerBatchItem::checkAuth()
CRestServerBatchItem::setApplicationId()
CRestServerBatchItem::setAuthData()
CRestServerBatchItem::setAuthKeys()
CRestServerBatchItem::setAuthType()
CRestUtil::CleanApp()
CRestUtil::ConvertDate()
CRestUtil::ConvertDateTime()
CRestUtil::GetFile()
CRestUtil::InstallApp()
CRestUtil::ParseBatchQuery()
CRestUtil::UpdateApp()
CRestUtil::appCanBeInstalledByUser()
CRestUtil::canInstallApplication()
CRestUtil::checkAppAccess()
CRestUtil::checkAuth()
CRestUtil::getAdministratorIdList()
CRestUtil::getApplicationPage()
CRestUtil::getApplicationToken()
CRestUtil::getAuth()
CRestUtil::getAuthForEvent()
CRestUtil::getDownloadUrl()
CRestUtil::getEndpoint()
CRestUtil::getEventList()
CRestUtil::getInstallAccessList()
CRestUtil::getLanguage()
CRestUtil::getMemberId()
CRestUtil::getRequestData()
CRestUtil::getScopeList()
CRestUtil::getSpecialUrl()
CRestUtil::getStandardParams()
CRestUtil::getUploadUrl()
CRestUtil::getWebhookEndpoint()
CRestUtil::isAdmin()
CRestUtil::isSlider()
CRestUtil::isStatic()
CRestUtil::makeAuth()
CRestUtil::notifyInstall()
CRestUtil::processBatchElement()
CRestUtil::processBatchStructure()
CRestUtil::saveFile()
CRestUtil::sendHeaders()
CRestUtil::setInstallAccessList()
CRestUtil::signLicenseRequest()
CRestUtil::unConvertDate()
CRestUtil::unConvertDateTime()
CRestUtil::updateAppStatus()
CatalogViewManager::getView()
Cback::__callStatic()
Cback::bind()
Cback::getUserTypeDescription()
Cback::getUserTypeId()
Cback::unbind()
Cback::unbindByCode()
Client::__construct()
Client::addApplication()
Client::batch()
Client::call()
Client::checkAuth()
Client::deleteApplication()
Client::filterApp()
Client::getApp()
Client::getApplicationList()
Client::getAuth()
Client::getAvailableUpdate()
Client::getAvailableUpdateNum()
Client::getBuy()
Client::getBuyLink()
Client::getByTag()
Client::getCategories()
Client::getCategory()
Client::getCode()
Client::getHttpClient()
Client::getInstall()
Client::getLastByTag()
Client::getNumUpdates()
Client::getRequestUrl()
Client::getSubscriptionFinalDate()
Client::getTagByAppType()
Client::getTagByPlacement()
Client::getTop()
Client::getUpdates()
Client::installApplication()
Client::isSubscriptionAvailable()
Client::prepareRequest()
Client::prepareRequestData()
Client::prepareResponse()
Client::searchApp()
Client::sendApplicationUsage()
Client::sendEvent()
Client::setAvailableUpdate()
Client::unInstallApplication()
Client::updateApplication()
Configuration::getExport()
Configuration::getExportElement()
Configuration::getImport()
Configuration::getImportApp()
Configuration::getImportManifest()
Configuration::getImportRollback()
Configuration::getPlacement()
Configuration::getReplaced()
Configuration::getSection()
Controller::callEventClear()
Controller::callEventExport()
Controller::callEventImport()
Controller::getEntityCodeList()
Engine::__construct()
Engine::clearAccess()
Engine::getClient()
Engine::getClientId()
Engine::getClientSecret()
Engine::getLicense()
Engine::isRegistered()
Engine::setAccess()
Event::eventBind()
Event::eventGet()
Event::eventOfflineClear()
Event::eventOfflineError()
Event::eventOfflineGet()
Event::eventOfflineList()
Event::eventTest()
Event::eventUnbind()
Event::eventsList()
Event::isExtendedModeEnabled()
Event::onRestServiceBuildDescription()
Event::sanitizeFilter()
Event::sanitizeOrder()
EventOfflineQuery::getMarkQuery()
EventOfflineTable::callEvent()
EventOfflineTable::cleanProcessAgent()
EventOfflineTable::clearEvents()
EventOfflineTable::clearEventsByMessageId()
EventOfflineTable::getMap()
EventOfflineTable::getMessageId()
EventOfflineTable::getProcessId()
EventOfflineTable::getTableName()
EventOfflineTable::markError()
EventOfflineTable::markEvents()
EventTable::bind()
EventTable::checkCallback()
EventTable::checkUniq()
EventTable::deleteAppInstaller()
EventTable::deleteByApp()
EventTable::getMap()
EventTable::getTableName()
EventTable::onAfterAdd()
EventTable::onAfterUpdate()
EventTable::onBeforeAdd()
EventTable::onBeforeUpdate()
Externalizer::__construct()
Externalizer::convertKeysToCamelCase()
Externalizer::externalize()
Externalizer::getIdList()
Externalizer::getPage()
Externalizer::multiSortKeysArray()
Externalizer::process()
Externalizer::toArray()
HandlerHelper::checkCallback()
HandlerHelper::getApplicationList()
HandlerHelper::storeApplicationList()
Helper::__construct()
Helper::addRatio()
Helper::clearRatio()
Helper::deleteRatio()
Helper::deleteSetting()
Helper::deleteUsesConfigurationApp()
Helper::getContextAction()
Helper::getInstance()
Helper::getRatio()
Helper::getSetting()
Helper::getStorageBackup()
Helper::getStorageBackupParam()
Helper::getUsesConfigurationApp()
Helper::sanitize()
Helper::saveSetting()
Helper::setUsesConfigurationApp()
IRestService::getDescription()
IRestService::getNavData()
IRestService::sanitizeFilter()
IRestService::sanitizeOrder()
IRestService::setNavData()
Internalizer::__construct()
Internalizer::check()
Internalizer::convertToSnakeCase()
Internalizer::internalize()
Internalizer::process()
LogTable::addEntry()
LogTable::checkEntry()
LogTable::getMap()
LogTable::getTableName()
LogTable::log()
Manifest::callEventInit()
Manifest::get()
Manifest::getList()
Marketplace::getCategoryUrl()
Marketplace::getPlacementUrl()
MarketplaceActions::getItems()
ModificationFieldsBase::__construct()
ModificationFieldsBase::getArguments()
ModificationFieldsBase::getController()
ModificationFieldsBase::getData()
ModificationFieldsBase::getManager()
ModificationFieldsBase::getName()
ModificationFieldsBase::getView()
ModificationFieldsBase::setArguments()
Notify::__construct()
Notify::getNotifier()
Notify::getType()
Notify::getUserList()
Notify::send()
Notify::setType()
Notify::setUserList()
NotifyIm::__construct()
NotifyIm::receive()
NotifyIm::send()
OAuthException::__construct()
OAuthException::getErrorCode()
OAuthService::getEngine()
OAuthService::getMemberId()
OAuthService::getRedirectUri()
OAuthService::register()
OAuthService::unregister()
PasswordTable::createPassword()
PasswordTable::generatePassword()
PasswordTable::getMap()
PasswordTable::getTableName()
PermissionTable::cleanPermissionList()
PermissionTable::deleteByPasswordId()
PermissionTable::getMap()
PermissionTable::getTableName()
PermissionTable::onPasswordDelete()
Placement::bind()
Placement::checkPermission()
Placement::get()
Placement::getApplicationInfo()
Placement::getList()
Placement::getPlacementList()
Placement::getScope()
Placement::onRestServiceBuildDescription()
Placement::unbind()
PlacementTable::checkUniq()
PlacementTable::clearHandlerCache()
PlacementTable::deleteByApp()
PlacementTable::getCacheId()
PlacementTable::getHandlers()
PlacementTable::getHandlersList()
PlacementTable::getMap()
PlacementTable::getTableName()
PlacementTable::onAfterAdd()
PlacementTable::onAfterDelete()
PlacementTable::onAfterUpdate()
PlacementTable::onBeforeAdd()
PlacementTable::onBeforeUpdate()
Provider::authorizeClient()
Provider::get()
Provider::getClient()
Provider::getTokenParams()
Provider::instance()
ProviderOAuth::instance()
ProviderOAuth::send()
ProviderOffline::getServerAuthData()
ProviderOffline::instance()
ProviderOffline::notifyApplication()
ProviderOffline::notifyApplications()
ProviderOffline::send()
ProxyDiskType::canAttachToExternalEntity()
ProxyDiskType::canIndexBySearch()
ProxyDiskType::getEntityImageSrc()
ProxyDiskType::getSecurityContextByUser()
ProxyDiskType::getStorageBaseUrl()
RemoteDictionary::__construct()
RemoteDictionary::getCacheId()
RemoteDictionary::getDictionaryUri()
RemoteDictionary::init()
RemoteDictionary::load()
RemoteDictionary::setLanguage()
RestException::__construct()
RestException::getAdditional()
RestException::getErrorCode()
RestException::getStatus()
RestException::initFromException()
RestException::setAdditional()
RestException::setApplicationException()
RestException::setErrorCode()
RestException::setMessage()
RestException::setStatus()
RestManager::convertAjaxUriToRest()
RestManager::createExceptionFromErrors()
RestManager::getAutoWirings()
RestManager::getModuleScopeAlias()
RestManager::getNavigationData()
RestManager::getRestEndPoint()
RestManager::initialize()
RestManager::onFindMethodDescription()
RestManager::processData()
RestManager::processMethodRequest()
RestManager::registerAutoWirings()
RestManager::unRegisterAutoWirings()
Sender::bind()
Sender::call()
Sender::getAuth()
Sender::getDefaultEventParams()
Sender::getDefaultProvider()
Sender::getDefaultProviderOffline()
Sender::getHandlerName()
Sender::getProvider()
Sender::getProviderOffline()
Sender::initialize()
Sender::parseEventName()
Sender::send()
Sender::setProvider()
Sender::setProviderOffline()
Sender::unbind()
Session::get()
Session::set()
Sqs::queryItem()
StatAppTable::getMap()
StatAppTable::getTableName()
StatAppTable::register()
StatAppTable::validateAppCode()
StatMethodTable::addMethod()
StatMethodTable::checkList()
StatMethodTable::getId()
StatMethodTable::getMap()
StatMethodTable::getTableName()
StatMethodTable::loadFromCache()
StatMethodTable::validateName()
StatTable::addApToLog()
StatTable::addToLog()
StatTable::cleanUpAgent()
StatTable::deleteByFilter()
StatTable::finalize()
StatTable::getMap()
StatTable::getTableName()
StatTable::log()
StatTable::logActivity()
StatTable::logApMethod()
StatTable::logEvent()
StatTable::logMethod()
StatTable::logPlacement()
StatTable::logRobot()
StatTable::reset()
StatTable::updateByFilter()
StorageCache::getCache()
StorageCache::getCacheId()
StorageCache::restore()
StorageCache::rewrite()
StorageCache::store()
Templates::getDetailUrl()
Templates::getDir()
Templates::getEditUrl()
Templates::getIndexUrl()
Templates::getInstance()
Templates::getReplaced()
Templates::getReplacedId()
Transport::__construct()
Transport::batch()
Transport::call()
Transport::instance()
Transport::prepareAnswer()
Transport::prepareQuery()
Type::getAdminListEditHTML()
Type::getAdminListEditHTMLMulty()
Type::getAdminListViewHTML()
Type::getAdminListViewHTMLMulty()
Type::getApplication()
Type::getDBColumnType()
Type::getEditFormHTML()
Type::getEditFormHTMLMulty()
Type::getFilterData()
Type::getFilterHTML()
Type::getPublicEdit()
Type::getPublicView()
Type::getSettingsHTML()
Type::prepareSettings()
Url::getApplicationAddUrl()
Url::getApplicationDetailUrl()
Url::getApplicationPlacementUrl()
Url::getApplicationUrl()
Url::getCategoryUrl()
Url::getConfigurationExportElementUrl()
Url::getConfigurationExportUrl()
Url::getConfigurationImportAppUrl()
Url::getConfigurationImportManifestUrl()
Url::getConfigurationImportRollbackUrl()
Url::getConfigurationImportUrl()
Url::getConfigurationPlacementUrl()
Url::getConfigurationSectionUrl()
Url::getConfigurationUrl()
Url::getMarketplaceUrl()
Url::getWidgetAddUrl()
UsageEntityTable::getEntityInfo()
UsageEntityTable::getMap()
UsageEntityTable::getTableName()
UsageEntityTable::register()
UsageEntityTable::validateEntityCode()
UsageEntityTable::validateEntityType()
UsageEntityTable::validateSubEntityName()
UsageEntityTable::validateSubEntityType()
UsageStatTable::cleanUpAgent()
UsageStatTable::deleteByFilter()
UsageStatTable::finalize()
UsageStatTable::getMap()
UsageStatTable::getTableName()
UsageStatTable::increment()
UsageStatTable::log()
UsageStatTable::logActivity()
UsageStatTable::logEvent()
UsageStatTable::logHookMethod()
UsageStatTable::logMethod()
UsageStatTable::logPlacement()
UsageStatTable::logRobot()
UsageStatTable::reset()
UsageStatTable::sendAgent()
UsageStatTable::sendDateStat()
UsageStatTable::updateByFilter()
User::checkAllowedFields()
User::getAccess()
User::getDefaultAllowedUserFields()
User::getDefaultSite()
User::getFields()
User::getUserData()
User::hasAccess()
User::isAdmin()
User::onRestServiceBuildDescription()
User::onUserInitialize()
User::prepareUserData()
User::unsetDefaultAllowedUserField()
User::userAdd()
User::userCounters()
User::userCurrent()
User::userGet()
User::userOnline()
User::userUpdate()
UserFieldProxy::__construct()
UserFieldProxy::add()
UserFieldProxy::checkCreatePermission()
UserFieldProxy::checkDeletePermission()
UserFieldProxy::checkReadPermission()
UserFieldProxy::checkUpdatePermission()
UserFieldProxy::delete()
UserFieldProxy::get()
UserFieldProxy::getAllLanguages()
UserFieldProxy::getCurrentUser()
UserFieldProxy::getEntityID()
UserFieldProxy::getEnumerationElementFields()
UserFieldProxy::getFields()
UserFieldProxy::getList()
UserFieldProxy::getNamePrefix()
UserFieldProxy::getSettingsFields()
UserFieldProxy::getTypes()
UserFieldProxy::includeLangFile()
UserFieldProxy::isAdminUser()
UserFieldProxy::isAuthorizedUser()
UserFieldProxy::prepareLabels()
UserFieldProxy::sanitizeFields()
UserFieldProxy::setNamePrefix()
UserFieldProxy::update()
UserFieldType::add()
UserFieldType::checkPermission()
UserFieldType::delete()
UserFieldType::getList()
UserFieldType::onRestServiceBuildDescription()
UserFieldType::update()
ViewManager::__construct()
ViewManager::getControllerAction()
rest::DoInstall()
rest::DoUninstall()
rest::InstallDB()
rest::InstallEvents()
rest::InstallFiles()
rest::OnGetTableSchema()
rest::UnInstallDB()
rest::UnInstallEvents()
rest::UnInstallFiles()
rest::rest()