Skip to content
Alex Trofimov edited this page Mar 9, 2020 · 27 revisions

UNA provides API access to the certain functionality.
API is a part of OAuth2 module, so this module must be installed to make API calls. After user is logged or joined in via OAuth2, API calls can be performed.

Scopes

There are several scopes which allows access to the certain endpoints:

  • basic - provides acces to me, user, friends endpoints and usually used to join user to another site via OAuth2 login/join.
  • market - provides acceess to me, market endpoints and usually used to get access to the market via UNA Studio.
  • service - provides access to service endpoint which can be used to call service methods for different purposes. This endpoint provides access to direct calls of service function and can not be considered as safe.

When key&secret pair is generated by default basic scope is assigned, there is no way to change it via interface, so for more advanced market and service scopes it should be edited directly in the database in bx_oauth_clients table, scope field.

Grant types

To login several "grant types" are supported: Client Credentials(client_credentials), Authorization Code(authorization_code), Refresh Token(refresh_token) and User Credentials (password)

To use API it's better to use "User Credentials" grant type to get the token for the future communication. To use this grant type then after generating key&secret, you need to empty client_secret field in bx_oauth_clients table.

By default Authorization Code grant type is used, to use other grant types specify them in grant_types field in bx_oauth_clients table as comma separated string for the desired key&secret pair.

CORS

To make cross domain requests to the API, you need to specify origin URLs in bx_oauth_allowed_origins table where client_id is id from from bx_oauth_clients table and url field is URL which is used to make requests from. By default only requests from the same domain are allowed.

Public API

All requests to the URIs specified below must be HTTP GET, unless different method is specified. Response is always in JSON format.

/m/oauth2/token (POST) - all scopes

Get the access token for future communication with private API. To get access token using refresh token the key must have refresh_token grant type. It can be several grant types for the same key as comma separated string.

Request params:

  • grant_type - for API it's better to use 'password' grant type
  • username - login email
  • password - login password
  • client_id - client ID from bx_oauth_clients table
  • scope - scope field value from bx_oauth_clients table

Request params to get token using refresh_token:

  • grant_type - refresh_token
  • refresh_token - refresh token which was generated before
  • client_id - client ID from bx_oauth_clients table
  • scope - scope field value from bx_oauth_clients table

Response (success):

{  
   "access_token":"cdd7056d0adafa9ead87526ca22367c6b0df8273",
   "expires_in":3600,
   "token_type":"Bearer",
   "scope":"basic",
   "refresh_token":"c3d7f6f4b7cc640214ae0cba2b194872c3089f1c"
}

Response (error):

{  
   "error":"short error description here",
   "error_description":"long error description here"
}

Private API

All requests to the URIs specified below must be HTTP GET, unless different method is specified.
Response is always in JSON format.

/m/oauth2/api/me (GET) - basic,market,service scopes

Provides information about current profile.

Request header:

Authorization: Bearer 9802c4a34e1535d8c3b721604ee0e7fb04116c49

Response (success):

{  
    "id":"123",
    "type":"bx_organizations",
    "email":"test@example.com",
    "role":"1",
    "name":"Test",
    "profile_display_name":"Test",
    "profile_link":"http:\/\/example.com\/path-to-una\/page\/view-organization-profile?id=12",
    "picture":"http:\/\/example.com\/path-to-una\/image_transcoder.php?o=bx_organizations_picture&h=36&dpx=1&t=1496247306"
}

Response (error):

{  
   "error":"short error description here",
   "error_description":"long error description here"
}

/m/oauth2/api/user (GET) - basic,market,service scopes

Provides information about another profile.

Possible GET/POST arguments:

  • id - profile id to get info for

/m/oauth2/api/friends (GET) - basic,market,service scopes

Get list of friends.

Possible GET/POST arguments:

  • id - profile id to get friends list for

/m/oauth2/api/market (GET) - 'market' scope

Market functions.

Arguments are the same as for service endpoint but without module argument.

/m/oauth2/api/service (GET) - 'service' scope

Call service functions.

Possible GET/POST arguments:

  • module - module name. List of all installed modules names can be found sys_modules table, name field.
  • method - module service method. Modules service methods always look like this serviceGetSmth in the code, but in this argument it must be specified as get_smth.
  • params - method parameters array. It can be PHP serialised array or as usual query array, specified as params []=123&params[]=abc.
  • class - class name service function belongs to, in the case of main module class (PrefixSuffixModule) - this argument can be omitted.

Output for service calls is always JSON array with the following keys:

  • module - module name
  • method - method name
  • data - method output

List of service functions

To find the help for particular function please go to UNA autogenerated documentation, search for particular class name, then search for particular method on the class description page.

Some documented service calls are described in Service Calls section in autogenerated documentation.

Please note: not all functions have description, we'll try to document all service methods in the nearest future.

