Introduction

Overview of the Yep Platform REST API and how this technical documentation portal is organized.

Overview Principles Integrations

About this documentation

This portal replaces an older static manual format and reorganizes the Yep Platform REST API documentation in a modern, clear format ready to publish on the corporate website. Content builds on the previous HTML material and consolidates recent API improvements, including OAuth 2.0, partial responses and security hardening.

Current scope

The documentation covers authentication, products, stock, pricing, categories, attributes, custom options, manual reindex and security best practices.

API principles

Pillars that guide API evolution and ensure predictability for integrators.

Compatibility with already certified integrations — no silent contract breaks.
Authentication via OAuth 2.0 with Bearer Token and secure refresh.
Support for partial_success when part of the payload is kept and part ignored.
Robust operation for high-volume scenarios with queue and controlled processing.
Clear error semantics with invalid_fields, invalid_attributes and invalid_attribute_values.

How to navigate

The documentation is organized in five functional domains. Pick an entry point:

Getting startedFirst authenticated call in minutes. OAuth 2.0Token, refresh and healthcheck. ProductsCRUD, linking and images. SecuritySemantics and best practices.