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

Integrating as a dealer group

Discovery, build, validation and production rollout. Most of it is self-service: the documentation, specification and sample data are public, a dealer’s administrators issue keys for that dealer themselves, and a platform serving many dealers is connected by each dealer with one click. BHC is involved only where a step requires it, and this page states where that is.

What you need from us

To do thisYou need from us
Get an API key for one dealer or one dealer groupNothing. Anyone with an owner or admin login in that dealer’s portal creates one, picks the access level, and passes it to you. Under a minute, no involvement from us.
Serve many dealers from one piece of softwareA platform credential, by invitation. Email info@batteryhealthcheck.co.uk. After that, each dealer connects you itself; see below.
Read the documentation, spec and field referenceNothing. All public, no login, linked in the header. The Postman collection has a request for every endpoint.
Get realistic data to build againstA sandbox credential, on request: fixture tests on the production base URL for every case (see Sandbox). Without one, the sample response pack shows real responses, anonymised, for the common cases.
Look up tests, download certificates, receive webhooksNothing. A dealer-issued key or a connected platform credential covers all of it.
Create dealer accounts or order AVILOO units over the APIThis one you do need us for. It is for a dealer group’s own sites, on a dealer-group credential: the write:dealers scope is not self-serve, and a platform credential cannot hold it. Email info@batteryhealthcheck.co.uk.
Lock a credential to your egress addressesAsk us — see IP allow-listing.
Help when something is wrongEmail info@batteryhealthcheck.co.uk.

The four steps

For one dealer or one dealer group. A platform serving many dealers follows the same steps on its own credential: see Building software for many dealers?

  1. Get a key from the dealer

    The dealer administrator issues the credential from the BHC portal and provides it to you. For a website or vehicle-listing integration we recommend read-only access, which permits retrieval of test results and certificates without provisioning or ordering permissions.

  2. Read

    The documentation is the whole reference on one page, including three worked examples. If your team generates clients, take the OpenAPI spec; to try calls by hand, import the Postman collection. If they want the field-by-field detail with units and vocabularies, take the data dictionary.

  3. Build against the sandbox

    Ask us for a sandbox credential: it calls the production base URL, behaves as a platform credential connected to fixture dealers, and answers from fixture tests, the awkward cases included (a provisional reading, an inconclusive test, a failed one, a retest), with simulated webhook events. See Sandbox, and try each endpoint in your browser in the API explorer. The sample response pack shows real responses, anonymised. Build against the full set of cases rather than the successful one alone.

  4. Go live

    Point it at that dealer’s real tests. If you then find yourself serving a second and a third dealer, move to a platform credential rather than collecting a key from each.

Building software for many dealers?

If you are a DMS, website or stock-publishing platform serving several Battery Health Check dealers, hold one platform credential for your whole platform. Each dealer connects it to you; you never collect, store or rotate a key per dealer.

Software for many dealers is the step-by-step guide, with a worked example.

Building for a single dealer group, or as an agency for one? A key the group issues from its own portal is enough: follow the four steps. That key sees the group’s own sites only.

Before you go live

This is a checklist, not a gate. Nobody inspects your integration and there is nothing to sign off. It is here because these are the things that go wrong.

Once you are live

Getting helpinfo@batteryhealthcheck.co.uk. Include the request_id from any failed call, your client_id (never your secret), timestamps in UTC, and what you expected versus what happened.
ResponseOne business day for standard issues. Faster where something is broken in production.
ChangesWe add fields without notice — ignore keys you do not recognise. We do not rename or remove them, change types or units, or repurpose status codes. Breaking changes ship on a new version path, never in place.
Adding dealersOn a platform credential, nothing needed from us or from you: each new dealer connects you from your button, and appears in GET /v1/connections and in a bhc.connection.created event. A dealer group’s own key already covers branches the group adds.
Rotating a keyA dealer revokes and reissues its own keys from its portal. Credentials we issued are rotated through us; a platform credential’s connections stay with it, so read Key rotation first.