// System
BxDolCmts::serviceGetAuthor ($iContentId)
BxDolCmts::serviceGetDateAdded ($iContentId)
BxDolCmts::serviceGetDateChanged ($iContentId)
BxDolCmts::serviceGetLink ($iContentId)
BxDolCmts::serviceGetTitle ($iContentId)
BxDolCmts::serviceGetText ($iContentId)
BxDolCmts::serviceGetThumb ($iContentId)
BxDolCmts::serviceGetInfo ($iContentId, $bSearchableFieldsOnly = true)
BxDolCmts::serviceGetSearchResultUnit ($iContentId, $sUnitTemplate = '')
BxDolCmts::serviceGetAll ($aParams = array())
BxDolRequest::serviceExists($mixedModule, $sMethod, $sClass = "Module")
BxBaseAclServices::serviceGetMemberships($bPurchasableOnly = false, $bActiveOnly = false, $isTranslate = true)
BxBaseCmtsServices::serviceGetMenuItemAddonVote($sSystem, $iId, $iCmtId)
BxBaseCmtsServices::serviceGetLiveUpdatesComments($sSystem, $iContentId, $iProfileId, $iCount = 0)
BxBaseImageServices::serviceAlertResponseFileDeleteLocal($oAlert, $sObject)
BxBaseImageServices::serviceAlertResponseFileDeleteOrig($oAlert, $sObject)
BxBaseLanguagesServices::serviceGetLanguages($bIdAsKey = false, $bActiveOnly = false)
BxBaseLiveUpdatesServices::serviceInit()
BxBasePaymentsServices::serviceGetPayments()
BxBasePaymentsServices::serviceGetCartItemsCount()
BxBasePaymentsServices::serviceGetOrdersCount($sType)
BxBasePaymentsServices::serviceGetLiveUpdatesCart($aMenuItemParent, $aMenuItemChild, $iCount = 0)
BxBasePaymentsServices::serviceGetLiveUpdatesOrders($aMenuItemParent, $aMenuItemChild, $iCount = 0)
BxBaseServiceAccount::serviceCreateAccountForm ($aParams = array())
BxBaseServiceAccount::serviceAccountSettingsEmail ($iAccountId = false)
BxBaseServiceAccount::serviceAccountSettingsPassword ($iAccountId = false)
BxBaseServiceAccount::serviceAccountSettingsInfo ($iAccountId = false)
BxBaseServiceAccount::serviceAccountSettingsDelAccount ($iAccountId = false)
BxBaseServiceAccount::serviceUnsubscribeNews()
BxBaseServiceAccount::serviceUnsubscribeNotifications()
BxBaseServiceAccount::serviceEmailConfirmation($sMsg = false)
BxBaseServiceAccount::serviceForgotPassword()
BxBaseServiceCategory::serviceCategoriesList ($sObject, $aParams = array())
BxBaseServiceConnections::serviceConnectionsTable ()
BxBaseServiceConnections::serviceGetUnconfirmedConnectionsNum ($sConnectionsObject, $mixedId = 0)
BxBaseServiceConnections::serviceGetLiveUpdatesUnconfirmedConnections($sModule, $sConnectionsObject, $aMenuItemParent, $aMenuItemChild, $iCount = 0)
BxBaseServiceConnections::serviceGetConnectedContentNum ($sConnectionsObject, $mixedId = 0)
BxBaseServiceConnections::serviceGetConnectedInitiatorsNum ($sConnectionsObject, $mixedId = 0)
BxBaseServiceConnections::serviceSubscriptionsTable ()
BxBaseServiceConnections::serviceSubscribedMeTable ()
BxBaseServiceConnections::serviceGetNotificationsPost($aEvent)
BxBaseServiceConnections::serviceGetNotificationsPostFriendship($aEvent)
BxBaseServiceLogin::serviceTest ($n = 1)
BxBaseServiceLogin::serviceMemberAuthCode($aAuthTypes = array())
BxBaseServiceLogin::serviceLoginFormOnly ($sParams = '', $sForceRelocate = '')
BxBaseServiceLogin::serviceLoginForm ($sParams = '', $sForceRelocate = '')
BxBaseServiceMetatags::serviceKeywordsCloud($sObject, $mixedSection, $aParams = array())
BxBaseServiceMetatags::serviceLocationsMap($sObject, $iId, $sMapSize = '1000x144')
BxBaseServiceProfiles::serviceGetProfileTypes()
BxBaseServiceProfiles::serviceProfileStats ($iProfileId = 0)
BxBaseServiceProfiles::serviceProfileMembership ($iProfileId = 0)
BxBaseServiceProfiles::serviceProfileNotifications ($iProfileId = 0)
BxBaseServiceProfiles::serviceGetProfilesModules ()
BxBaseServiceProfiles::serviceProfilesSearch ($sTerm, $iLimit = 20)
BxBaseServiceProfiles::serviceProfilesList ($iAccountId = 0)
BxBaseServiceProfiles::serviceAccountProfileSwitcher ($iAccountId = false, $iActiveProfileId = null, $sUrlProfileAction = '')
BxBaseServices::serviceProfileUnit ($iContentId)
BxBaseServices::serviceProfilePicture ($iContentId)
BxBaseServices::serviceProfileAvatar ($iContentId)
BxBaseServices::serviceProfileEditUrl ($iContentId)
BxBaseServices::serviceProfileThumb ($iContentId)
BxBaseServices::serviceProfileIcon ($iContentId)
BxBaseServices::serviceProfileName ($iContentId)
BxBaseServices::serviceProfileUrl ($iContentId)
BxBaseServices::serviceFormsHelper ()
BxBaseServices::serviceActAsProfile ()
BxBaseServices::servicePrepareFields ($aFieldsProfile)
BxBaseServices::serviceProfilesSearch ($sTerm, $iLimit)
BxBaseServices::serviceAlertResponseProcessStorageChange ($oAlert)
BxBaseServices::serviceAddToMobileHomepage ()
BxBaseTemplateServices::serviceGetTemplates($bEnabledOnly = true, $bShortInfo = true)

