Quick Start - Bubblehouse API

1. Getting access

You need to have access to Bubblehouse API console. Log in at app.bubblehouse.com and click the API item in the navigation sidebar of your shop admin area.

If you don’t see the item, contact Bubblehouse Support to enable API access for your shop.

2. Shared secret

You need a shared secret to use any APIs. A shared secret is simply a base64-encoded key that is used to authenticate API tokens.

You can add one under Shared Secrets section of the API console. We recommend using separate shared secrets for each environment (production, staging, each development environment).

3. Decide which APIs you want to use

Read through the “Use cases” section to see if your use case is covered. For example:

Integrating a custom online shopSteps to use Bubblehouse in a fully custom online shop.High-level overview of all APIsGo back to the home page to read an overview and comparison of all the APIs we offer.

Most clients just use our Blocks API, but many specialized needs are covered by other APIs.

4. Required reading — learn to call our APIs

You need to read through “How to call our APIs” section and the Overview page for the API you’re gonna be using.

Calling RPC APIsA vast majority of Bubblehouse APIs are JSON-based RPCs via HTTP with consistent calling conventions.Value EncodingLearn how we encode timestamps, dates, monetary and optional values.Versioning of APIsBubblehouse is evolving quickly, but our general policy is to avoid churn. Learn to handle versioning with minimal disruption to your codebase.AuthenticationAll APIs are authenticated via JWT tokens that you generate.Rate LimitsLearn about safety limits that prevent an accidental bug in the client from using up all of Bubblehouse resources.

5. Use examples from the API console and overview pages

The API console shows URLs and curl commands to make example calls to the most common APIs.

For more complex examples, refer to the overview pages of the APIs you’re interested in.