Skip to main content

Quickstart

DealerOS is a multi-tenant automotive dealer SaaS. This guide helps an integrator or contributor get oriented.

What the app does

DealerOS provides vehicle inventory management, a public marketplace with lead capture, CRM, self-serve signup and onboarding, Stripe-backed billing, and a provider abstraction layer for third-party automotive integrations (VIN decoding, valuations, etc.).

Host map

  • https://dealeros.pndsvcs.com — marketing site
  • https://app.dealeros.pndsvcs.com — web console
  • https://api.dealeros.pndsvcs.com — API

Authentication model

  • Users authenticate through Auth0 (authorization-code + PKCE web login, RS256 JWT/JWKS)
  • The API is default-deny: all protected routes require:
    • Authorization: Bearer <auth0-access-token>
    • x-dealeros-tenant-id: <tenant-uuid>
  • Public routes (health, signup, public marketplace, webhooks) are explicitly marked
  • The web app uses encrypted, signed HTTP-only session cookies

Public integration points

  • Public marketplace API: listing search and detail at /v1/public/marketplace/ (unauthenticated)
  • Webhook endpoints: signature-verified handlers at /webhooks/stripe, /webhooks/providers/:providerKey, and /webhooks/resend
  • Lead capture: public lead ingestion at /v1/public/marketplace/listings/:slug/leads
  • Media delivery: public media at /v1/public/media/:mediaAssetId

Where to go next

  • Architecture overview — application boundaries, persistence, authentication, configuration, and deployment
  • API reference — all backend endpoints, web handlers, and request examples