In addition to our Nimbb Player, the API also contains a Web Service
. The Web Service allows you to get additional functionalities without going through the Nimbb Player. Using a function is as easy as calling an URL and parsing the returned XML data. Most of the time you will use the Web Service from server-side code.
Important: To use the Web Service, you must have an active paying subscription (Bronze or higher).
At each function call, you must provide your developer's public key and your private key (except for the Account/Get function and the Live functions). This is essential to authenticate your request. Without this information, your query will be rejected.
All functions of the Web Service are intended to be used with server-side code (except for Live functions). If you call the functions from client HTML code, you would be exposing your private key, which is a security breach to your account. Make sure that your visitors can't see your private key by looking at your site's HTML code.
SSL access: All functions can be called using secure HTTPS calls like "https://api.nimbb.com/". To use SSL, you must have a Platinum or higher subscription.
Here is the list of Web Service functions you can call.
- Each function call may return error codes. See the description page of Errors to manage them;
- All dates returned by the Web Service are in UTC format (Universal Time Coordinated);
- You can optionally specify a language parameter "l" to get error messages in the appropriate language (examples: l=en, l=fr).
Here is the list of Live functions you can call directly inside your HTML code. These only requires your public
developer key and will only work in sites you have specified in your settings.