vBulletin API and Mobile Application Options

Allow clients to connect to the vBulletin API.

Please remember to generate an API key here to allow the API to work.

• Variable Name: enableapi
• Data Type: boolean
• Default Value: 0

Enables the API log, allowing administrators to track client behavior (or for debuging purposes). Only enable this option if you really need it. The log is stored in the database and can rapidly become large in size.

• Variable Name: enableapilog
• Data Type: boolean
• Default Value: 0

When “Enable API Log” is set to “Yes”, this option decides whether to log API POST parameters. Please note that POST parameters can contain a lot of data, which can in turn can take up large amounts of database space.

• Variable Name: apilogpostparam
• Data Type: boolean
• Default Value: 0

Enabling this option will allow mobile api users to register their devices with the forum and receive push notifications via Firebase Cloud Messaging. In addition to this option, the server must have a valid “Firebase Cloud Messaging Server Key” below for push notifications to function.

• Variable Name: fcm_enabled
• Data Type: boolean
• Default Value: 1

This is the “Server key” found in the “Cloud Messaging” Tab of your Firebase Cloud Messaging project.
You can get to this tab via (as of 2017-05-18) https://console.firebase.google.com/project/{projectid}/settings/cloudmessaging/ Where {projectid} is the unique id assigned to your firebase project.

After you save this option, you can test the server key here.

• Variable Name: fcm_serverkey
• Data Type: free
• Default Value:

This option specifies the max time (in seconds) the system will wait for a response from the child thread that handles communications with the Firebase Cloud Messaging before timing out and discarding the notification attempt.
Increase this value only if push notifications are not being sent out reliably.

• Variable Name: fcm_worker_remote_timeout
• Data Type: posint
• Default Value: 3

Content types to show in the mobile activity stream.

• Variable Name: mapi_activity_type
• Data Type: free
• Default Value: ["vBForum_Text","vBForum_Gallery","vBForum_Video","vBForum_Link","vBForum_Poll","vBForum_Event"]

If yes, only topics will be displayed in the mobile activity stream.

• Variable Name: mapi_activity_starter_only
• Data Type: boolean
• Default Value: 0

Number of results per page for mobile activity stream.

• Variable Name: mapi_activity_per_page
• Data Type: integer
• Default Value: 15

Only results from the last specified range will be returned by the mobile activity stream.

• Variable Name: mapi_activity_date_range
• Data Type: free
• Default Value: lastMonth