Battery Health CheckDevelopers
OpenAPI Samples Postman

Dealer group and platform API. For dealer groups using their own tests, and for software that many dealers use. Running a car-listing site? Marketplace API

API explorer

Every endpoint of the Partner API, generated from the OpenAPI specification, with Try it out against the sandbox.

Using the explorer

  1. Get a sandbox credential. Its client_id starts part_test_; ask us at info@batteryhealthcheck.co.uk (see Getting sandbox access). This page works with sandbox credentials only. It will not send any other client_id, and the API answers a production credential or token used from this page with 403 and the error code sandbox_only, before it does anything else. Call the API with a production credential from your own servers, where you will never see that code.
  2. Press Authorize, enter your sandbox client_id and client_secret, leave the scopes unticked to receive all of yours, and press Authorize. The page exchanges them for a one-hour token at POST /v1/oauth/token. The secret stays in this tab and is not stored.
  3. Open an endpoint, press Try it out, then Execute. Every answer comes from the sandbox’s fixture cars and carries BHC-Environment: sandbox. The parameters and request bodies start filled in with fixture values that work: test 990000001, VIN BHCTESTVIN0000001, and dealer 990001 in the stock check’s body. Fixture test ids start at 990000001 and fixture dealer ids at 990001; the fixture table says what each one shows. POST /oauth/token is the one exception: its form starts with the placeholders part_test_REPLACE_ME and REPLACE_ME, so type your sandbox client_id and client_secret over them, and leave scope empty to receive all of your scopes. You do not need it to try the other operations: Authorize gets their token for you.

A sandbox credential behaves as a platform credential, so a few operations answer it with an error here, as they would answer a platform:

Webhooks you register here are real registrations on your sandbox credential. Before you press Execute on POST /webhooks, put your own receiver’s URL in place of the example’s https://example.com/bhc/webhooks: sent as it stands, the example takes one of your five endpoints and its deliveries go to example.com. DELETE /webhooks/{webhook_id} frees the place again. Then simulate an event to receive one. Prefer a desktop client? Import the Postman collection. For the reasoning behind each endpoint, read the API reference; for each field, the data dictionary.

The endpoints