Skip to content
Last updated

Hauler Hero uses two authentication headers depending on the direction of the API call.

Inbound APIs — you call Hauler Hero

Applies to: Account API, Scale API

  • Header: HERO-API-KEY
  • Base URL: https://api.haulerhero.com
  • How to get a key: contact your Hauler Hero account manager or integrations@haulerhero.com

The HERO- prefix disambiguates your Hauler Hero key from any other API keys you may be handling in the same request.

Example

HERO-API-KEY: your_hauler_hero_key_here

Outbound APIs — Hauler Hero calls you

Applies to: Site API, Vision API

These APIs are implemented by integration partners on partner-operated infrastructure.

  • Header: API-KEY
  • Issued by: the partner, to Hauler Hero
  • How it works: the partner implements the endpoint, generates an API-KEY, and provides it to Hauler Hero. Hauler Hero sends that key in the API-KEY header when calling the partner's endpoints.

No HERO- prefix is used because the key is issued by the partner, not by Hauler Hero.

Example

API-KEY: your_partner_issued_key_here

Quick reference

APIDirectionHeaderIssued by
Account APIInboundHERO-API-KEYHauler Hero
Scale APIInboundHERO-API-KEYHauler Hero
Site APIOutboundAPI-KEYPartner
Vision APIOutboundAPI-KEYPartner