// General content modules
BxBaseModGeneralModule::serviceGetAuthor ($iContentId)
BxBaseModGeneralModule::serviceGetDateAdded ($iContentId)
BxBaseModGeneralModule::serviceGetDateChanged ($iContentId)
BxBaseModGeneralModule::serviceGetLink ($iContentId)
BxBaseModGeneralModule::serviceGetTitle ($iContentId)
BxBaseModGeneralModule::serviceGetText ($iContentId)
BxBaseModGeneralModule::serviceGetInfo ($iContentId, $bSearchableFieldsOnly = true)
BxBaseModGeneralModule::serviceGetSearchResultUnit ($iContentId, $sUnitTemplate = '')
BxBaseModGeneralModule::serviceGetAll ($aParams = array())
BxBaseModGeneralModule::serviceModuleIcon ()
BxBaseModGeneralModule::serviceGetSearchableFields ()
BxBaseModGeneralModule::serviceManageTools($sType = 'common')
BxBaseModGeneralModule::serviceGetMenuAddonManageTools()
BxBaseModGeneralModule::serviceGetMenuAddonManageToolsProfileStats()
BxBaseModGeneralModule::serviceBrowseFeatured ($sUnitView = false, $bEmptyMessage = true, $bAjaxPaginate = true)
BxBaseModGeneralModule::serviceBrowseFavorite ($iProfileId = 0, $aParams = array())
BxBaseModGeneralModule::serviceFormsHelper ()
BxBaseModGeneralModule::serviceEntityAdd ($iAccount, $aValues)
BxBaseModGeneralModule::serviceEntityCreate ()
BxBaseModGeneralModule::serviceEntityEdit ($iContentId = 0)
BxBaseModGeneralModule::serviceEntityDelete ($iContentId = 0)
BxBaseModGeneralModule::serviceEntityTextBlock ($iContentId = 0)
BxBaseModGeneralModule::serviceEntityInfo ($iContentId = 0)
BxBaseModGeneralModule::serviceEntityInfoFull ($iContentId = 0)
BxBaseModGeneralModule::serviceEntityInfoExtended ($iContentId = 0)
BxBaseModGeneralModule::serviceEntityLocation ($iContentId = 0)
BxBaseModGeneralModule::serviceDeleteEntity ($iContentId, $sFuncDelete = 'deleteData')
BxBaseModGeneralModule::serviceEntityAllActions ($iContentId = 0)
BxBaseModGeneralModule::serviceEntityActions ($iContentId = 0)
BxBaseModGeneralModule::serviceEntitySocialSharing ($iContentId = 0)
BxBaseModGeneralModule::serviceGetNotificationsData()
BxBaseModGeneralModule::serviceGetNotificationsPost($aEvent)
BxBaseModGeneralModule::serviceGetNotificationsComment($aEvent)
BxBaseModGeneralModule::serviceGetNotificationsVote($aEvent)
BxBaseModGeneralModule::serviceGetTimelineData()
BxBaseModGeneralModule::serviceGetTimelinePost($aEvent)

// Groups based modules
BxBaseModGroupsModule::serviceGetSearchResultUnit ($iContentId, $sUnitTemplate = '')
BxBaseModGroupsModule::serviceActAsProfile ()
BxBaseModGroupsModule::serviceIsGroupProfile ()
BxBaseModGroupsModule::serviceIsFan ($iGroupProfileId, $iProfileId = false) 
BxBaseModGroupsModule::serviceDeleteProfileFromFansAndAdmins ($iProfileId)
BxBaseModGroupsModule::serviceReassignEntityAuthor ($iContentId)
BxBaseModGroupsModule::serviceReassignEntitiesByAuthor ($iProfileId)
BxBaseModGroupsModule::servicePrepareFields ($aFieldsProfile)
BxBaseModGroupsModule::serviceOnRemoveConnection ($iGroupProfileId, $iInitiatorId)
BxBaseModGroupsModule::serviceAddMutualConnection ($iGroupProfileId, $iInitiatorId, $iIgnoreJoinConfirmation = false)
BxBaseModGroupsModule::serviceFansTable ()
BxBaseModGroupsModule::serviceFans ($iContentId = 0)
BxBaseModGroupsModule::serviceAdmins ($iContentId = 0)
BxBaseModGroupsModule::serviceBrowseJoinedEntries ($iProfileId = 0, $bDisplayEmptyMsg = false)
BxBaseModGroupsModule::serviceEntityInvite ($iContentId = 0)
BxBaseModGroupsModule::serviceEntitySocialSharing ($iContentId = 0)
BxBaseModGroupsModule::serviceGetNotificationsData()
BxBaseModGroupsModule::serviceGetNotificationsJoinRequest($aEvent)
BxBaseModGroupsModule::serviceGetNotificationsFanAdded($aEvent)
BxBaseModGroupsModule::serviceGetTimelinePost($aEvent)

// Notifications based modules
BxBaseModNotificationsModule::serviceAddHandlers($sModuleUri)
BxBaseModNotificationsModule::serviceDeleteHandlers($sModuleUri)
BxBaseModNotificationsModule::serviceDeleteModuleEvents($sModuleUri)
BxBaseModNotificationsModule::serviceGetActionsChecklist()

