{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Authentication","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"authentication","__idx":0},"children":["Authentication"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Hauler Hero uses two authentication headers depending on the direction of the API call."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"inbound-apis--you-call-hauler-hero","__idx":1},"children":["Inbound APIs — you call Hauler Hero"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Applies to: ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Account API"]},", ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Scale API"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Header:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["HERO-API-KEY"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Base URL:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://api.haulerhero.com"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["How to get a key:"]}," contact your Hauler Hero account manager or ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"mailto:integrations@haulerhero.com"},"children":["integrations@haulerhero.com"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["HERO-"]}," prefix disambiguates your Hauler Hero key from any other API keys you may be handling in the same request."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example","__idx":2},"children":["Example"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"HERO-API-KEY: your_hauler_hero_key_here\n"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"outbound-apis--hauler-hero-calls-you","__idx":3},"children":["Outbound APIs — Hauler Hero calls you"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Applies to: ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Site API"]},", ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Vision API"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["These APIs are implemented by integration partners on partner-operated infrastructure."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Header:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["API-KEY"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Issued by:"]}," the partner, to Hauler Hero"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["How it works:"]}," the partner implements the endpoint, generates an ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["API-KEY"]},", and provides it to Hauler Hero. Hauler Hero sends that key in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["API-KEY"]}," header when calling the partner's endpoints."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["No ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["HERO-"]}," prefix is used because the key is issued by the partner, not by Hauler Hero."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-1","__idx":4},"children":["Example"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"API-KEY: your_partner_issued_key_here\n"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"quick-reference","__idx":5},"children":["Quick reference"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"API"},"children":["API"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Direction"},"children":["Direction"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Header"},"children":["Header"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Issued by"},"children":["Issued by"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Account API"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Inbound"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["HERO-API-KEY"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Hauler Hero"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Scale API"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Inbound"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["HERO-API-KEY"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Hauler Hero"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Site API"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Outbound"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["API-KEY"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Partner"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Vision API"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Outbound"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["API-KEY"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Partner"]}]}]}]}]}]},"headings":[{"value":"Authentication","id":"authentication","depth":1},{"value":"Inbound APIs — you call Hauler Hero","id":"inbound-apis--you-call-hauler-hero","depth":2},{"value":"Example","id":"example","depth":3},{"value":"Outbound APIs — Hauler Hero calls you","id":"outbound-apis--hauler-hero-calls-you","depth":2},{"value":"Example","id":"example-1","depth":3},{"value":"Quick reference","id":"quick-reference","depth":2}],"frontmatter":{"seo":{"title":"Authentication"}},"lastModified":"2026-04-23T21:25:22.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/authentication","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}