Skip to content
English
More support
Go to Bookvault
  • There are no suggestions because the search field is empty.

Getting Started With the Bookvault API

Learn how to generate your Bookvault API credentials and use your API key to connect Bookvault with your own system.

Getting Started With the Bookvault API

Learn how to generate your Bookvault API credentials and use your API key to connect Bookvault with your own system.

The Bookvault API lets you access Bookvault features through your own system.

To get started, you first need to generate your API credentials through the Bookvault portal.

How do I generate my Bookvault API credentials?

In the Bookvault portal:

  1. Go to the Apps page.
  2. Under Bookvault API, select Generate Credentials.
  3. Read the information shown, then select Generate New Key.
  4. The page will refresh and display your API key.

Important: Your API key is only displayed once.

If you lose it, you will need to generate a new key.

How do I use my API key?

Once you have your key, include it in the authorisation header of your request:

Authorization: basic bv_YOUR_API_KEY
Where can I find the Bookvault API documentation?

Can I upload my book files through the API?

For standard Bookvault titles, no.

The Bookvault API can be used to create titles and place orders, but the cover and interior files for a standard title must still be uploaded manually through the Bookvault portal.

If you're working with personalised books using transient titles, the process is different. Transient API orders allow the required files to be supplied for each individual order.

For more information about using and integrating with the API, see the latest Bookvault API documentation:

View the Bookvault API documentation

If you want to learn more about connecting a custom website to Bookvault, see:

What Websites Can I Connect to Bookvault?

What happened to the bulk filedrop feature?

The API's previous bulk filedrop feature is no longer available.

This feature was intentionally removed and isn't a temporary outage or upload error.

For standard Bookvault titles, cover and interior files should be uploaded through the Bookvault portal.

If you're producing personalised books where different files are supplied for each order, you can instead use transient titles through the Bookvault API.