// Payments based modules
BxBaseModPaymentCart::serviceGetCartUrl($iVendor = 0)
BxBaseModPaymentCart::serviceGetCartJs($sType = '')
BxBaseModPaymentCart::serviceGetAddToCartJs($iVendorId, $mixedModuleId, $iItemId, $iItemCount, $bNeedRedirect = false)
BxBaseModPaymentCart::serviceGetAddToCartLink($iVendorId, $mixedModuleId, $iItemId, $iItemCount, $bNeedRedirect = false)
BxBaseModPaymentCart::serviceGetSubscriptionsUrl($iVendor = 0)
BxBaseModPaymentCart::serviceGetSubscribeUrl($iVendorId, $sVendorProvider, $mixedModuleId, $iItemId, $iItemCount = 1)
BxBaseModPaymentCart::serviceGetSubscribeJs($iVendorId, $sVendorProvider, $mixedModuleId, $iItemId, $iItemCount = 1, $sRedirect = '')
BxBaseModPaymentCart::serviceGetSubscribeLink($iVendorId, $sVendorProvider, $mixedModuleId, $iItemId, $iItemCount = 1, $sRedirect = '')
BxBaseModPaymentCart::serviceGetCartItemDescriptor($iVendorId, $iModuleId, $iItemId, $iItemCount)
BxBaseModPaymentCart::serviceGetCartItemsCount($iUserId = 0)
BxBaseModPaymentDetails::serviceGetDetailsUrl()
BxBaseModPaymentModule::serviceUpdateDependentModules($sModule = 'all', $bInstall = true)
BxBaseModPaymentModule::serviceGetCurrencyInfo()
BxBaseModPaymentModule::serviceGetOption($sOption)
BxBaseModPaymentModule::serviceGetProvidersCart($iVendorId)
BxBaseModPaymentOrders::serviceGetOrdersUrl()
BxBaseModPaymentOrders::serviceGetOrdersCount($sType, $iProfileId = 0)
BxBaseModPaymentSubscriptions::serviceGetSubscriptionsUrl($iVendor = 0)
BxBaseModPaymentSubscriptions::serviceGetSubscribeUrl($iVendorId, $sVendorProvider, $mixedModuleId, $iItemId, $iItemCount = 1)
BxBaseModPaymentSubscriptions::serviceGetSubscribeJs($iVendorId, $sVendorProvider, $mixedModuleId, $iItemId, $iItemCount = 1)
BxBaseModPaymentSubscriptions::serviceGetSubscribeLink($iVendorId, $sVendorProvider, $mixedModuleId, $iItemId, $iItemCount = 1)

// Profiles based modules
BxBaseModProfileModule::serviceGetOptionsRedirectAfterAdd()
BxBaseModProfileModule::serviceGetThumb ($iContentId, $sTranscoder = '') 
BxBaseModProfileModule::serviceGetSearchResultUnit ($iContentId, $sUnitTemplate = '')
BxBaseModProfileModule::servicePrivateProfileMsg()
BxBaseModProfileModule::serviceGetContentInfoById($iContentId)
BxBaseModProfileModule::serviceGetMenuAddonManageTools()
BxBaseModProfileModule::serviceGetMenuAddonManageToolsProfileStats()
BxBaseModProfileModule::serviceGetMenuAddonFavoritesProfileStats()
BxBaseModProfileModule::serviceGetSubmenuObject ()
BxBaseModProfileModule::serviceGetMenuSetNameForMenuTrigger ($sMenuTriggerName)
BxBaseModProfileModule::serviceGetPageObjectForPageTrigger ($sPageTriggerName)
BxBaseModProfileModule::serviceProfilesSearch ($sTerm, $iLimit)
BxBaseModProfileModule::serviceProfileUnit ($iContentId)
BxBaseModProfileModule::serviceProfilePicture ($iContentId)
BxBaseModProfileModule::serviceProfileAvatar ($iContentId)
BxBaseModProfileModule::serviceProfileEditUrl ($iContentId)
BxBaseModProfileModule::serviceProfileThumb ($iContentId)
BxBaseModProfileModule::serviceProfileIcon ($iContentId)
BxBaseModProfileModule::serviceProfileName ($iContentId)
BxBaseModProfileModule::serviceProfileCreateUrl ($bAbsolute = true)
BxBaseModProfileModule::serviceProfileUrl ($iContentId)
BxBaseModProfileModule::servicePrepareFields ($aFieldsProfile)
BxBaseModProfileModule::serviceFormsHelper ()
BxBaseModProfileModule::serviceEntityCreate ()
BxBaseModProfileModule::serviceActAsProfile ()
BxBaseModProfileModule::serviceBrowseRecentProfiles ($bDisplayEmptyMsg = false)
BxBaseModProfileModule::serviceBrowseActiveProfiles ($bDisplayEmptyMsg = false)
BxBaseModProfileModule::serviceBrowseTopProfiles ($bDisplayEmptyMsg = false)
BxBaseModProfileModule::serviceBrowseOnlineProfiles ($bDisplayEmptyMsg = false)
BxBaseModProfileModule::serviceBrowseConnections ($iProfileId, $sObjectConnections = 'sys_profiles_friends', $sConnectionsType = 'content', $iMutual = false, $iDesignBox = BX_DB_PADDING_DEF, $iProfileId2 = 0)
BxBaseModProfileModule::serviceBrowseConnectionsQuick ($iProfileId, $sObjectConnections = 'sys_profiles_friends', $sConnectionsType = 'content', $iMutual = false, $iProfileId2 = 0)
BxBaseModProfileModule::serviceBrowseByAcl ($mixedLevelId, $iDesignBox = BX_DB_PADDING_DEF)
BxBaseModProfileModule::serviceEntityEditCover ($iContentId = 0)
BxBaseModProfileModule::serviceEntitySocialSharing ($iContentId = 0)
BxBaseModProfileModule::serviceProfileMembership ($iContentId = 0)
BxBaseModProfileModule::serviceProfileFriends ($iContentId = 0)
BxBaseModProfileModule::serviceDeleteEntityService ($iContentId, $bDeleteWithContent = false)
BxBaseModProfileModule::serviceGetNotificationsData()
BxBaseModProfileModule::serviceGetNotificationsTimelinePostCommon($aEvent)
BxBaseModProfileModule::serviceGetConnectionButtonsTitles($iProfileId, $sConnectionsObject = 'sys_profiles_friends')

