User Agent

All API requests MUST include a valid User-Agent header. This allows us to contact you if there are problems. Requests with no User-Agent header will be rejected.

User Agent Format

The integrator should include the following:

  • Business identifier: BusinessName/AppName
  • Integrator/vendor/agency name and integration type: POS/Kiosk/OnlineOrder/Mobile/Web/SystemIntegrator/Middleware
  • Integration version number
  • Source channel: MobileApp/AppVersion/OSType/DeviceManufacturer/ModelNumber OR
    Web/BrowserVersion/OSType/DeviceManufacturer/ModelNumber
    in the User-Agent header in the following format
    BusinessIdentifier/IntegratorName/IntegrationType/VersionNumber/SourceChannel

Example user agent

Winghouse/Vendor1/OnlineOrder/1.6.2.0/Web/Safari/604.1/Apple/MacbookPro