Главная страницаZenky API
GitHub

Zenky API v2

Узнайте, как работать с Zenky API для создания сайтов, мобильных приложений или интеграций с внешними системами.

Начало работыOpenAPI документация
products.js
categories.js
import { getProducts } from '@zenky/api';
import { ref } from 'vue';
 
export function useProductsList() {
 const products = ref([]);
 const load = async () => {
 products.value = await getProducts({
 count: 20,
 search: 'iPhone',
 });
 };
 
 return { 
 products,
 load,
 };
}

Введение

О документации

Изменено 2023-07-19

Познакомьтесь с документацией Zenky API.

Эта документация предназначена для разработчиков, использующих Zenky API для создания сайтов и приложений интернет-магазинов или для разработки интеграций с внешними системами учёта (такими, как 1C, Iiko и другие).

Если вы хотите получить информацию о том, как работать с панелью администратора Zenky, используйте документацию для пользователей.

#Как устроена документация

Эта документация содержит гайды по работе с Zenky API. Основной упор в ней сделан на то, чтобы объяснить для чего нужны конкретные сущности API, как их правильно использовать, а так же дать базовые сценарии различных интеграций.

Мы не приводим подробные описания всех методов API (а какие-то можем и не затрагивать вовсе). Вместо этого в нужных местах мы будет давать ссылки на нашу OpenAPI-спецификацию, в которой вы найдёте полную информацию о методах API.

Такой подход позволяет нам разделить туториалы (текущий сайт) и сугубо технические данные (спецификация), не дублируя одну и ту же информацию в разных местах.

В левой части сайта расположена глобальная навигация по всей документации, разделённая на секции и статьи.

Внутри каждой статьи есть оглавление, расположенное в правой части сайта (не отображается в мобильной версии сайта).

Некоторые статьи могут содержать примеры кода на нескольких языках программирования. Для переключения нужного языка используйте вкладки-заголовки. При изменении языка он будет сохранён и впоследствии будет выбран по умолчанию.

Вызвать окно поиска по документации можно комбинацией клавиш Control+K (Windows, Linux) или Cmd+K (macOS), либо кликнув на поле ввода (или иконку поиска в мобильной версии) в шапке каждой страницы.

#Версии API

Сейчас вы находитесь на главной странице версии v2 (сейчас это стабильная версия Zenky API). Все разделы документации, которые относятся к этой версии, имеют префикс /docs/v2 в их адресах.

Далее
Начало работы →