Developer guide
FXWebSuite was created for extensibility. You can easily take our API and quick customize FXWebSuite for your needs. If you need help, just ask.
Request new reports
If you want to update your site’s information on some custom action, you can do this by informing us by our Blog Ping API. We use the standard weblogUpdates.ping API.
To do this, simply make an HTTP POST request to https://www.fxdevelopment.com/WebSuite/BlogPing and send us a document like the following:
- <?xml version="1.0"?>
- <methodCall>
- <methodName>weblogUpdates.ping</methodName>
- <params>
- <param>
- <value>This is ignored</value>
- </param>
- <param>
- <value>http://www.subscribedsite.com/</value>
- </param>
- </params>
- </methodCall>
In the above example, there are two parameters ‘This is ignored’ which is ignored and ‘http://www.subscribedsite.com/’ which would be the site that is subscribed. You may provide a third parameter to indicate which page of the site was updated.
FXWebSuite will respond to your request with an XML document similar to one below, which shows a successful response.
- <?xml version="1.0"?>
- <methodResponse>
- <params>
- <param>
- <value>
- <struct>
- <member>
- <name>flerror</name>
- <value>
- <boolean>0</boolean>
- </value>
- </member>
- <member>
- <name>message</name>
- <value>Thank you for notifying us.</value>
- </member>
- </struct>
- </value>
- </param>
- </params>
- </methodResponse>
In the event that this request would have been an error, the boolean parameter would have be assigned to 1 and the message would indicate the reason why the request failed.
| Parameter | Description |
|---|---|
| Site Name * | The name of the site. Although this is required, it is completely ignored. |
| Site URL | This is the URL that is subscribed to FXWebSuite. If this site does not exist, the request will fail. This is a required parameter. |
| Changed Page | Instead of reprocessing your entire site, this option allows you to simply just process this updated page. This is optional. |
| Category | This field will be ignored if provided. |
Acquiring reports
We allow you to grab your reports via a simple REST call. This mechanism uses Basic authentication using your standard credentials to acquire an XML report that you can add manipulate in any way you wish.
Note We provide this as a best-effort. We will occasionally make changes that are not backwards compatible. If you have questions about this, please contact us..
To make a request, send it to: https://www.fxdevelopment.com/WebSuite/ReportViewer?api=&site=http://www.subscribedsite.com/ .
The DTD for the XML format is available at https://www.fxdevelopment.com/WebSuite/Site.dtd.
| Field | Description |
|---|---|
| api * | This is a required field to indicate that this request is an API-based request. |
| site * | This is a required field that indicates the subscribed site for which you want information for. |