Skip to main content

API Platform Overview

The Sapera API Platform provides access to the core functionality of Sapera, enabling seamless integration between your applications and the Sapera ecosystem. This documentation is designed to guide developers and integrators through working with our public APIs in a clear and structured way.

Whether you're looking to automate inventory updates, manage actors and roles, interact with financial entries, or customize data through EAV fields—this section gives you the tools to build powerful, scalable integrations.

What you’ll find in this section

Webshop Integration

Learn how to connect a webshop to Sapera and handle essential tasks such as authentication, inventory syncing, stock control, financial data, and actor management.

EAV Fields

Understand how to extend data models using Entity Attribute Value (EAV) fields. Set or update custom fields on actors with support for different data types.

Actors

A complete overview of how to retrieve, create, and update actors in the Sapera system. Includes detailed information about model updates and practical examples.

Inventory Attributes

Explore how product attributes are structured, how to resolve values dynamically, and how to connect them with templates for products, variants, and instances.

GetProductPage Usage

Step-by-step usage of the GetProductPage endpoint with filtering, pagination, and response structures explained.

Page-Based Fetching

Sapera APIs often rely on Get[Something]Page patterns. Learn how to implement efficient paging with offset, count, and includeOverallEntryCount options.

Getting Started

If you're new to the API platform, start by reviewing:

Need help? Reach out to our support team for technical assistance or integration guidance.