Spryker Documentation

website·Indexed 36 days ago

https://docs-archive.spryker.com

Documentation for Spryker Cloud Commerce OS, an enterprise e-commerce platform-as-a-service designed for B2B, B2C, and Marketplace business models.

Tokens
1.1K
Snippets
0
Records
9
Agent score
3%

What's inside Spryker

  1. Navigate Spryker Documentation Sections

    The documentation is organized into the following primary sections to help users find specific information:

    • Developer Guide (DG): Technical instructions for backend/frontend development, architecture, deployment, and local setup (Docker).
    • Packaged Business Capabilities (PBC): A catalog of business features including Commerce Core (Cart/Checkout), Product Management (PIM), Customer Management (CRM/IAM), and B2B/Marketplace specific features.
    • Cloud Administration (CA): Guidance on managing cloud infrastructure, deployment pipelines, monitoring, and logging.
    • Integrations: Documentation for the App Composition Platform (ACP), Glue API, and third-party connectors (e.g., Algolia, Stripe, Vertex).
  2. Understand Spryker's Technical Architecture

    Spryker's architecture is divided into four primary layers:

    • Presentation Layer (Yves): Handles the customer-facing storefront, mobile apps, and voice skills.
    • Business Layer (Zed): Manages business logic, product catalogs, pricing, and inventory.
    • Communication Layer (Glue API): A RESTful API facilitating communication between the storefront and backend.
    • Persistence Layer: Manages database operations using Propel ORM, Redis, and Elasticsearch.

    Core Technology Stack:

    • Backend: PHP 8.3+, Symfony components, Propel ORM
    • Frontend: Twig templates, Web Components, TypeScript
    • Infrastructure: Docker, Kubernetes, AWS/Azure
    • Data Stores: PostgreSQL, Redis, Elasticsearch, RabbitMQ
    • CI/CD: Jenkins, GitHub Actions
  3. Spryker Cloud Commerce OS Platform Overview

    Spryker is an enterprise e-commerce platform-as-a-service (PaaS) designed for B2B, B2C, and Marketplace business models. It utilizes a modular, cloud-native architecture consisting of 750+ independent modules that can be installed and configured individually. The platform follows a layered architecture separating presentation, business, communication, and persistence layers, and employs an API-first design via the Glue API to support headless commerce and omnichannel experiences.
  4. Understand Spryker Cloud Commerce OS key terminology

    Spryker uses specific terminology to describe its architecture and functional units:

    • SCCOS: Spryker Cloud Commerce OS (the full product name).
    • PBC (Packaged Business Capability): A functional area of the platform.
    • Module: The smallest unit of functionality (e.g., Cart, Product, Price).
    • Feature: A collection of related modules that provide end-to-end functionality.
    • Demo Shop: A pre-configured shop containing sample data for specific business models.
    • ACP (App Composition Platform): A marketplace for pre-built integrations.
  5. Contribute to Spryker documentation

    Spryker documentation is open-source. Contributions are accepted via pull requests to the GitHub repository. Contributors can report issues, suggest improvements, submit PRs for corrections/additions, and run the documentation locally for testing.
  6. Developer Getting Started Workflow

    Developers should follow these steps to begin working with Spryker:

    1. Review system requirements and prerequisites.
    2. Set up the Spryker environment locally using Docker.
    3. Explore the available Demo Shops (B2B, B2C, and Marketplace) to understand implementation patterns.
    4. Consult the Development Getting Started Guide.
    5. Study the modular architecture and the module system (managed via Composer).
  7. Identify Spryker application layers

    The Spryker platform is divided into three primary application layers:

    • Zed: The Back Office application layer used for administration.
    • Yves: The Storefront application layer facing the customer.
    • Glue: The API application layer providing RESTful endpoints.
  8. Compare Spryker Business Model Suites

    Spryker provides specialized feature sets based on the business model:

    • B2B Suite: Includes company accounts, business units, approval workflows, quote requests (RFQ), and customer-specific pricing.
    • B2C Suite: Focuses on consumer features like wishlists, newsletter subscriptions, and seamless checkout.
    • Marketplace B2B/B2C: Adds multi-merchant capabilities, including merchant portals, offer management, and commission handling, combined with either B2B or B2C core features.
  9. Review Spryker security and compliance standards

    Spryker maintains the following security and compliance measures:

    • Security: Regular audits (e.g., SektionEins, Port Zero), monthly security release notes, a responsible disclosure program, HTTPS/TLS encryption, and multi-factor authentication (MFA).
    • Compliance: GDPR compliance guidelines, General Product Safety Regulation (GPSR) support, TISAX certification, and data protection/privacy controls.