// Text based modules
BxBaseModTextModule::serviceGetThumb ($iContentId, $sTranscoder = '') 
BxBaseModTextModule::serviceGetMenuAddonManageTools()
BxBaseModTextModule::serviceGetMenuAddonManageToolsProfileStats()
BxBaseModTextModule::serviceBrowsePublic ($sUnitView = false, $bEmptyMessage = true, $bAjaxPaginate = true)
BxBaseModTextModule::serviceBrowsePopular ($sUnitView = false, $bEmptyMessage = true, $bAjaxPaginate = true)
BxBaseModTextModule::serviceBrowseUpdated ($sUnitView = false, $bEmptyMessage = true, $bAjaxPaginate = true)
BxBaseModTextModule::serviceBrowseAuthor ($iProfileId = 0, $aParams = array())
BxBaseModTextModule::serviceEntityComments ($iContentId = 0)
BxBaseModTextModule::serviceEntityAuthor ($iContentId = 0)
BxBaseModTextModule::serviceEntityAttachments ($iContentId = 0)
BxBaseModTextModule::serviceEntityBreadcrumb ($iContentId = 0)
BxBaseModTextModule::serviceMyEntriesActions ($iProfileId = 0)
BxBaseModTextModule::serviceDeleteEntitiesByAuthor ($iProfileId)

