Документация по интеграции Sanly Platform

Обзор

Добро пожаловать в документацию по интеграции платформы Sanly. Этот гайд поможет вам интегрировать вашу платформу с нашей, предоставив API для получения категорий и продуктов с возможностями фильтрации.

Требования

Платформа должна предоставить два API: один для категорий, один для продуктов.
Оба API должны быть в формате RESTful и в формате JSON.
Для API обязательна пагинация.

API Категории

URL

GET /categories

Query Parameters

Parameter	Type	Required	Description
page	int	Optional	Page number for pagination.
limit	int	Optional	Number of items per page (default: 10).

Example Request

GET /categories?page=1&limit=10

Response Format

{
                  "success": true,
                  "last_page": 5,
                  "current_page": 1,
                  "page_size": 10,
                  "total": 50,
                  "data": [
                    {
                      "id": 1,
                      "name_tm": "Kategoriýa TM",
                      "name_ru": "Категория RU",
                      "name_en": "Category EN",
                      "image": " https://example.com/category-image.jpg "
                    }
                  ]
                }

API Продуктов

URL

GET /products

Query Parameters

Parameter	Type	Required	Description
category	int	Optional	Filter products by category ID.
page	int	Optional	Page number for pagination.
limit	int	Optional	Number of items per page (default: 10).

Example request

GET /products?category=1&page=1&limit=10

Response Format

{
                  "success": true,
                  "last_page": 10,
                  "current_page": 1,
                  "page_size": 10,
                  "total": 100,
                  "data": [
                    {
                      "id": 101,
                      "name_tm": "Haryt TM",
                      "name_ru": "Товар RU",
                      "name_en": "Product EN",
                      "description_tm": "Düşündiriş TM",
                      "description_ru": "Описание RU",
                      "description_en": "Description EN",
                      "image": " https://example.com/product-image.jpg ",
                      "category": {
                        "id": 1,
                        "name_tm": "Kategoriýa TM",
                        "name_ru": "Категория RU",
                        "name_en": "Category EN"
                      },
                      "price": 100.0,
                      "special_price": 80.0,
                      "discount_percent": 20
                    }
                  ]
                }

Связаться с поддержкой

Если у вас есть вопросы, пожалуйста, свяжитесь с нами по адресу support@sanlyplatform.com.