Thank you for choosing BidJS! This document aims to prepare you for installing and maintaining your BidJS software, along with explaining how elements of the software work.
This document covers the following:
- Website Requirements
- Knowledge Requirements
- Configuration Details
- Version Updates
- Modules and Options
- FAQs and Common Errors
You will also require a website on which to place our application.
The specifics of the website aren't too important, as long as you have the ability to do the following:
HTMLdirectly on to the page(s) on which you require the BidJS Client
<link>tags to the
<head>of your page(s) on which you require the BidJS Client
If you wish to add custom styles to the BidJS Client, you will also need the ability to update the
CSS on your website.(3)
You will be required to work with the following:
- Visual hooks
Optionally you may also require:
After registering a Webapp(1) with Bidlogix, you will be provided with several pieces of key information.(2)
You'll require this for your setup:
- An API Base Endpoint
- A Static Resources Endpoint
- A Client Identifier
Combined, these settings will allow your website to connect with our system.
Usually you will initially be given the demonstration page endpoint details. Any information you put onto this page will be visible publicly and to other potential clients. Please do not upload sensitive information to the demonstration page.
(1) Webapp - Your account on our servers, representing your website or business
(2) If you haven't received this information, please contact email@example.com
Installing BidJS successfully involves putting code into relevant HTML tags on your website and then choosing and applying appropriate customisation such as modules and configuration of options. For full information on installing BidJS, you can find our installation guide here.
BidJS and its Versions are updated often depending on our release schedule. As of BidJS version 2.1 (October 2019), clients will be able to take advantage of only updating major BidJS versions (i.e. V2, V3 rather than V2.1, V2.2, etc.). This should reduce the input required by developers/technical staff and ensure that you are always using the most up to date version of our software without any further adjustment between major versions.
BidJS and its Modules currently have different version numbers. If you are unsure which version is required, please contact us on firstname.lastname@example.org. You can also find out more about updating your version numbers here.
Modules and Options
As stated above, Modules may have a different version number to the main BidJS version so please ensure you are using the correct version.
FAQs and Common Errors
If you have any queries we have an extensive collection of FAQs, common errors and best practice recommendations. You can also contact us on email@example.com.