@jphil/bookwhen-client

[wip]!

An API client library for the Bookwhen booking platform API (v2), written in Typescript for NodeJS. Intended for server-side environments.

Table of Contents

• Overview
• Features
• Installation
• Usage
• Configuration
• Contributing
• Roadmap
• License

Overview

You'll likely be at least somewhat familiar with the Bookwhen booking platform if you've landed here. But if not, you'll want to have a look at their API (v2) documentation. There's also a nice Swagger style layout of the Bookwhen API v2 docs

Features

• Lightweight and easy to integrate
• Fully typed for TypeScript support

Installation

Install via pnpm:

pnpm add @jphil/bookwhen-client

Usage

[wip]!

// ... todo

Configuration

Required configuration options:

• apiKey: Your Bookwhen API key (required)

API requests to the Bookwhen API are authenticated using Basic Authentication with the API Key as the username and a blank password.

API keys can be generated in the API tokens setup area of your Bookwhen account.

Contributing

Please see the docs in the CONTRIBUTIONS.md file, thanks!

Roadmap

• Todo [] - patch in code from previous repo from src [] -

• Keep up with any future changes or additions to the Bookwhen API, additions will be driven mainly by this.

License

ISC License. See LICENSE for more information.