@bidhive/bidhive v1.0.0

Overview

This library is built to work within an ES6 module environment. It can be used with plain JavaScript, but also contains TypeScript definitions.

Installation

Install via either of the following, dependening on your project's package manager:

npm i @bidhive/bidhive
or
yarn add @bidhive/bidhive

Getting Started

The first thing you'll need to do is register an application from your Bidhive profile:

Click "Register Application"

Which should result in this:

Once registered, take the client ID, client secret and redirect URI values and embed them somewhere in your own application (environment variables, pulled via API, hardcoded etc.).

Environment Variable Example

export CLIENT_ID=aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
export CLIENT_SECRET=bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb
export REDIRECT_URI=https://my-site.com/redirect 

/* At some entry point in your program */
import { AuthAPI } from "@bidhive/bidhive";

AuthAPI.initClient({
    clientId: process.env.CLIENT_ID || "broken",
    clientSecret: process.env.CLIENT_SECRET || "broken",
    redirectUri: process.env.REDIRECT_URI || "broken",
    zone: "ausnz" // "ausnz", "euuk" or "us" depending on where your Bidhive account is registered
});

AuthAPI.promptForLogin();

This will open a window which prompts you to login to Bidhive, if you aren't already logged in.

Assuming the values you passed to initClient were correct. You will then be asked to authorise your application with the permissions selected when registering.

After clicking "Allow", you're all set to start making requests on behalf of your Bidhive user!

Try a few examples:

import { BidAPI, DashboardAPI } from "@bidhive/bidhive";

async function loadBidhiveData() {
    const bids = await BidAPI.loadBids();
    console.log(`Loaded ${bids.length} bids`);

    
    const dateFrom = new Date(2021, 1, 1);
    const dateTo = new Date();
    const aggregations = await DashboardAPI.loadAggregations({
      date_from: dateFrom.toISOString(),
      date_to: dateTo.toISOString(),
    });
    console.log(aggregations);
}

loadBidhiveData();

Have fun!