Types of API Call
Bidlogix offers three types of API along with the follow calls:
Item Management
Call: Create Auction
Call: Create Items
Reference Data
Call: Auction Data
Call: Auctioneer Data
Call: Category Data
Call: Fetch Reference Data
Call: Vendor Data
Reporting
Call: Auction Item Reports
Call: Auction Reports
Call: Category Reports
Call: User Reports
Structure of API Calls
It is vital to structure API Calls properly to receive the correct information, retain security and minimise the chance or errors.
HTTP Header Info
For all API calls set the following headers:-
headers.setContentType(application/json);
headers.set(X-Api-Name, bidlogixapi);
headers.set(X-Api-Password, <<client password>>);
Please Note
All HTTP headers should be in lower case
API Signature in Header
All API calls must have the signature in the header, as described in this document: API Security - Generating your Signature.
Substitutions / Query String Parameters
The following query string parameter applies to all API calls:
|
where your_bidlogix_client_id is the id of your bidlogix web application id.
You must also substitute your domain into each call. For example, an API Call would look like this in documentation:
https://your_bidlogix_domain/auction-mgt/bdxapi/auctioneersnoauctionids?clientId=your_bidlogix_client_id
And this in practise:
https://yourwebsite.com/auction-mgt/bdxapi/auctioneersnoauctionids?clientId=123
There are substitutions / query string parameters specific to many calls. These are specified in their particular document.
(Note that there are slight adaptations for image related query string parameters, as described in the appropriate document. See UrlAttachmentAPIModel.)
Results
Example results are given for each API within their specific document. You will find more information in our documents Common Data and Status Codes.
Mime Types
All requests return json by default. The format of GET requests can be changed to CSV by adding the parameter 'format'.