@itarius-ug/bipro-box-api-client

BiPRO Box API Client

Installation

pnpm i @itarius-ug/bipro-box-api-client

Example Usage

import { Bipro } from "./bipro.js";
import { ApiStatus } from "./postbox.contracts.js";

const bipro = new Bipro({
  baseUrl: "https://www.bipro-box.de/app/core/api/json/v1.0",
  token: "<my-api-token>",
});

(async () => {
  try {
    // fetch all available documents (postbox_api_status = 0)
    const response = await bipro.postbox().all();

    for (const postbox of response.postbox) {
      // fetch single document by id
      const { postboxData } = await bipro.postbox().get(postbox.postbox_id);

      console.log(postboxData);

      // mark document as processed (postbox_api_status = 1)
      await bipro
        .postbox()
        .update(postbox.postbox_id, { apiStatus: ApiStatus.Processed });
    }
  } catch (error: unknown) {
    console.error((error as Error).message);
  }
})();

Credits

This project exists thanks to all the people who contribute.

License

CC-BY-ND-4.0 © Itarius UG