Developer

Api Documentation & Resources

Welcome great developer!

On the following pages you can find documentation and resources of the bidvoy API. Every application out there helps us to make bidvoy more awesome. So, if you are programming based on our API feel free to contact us anytime. We are really looking forward to your feedback in order to extend the API here and make it better. We really love to here from your project!

Get started.

The first step is always the hardest.. but not here. We designed our API in a way that it is easy to understand and simply to handle. No one wants to read pages of text before getting started. That's why we present you a short overview of our endpoints together with a sample call for each method to make it more concrete.

API token

Right now our API is kind of a beta version. That means that you need a token to authorize your application and are allowed to make calls. How do you get such a key? Easy as pie. Just drop us a line (info@bidvoy.net) containing the following information:
  • Where do you want to use it? (domain)
  • What do you want to do? (a short description is fine)
After we have approved your request, you get your personal API token and you can start immediately. Again the whole procedure is because of the beta state of our API. We promise that everything gets easier later.

Github

We created a repository for this api on github, so all of your feedback, suggestions or bug reports can and should be filed there as an issue. There is also a small repo containing few api examples for better understanding. We will extend this one with more examples later.

Documentation

Account

CallDescription
GET account/usageEach api token has a limited number of calls for each month. This method shows you the limit of your key and provides you with the number of calls you have done.

Category

CallDescription
GET category/getReturns a category object specified by its unique id.
GET category/searchbynameThis method returns a list of categories based on your category search attribute.
GET category/searchbykeywordReturns a list of categories in which your product occures at least once.

Article

CallDescription
GET article/analyseThe actual search routine. Provides you with statistical data based on your given product and category.