// Individual modules
BxAccntModule::serviceGetMenuAddonManageTools()
BxAclModule::serviceGetBlockView()
BxAclModule::serviceGetMembershipActions($iProfileId)
BxAclModule::serviceGetPaymentData()
BxAclModule::serviceGetCartItem($iItemId)
BxAclModule::serviceGetCartItems($iSellerId)
BxAclModule::serviceRegisterCartItem($iClientId, $iSellerId, $iItemId, $iItemCount, $sOrder, $sLicense)
BxAclModule::serviceRegisterSubscriptionItem($iClientId, $iSellerId, $iItemId, $iItemCount, $sOrder, $sLicense)
BxAclModule::serviceUnregisterCartItem($iClientId, $iSellerId, $iItemId, $iItemCount, $sOrder, $sLicense)
BxAclModule::serviceUnregisterSubscriptionItem($iClientId, $iSellerId, $iItemId, $iItemCount, $sOrder, $sLicense)
BxAclModule::serviceCancelSubscriptionItem($iClientId, $iSellerId, $iItemId, $iItemCount, $sOrder)
BxAlbumsModule::serviceEntityAddFiles ($iContentId = 0)
BxAlbumsModule::serviceDeleteFileAssociations($iFileId)
BxAlbumsModule::serviceMediaExif ($iMediaId = 0)
BxAlbumsModule::serviceMediaComments ($iMediaId = 0)
BxAlbumsModule::serviceMediaAuthor ($iMediaId = 0)
BxAlbumsModule::serviceMediaSocialSharing ($iMediaId = 0, $bEnableCommentsBtn = false, $bEnableSocialSharing = true)
BxAlbumsModule::serviceMediaView ($iMediaId = 0, $mixedContext = false)
BxAlbumsModule::serviceBrowseRecentMedia ($sUnitView = false, $bDisplayEmptyMsg = true, $bAjaxPaginate = true)
BxAlbumsModule::serviceBrowseFeaturedMedia ($sUnitView = false, $bDisplayEmptyMsg = true, $bAjaxPaginate = true)
BxAlbumsModule::serviceBrowsePopularMedia ($sUnitView = false, $bDisplayEmptyMsg = true, $bAjaxPaginate = true)
BxAlbumsModule::serviceBrowseFavoriteMedia ($iProfileId = 0, $aParams = array())
BxAlbumsModule::serviceGetNotificationsData()
BxAlbumsModule::serviceGetNotificationsCommentMedia($aEvent)
BxAlbumsModule::serviceGetNotificationsVoteMedia($aEvent)
BxAntispamModule::serviceIpTable ()
BxAntispamModule::serviceDnsblList ()
BxAntispamModule::serviceBlockLog ()
BxAntispamModule::serviceIsSpam ($sContent, $sIp = '', $isStripSlashes = BX_SLASHES_AUTO)
BxAntispamModule::serviceCheckLogin ($sIp = '')
BxAntispamModule::serviceCheckJoin ($sEmail, &$bApproval, $sIp = '')
BxAntispamModule::serviceIsIpDnsBlacklisted($sCurIP = '', $sNote = '')
BxAntispamModule::serviceIsIpWhitelisted($sIp = '')
BxAntispamModule::serviceIsIpBlocked($sIp = '')
BxAntispamModule::serviceBlockIp($mixedIP, $iExpirationInSec = 86400, $sComment = '')
BxAntispamModule::servicePruning()
BxAntispamModule::serviceConfigValues($s)
BxChatPlusModule::serviceChatBlock ()
BxChatPlusModule::serviceHelpdeskCode ()
BxContactModule::serviceGetBlockForm()
BxContactModule::serviceGetContactPageUrl()
BxCnvModule::serviceConversationsInFolder ($iFolderId = BX_CNV_FOLDER_INBOX)
BxCnvModule::serviceMessagesPreviews ($iProfileId = 0)
BxCnvModule::serviceGetUnreadMessagesNum ($iProfileId = 0)
BxCnvModule::serviceGetLiveUpdates($aMenuItemParent, $aMenuItemChild, $iCount = 0)
BxCnvModule::serviceTriggerCommentPost ($iContentId, $iProfileId, $iCommentId, $iTimestamp = 0, $sCommentText = '')
BxCnvModule::serviceEntityCollaborators ($iContentId = 0)
BxCnvModule::serviceEntitySocialSharing ($iContentId = 0)
BxDataFoxModule::serviceIncludeCssJs()
BxDataFoxModule::serviceParseText($sHtml)
BxDecorousModule::serviceIncludeCssJs()
BxElsModule::serviceSearchSimple($sTerm, $sType = '', $sIndex = '')
BxElsModule::serviceSearchExtended($aCondition, $aSelection = array(), $sType = '', $sIndex = '')
BxElsModule::serviceGet($iContentId, $sType, $sIndex = '')
BxElsModule::serviceAdd($iContentId, $mixedContentInfo, $sIndex = '')
BxElsModule::serviceUpdate($iContentId, $mixedContentInfo, $sIndex = '')
BxElsModule::serviceDelete($iContentId, $mixedContentInfo, $sIndex = '')
BxElsModule::serviceIndex($sIndex, $sType = '')
BxEventsModule::serviceCalendar($aData = array(), $sTemplate = 'calendar.html')
BxEventsModule::serviceProcessReminders()
BxEventsModule::serviceGetTimelinePost($aEvent)
BxFaceBookConnectModule::serviceLastError()
BxFilesModule::serviceBrowseGroupAuthor ($iProfileId = 0, $aParams = array())
BxFilesModule::serviceIsAllowedAddContentToProfile($iGroupProfileId)
BxFilesModule::serviceMyEntriesActions ($iProfileId = 0)
BxFilesModule::serviceEntityFilePreview($iContentId = 0)
BxFilesModule::serviceProcessFilesData($iNumberOfFilesToProcessAtOnce = 3)
BxForumModule::serviceGetInfo ($iContentId, $bSearchableFieldsOnly = true)
BxForumModule::serviceBrowseNew ($sUnitView = false, $bEmptyMessage = true, $bAjaxPaginate = true)
BxForumModule::serviceBrowseLatest($sUnitView = false, $bEmptyMessage = true, $bAjaxPaginate = true, $bShowHeader = true)
BxForumModule::serviceBrowseFeatured($sUnitView = false, $bEmptyMessage = true, $bAjaxPaginate = true, $bShowHeader = true)
BxForumModule::serviceBrowseTop($sUnitView = false, $bEmptyMessage = true, $bAjaxPaginate = true)
BxForumModule::serviceBrowsePopular ($sUnitView = false, $bEmptyMessage = true, $bAjaxPaginate = true)
BxForumModule::serviceBrowseUpdated ($sUnitView = false, $bEmptyMessage = true, $bAjaxPaginate = true)
BxForumModule::serviceBrowseIndex($sUnitView = false, $bEmptyMessage = true, $bAjaxPaginate = true, $bShowHeader = true)
BxForumModule::serviceBrowseAuthor ($iProfileId = 0, $aParams = array())
BxForumModule::serviceBrowseFavorite ($iProfileId = 0, $aParams = array())
BxForumModule::serviceBrowseCategory($sUnitView = false, $bEmptyMessage = true, $bAjaxPaginate = true)
BxForumModule::serviceBrowseKeyword($sUnitView = false, $bEmptyMessage = true, $bAjaxPaginate = true)
BxForumModule::serviceBrowseSearchResults($sUnitView = false, $bEmptyMessage = true, $bAjaxPaginate = true)
BxForumModule::serviceGetDiscussionsNum ($iProfileId = 0)
BxForumModule::serviceGetUnrepliedDiscussionsNum ($iProfileId = 0)
BxForumModule::serviceTriggerCommentPost ($iContentId, $iProfileId, $iCommentId, $iTimestamp = 0, $sCommentText = '')
BxForumModule::serviceEntityParticipants ($iContentId = 0)
BxForumModule::serviceSearch()
BxIntercomModule::serviceIntegrationCode ()
BxIntercomModule::serviceRemoveAccount($mixed)
BxIntercomModule::serviceUpdateAccount($sEmail)
BxInvModule::serviceGetBlockInvite()
BxInvModule::serviceGetBlockFormInvite()
BxInvModule::serviceGetBlockFormRequest()
BxInvModule::serviceGetBlockManageRequests()
BxInvModule::serviceGetMenuAddonRequests()
BxInvModule::serviceAccountAddFormCheck()
BxMailchimpModule::serviceUpdateMergeFields()
BxMailchimpModule::serviceGetLists($bAddEmptyValue = true)
BxMailchimpModule::serviceRemoveAccount($mixed)
BxMailchimpModule::serviceUpdateAccount($sEmail)
BxMarketModule::serviceGetSearchableFields ()
BxMarketModule::serviceEntityCreate ()
BxMarketModule::serviceEntityDownload ($iContentId = 0)
BxMarketModule::serviceEntityRating($iContentId = 0)
BxMarketModule::serviceEntityAuthorEntities($iContentId = 0)
BxMarketModule::serviceBlockLicenses() 
BxMarketModule::serviceBlockLicensesNote()
BxMarketModule::serviceGetUnusedLicensesNum ($iProfileId = 0)
BxMarketModule::serviceHasLicense ($iProfileId, $iProductId, $sDomain = '')
BxMarketModule::serviceGetLicense ($aParams)
BxMarketModule::serviceUpdateLicense ($aSet, $aWhere)
BxMarketModule::serviceGetEntryBy($sType, $mixedValue)
BxMarketModule::serviceGetEntriesBy($aParams)
BxMarketModule::serviceGetThumbnail($iPhotoId)
BxMarketModule::serviceGetCover($iPhotoId)
BxMarketModule::serviceGetFile($iFileId)
BxMarketModule::serviceGetUpdates($iContentId, $sVersion = '')
BxMarketModule::serviceGetScreenshots($iItemId)
BxMarketModule::serviceGetPaymentData()
BxMarketModule::serviceGetCartItem($iItemId)
BxMarketModule::serviceGetCartItems($iSellerId)
BxMarketModule::serviceRegisterCartItem($iClientId, $iSellerId, $iItemId, $iItemCount, $sOrder, $sLicense)
BxMarketModule::serviceRegisterSubscriptionItem($iClientId, $iSellerId, $iItemId, $iItemCount, $sOrder, $sLicense)
BxMarketModule::serviceUnregisterCartItem($iClientId, $iSellerId, $iItemId, $iItemCount, $sOrder, $sLicense)
BxMarketModule::serviceUnregisterSubscriptionItem($iClientId, $iSellerId, $iItemId, $iItemCount, $sOrder, $sLicense)
BxMarketModule::serviceCancelSubscriptionItem($iClientId, $iSellerId, $iItemId, $iItemCount, $sOrder)
BxNtfsModule::serviceGetBlockView($sType = '', $iStart = -1, $iPerPage = -1, $aModules = array())
BxNtfsModule::serviceGetEventById($iId)
BxNtfsModule::serviceGetUnreadNotificationsNum($iOwnerId = 0)
BxNtfsModule::serviceGetLiveUpdates($aMenuItemParent, $aMenuItemChild, $iCount = 0)
BxOAuthAPI::service($aToken) 
BxOAuthModule::serviceAuthorization ()
BxOAuthModule::serviceGetClientsBy ($aParams = array())
BxOAuthModule::serviceAddClient ($aClient)
BxOAuthModule::serviceUpdateClientsBy ($aParamsSet, $aParamsWhere)
BxOAuthModule::serviceDeleteClientsBy ($aParams)
BxOrgsModule::servicePrepareFields ($aFieldsProfile)
BxOrgsModule::serviceGetTimelineData()
BxPaymentCart::serviceGetBlockCarts()
BxPaymentCart::serviceGetBlockCart()
BxPaymentCart::serviceGetBlockCartHistory()
BxPaymentCart::serviceAddToCart($iSellerId, $mixedModuleId, $iItemId, $iItemCount)
BxPaymentCart::serviceDeleteFromCart($iSellerId, $iModuleId = 0, $iItemId = 0)
BxPaymentCart::serviceSubscribe($iSellerId, $sSellerProvider, $iModuleId, $iItemId, $iItemCount, $sRedirect = '')
BxPaymentDetails::serviceGetBlockDetails($iUserId = BX_PAYMENT_EMPTY_ID)
BxPaymentJoin::serviceGetBlockJoin()
BxPaymentModule::serviceIsAcceptingPayments($iVendorId, $sPaymentType = '')
BxPaymentModule::serviceIsPaymentProvider($iVendorId, $sVendorProvider, $sPaymentType = '')
BxPaymentModule::serviceGetPaymentProvider($iVendorId, $sVendorProvider, $sPaymentType = '')
BxPaymentModule::serviceGetOptionsDefaultCurrencyCode()
BxPaymentModule::serviceGetOptionsSiteAdmin()
BxPaymentModule::serviceInitializeCheckout($sType, $iSellerId, $sProvider, $aItems = array(), $sRedirect = '')
BxPaymentOrders::serviceGetBlockOrders($sType = '', $iUserId = BX_PAYMENT_EMPTY_ID)
BxPaymentOrders::serviceGetOrdersInfo($aConditions)
BxPaymentOrders::serviceGetPendingOrdersInfo($aConditions)
BxPaymentSubscriptions::serviceGetBlockList()
BxPaymentSubscriptions::serviceGetBlockHistory()
BxPaymentSubscriptions::serviceGetBlockAdministration()
BxPaymentSubscriptions::serviceSubscribe($iSellerId, $sSellerProvider, $iModuleId, $iItemId, $iItemCount)
BxPersonsModule::serviceGetTimelineData()
BxPollsModule::serviceGetBlockSubentries($iContentId = 0)
BxPollsModule::serviceGetBlockResults($iContentId = 0)
BxProteanModule::serviceIncludeCssJs()
BxSEMigModule::serviceSocialEngineResponse($oAlert){
BxShopifyModule::serviceInclude($iProfileId = 0)
BxShopifyModule::serviceIncludeCssJs()
BxShopifyModule::serviceIncludeCode($iProfileId = 0)
BxShopifyModule::serviceEntityCreate ()
BxShopifyModule::serviceSettings()
BxSitesModule::serviceIsUsed($sDomain)
BxSitesModule::serviceBrowse()
BxSitesModule::serviceSiteCreate()
BxSitesModule::serviceSiteSubscribe()
BxSitesModule::serviceSiteView()
BxSitesModule::serviceSiteEdit()
BxSitesModule::serviceSiteDelete($iId = 0)
BxSMTPModule::serviceSend ($sRecipientEmail, $sMailSubject, $sMailBody, $sMailHeader, $sMailParameters, $isHtml, $aRecipientInfo = array())
BxSnipcartModule::serviceIncludeCssJs($iProfileId = 0)
BxSnipcartModule::serviceEntityCreate ()
BxSnipcartModule::serviceSettings()
BxStripeConnectModule::serviceGetOptionsMode()
BxStripeConnectModule::serviceGetOptionsApiScope()
BxStripeConnectModule::serviceGetOptionsPmodeSingle()
BxStripeConnectModule::serviceGetOptionsPmodeRecurring()
BxStripeConnectModule::serviceGetBlockConnect()
BxTimelineModule::serviceGetAuthor ($iContentId)
BxTimelineModule::serviceGetDateChanged ($iContentId)
BxTimelineModule::serviceGetLink ($iContentId)
BxTimelineModule::serviceGetThumb ($iContentId, $sTranscoder = '') 
BxTimelineModule::serviceGetInfo ($iContentId, $bSearchableFieldsOnly = true)
BxTimelineModule::serviceGetSearchResultUnit ($iContentId, $sUnitTemplate = '')
BxTimelineModule::serviceGetBlockPost($iProfileId = 0)
BxTimelineModule::serviceGetBlockPostProfile($sProfileModule = 'bx_persons', $iProfileContentId = 0)
BxTimelineModule::serviceGetBlockPostHome()
BxTimelineModule::serviceGetBlockView($iProfileId = 0)
BxTimelineModule::serviceGetBlockViewOutline($iProfileId = 0)
BxTimelineModule::serviceGetBlockViewProfile($sProfileModule = 'bx_persons', $iProfileContentId = 0, $iStart = -1, $iPerPage = -1, $sFilter = '', $aModules = array(), $iTimeline = -1)
BxTimelineModule::serviceGetBlockViewProfileOutline($sProfileModule = 'bx_persons', $iProfileContentId = 0, $iStart = -1, $iPerPage = -1, $sFilter = '', $aModules = array(), $iTimeline = -1)
BxTimelineModule::serviceGetBlockViewHome($iProfileId = 0, $iStart = -1, $iPerPage = -1, $iTimeline = -1, $sFilter = '', $aModules = array())
BxTimelineModule::serviceGetBlockViewHomeOutline($iProfileId = 0, $iStart = -1, $iPerPage = -1, $iTimeline = -1, $sFilter = '', $aModules = array())
BxTimelineModule::serviceGetBlockViewAccount($iProfileId = 0, $iStart = -1, $iPerPage = -1, $iTimeline = -1, $sFilter = '', $aModules = array())
BxTimelineModule::serviceGetBlockViewAccountOutline($iProfileId = 0, $iStart = -1, $iPerPage = -1, $iTimeline = -1, $sFilter = '', $aModules = array())
BxTimelineModule::serviceGetBlockItem()
BxTimelineModule::serviceGetNotificationsData()
BxTimelineModule::serviceGetNotificationsRepost($aEvent)
BxTimelineModule::serviceGetNotificationsPost($aEvent)
BxTimelineModule::serviceGetNotificationsComment($aEvent)
BxTimelineModule::serviceGetNotificationsVote($aEvent)
BxTimelineModule::serviceGetRepostElementBlock($iOwnerId, $sType, $sAction, $iObjectId, $aParams = array())
BxTimelineModule::serviceGetRepostCounter($sType, $sAction, $iObjectId)
BxTimelineModule::serviceGetRepostJsScript()
BxTimelineModule::serviceGetRepostJsClick($iOwnerId, $sType, $sAction, $iObjectId)
BxTimelineModule::serviceGetMenuItemAddonComment($sSystem, $iObjectId)
BxTimelineModule::serviceGetSettingsCheckerHelper()
VndDisqusModule::serviceMain() 
VndMuutModule::serviceMain () 
AbstractService::service()

// Studio related functionality
BxDolStudioInstallerUtils::serviceDownloadFileComplete($sFilePath, $aParams = array())
BxDolStudioInstallerUtils::servicePerformAction($sDirectory, $sOperation, $aParams)
BxDolStudioInstallerUtils::servicePerformModulesUpgrade($bEmailNotify)
BxDolStudioModules::serviceGetActions($aWidget)
BxBaseStudioDashboard::serviceGetWidgetNotices() {
BxBaseStudioDashboard::serviceGetBlockVersion()
BxBaseStudioDashboard::serviceGetBlockSpace($bDynamic = false)
BxBaseStudioDashboard::serviceGetBlockHostTools($bDynamic = true)
BxBaseStudioDashboard::serviceGetBlockCache()
BxBaseStudioDesignServices::serviceAlertResponseSettingsSave($oAlert)
BxBaseStudioLauncher::serviceGetCacheUpdater()
BxBaseStudioSettingsServices::serviceAlertResponseSysImagesCustomFileDeleted($oAlert)
Clone this wiki locally