Getting Started
Overview

Getting Started with Ecommaps

Ecommaps provides a complete commerce platform API surface with production-ready SDKs and AI integration primitives.

This section gets your team from zero to a working storefront integration quickly, with the same conventions used in production.

What You Will Set Up

  1. API access via a Storefront API key.
  2. Package integration using official npm SDKs.
  3. Buyer journey primitives: products, cart, checkout, customer auth.
  4. Optional AI agent integration for buyer-facing shopping assistants.

Architecture Baseline

  • Public buyer layer: Storefront API (/api/v1/storefront) secured by x-api-key.
  • Customer session layer: Storefront auth endpoints secured by bearer JWT.
  • Commerce SDK layer: @ecommaps/client + optional logic kits.
  • AI layer: @ecommaps/ai-sales-agent + @ecommaps/storefront-kit for variant/promotion logic.

Next Steps

  1. Auth & Access
  2. Create Store (Onboarding)
  3. Dashboard & Site Navigation
  4. Products Workflow
  5. Settings & API Keys
  6. MCP
  7. Installation
  8. Configuration
  9. Storefront API Reference

Notes for Documentation Readers

  • Route examples use placeholders like siteIdentifier. Do not copy store-specific slugs from example screenshots.
  • Dashboard URLs are shown with locale prefixes (for example /ar/... or /en/...) to match your tenant language.