Документация по API

API - решение для работы с нашим сайтом при помощи программных средств.
Данный раздел в основном предназначен для разработчиков программного обеспечения.

Ваш токен для авторизации запросов:

После выпуска, токен будет отправлен в телеграм



Механизм работы (важно)

Все запросы должны посылаться на адрес:
https://api.anyshop.su/метод?параметр=значение

Тип запроса может быть любым: GET | POST
Для доступа к методам API вы обязательно должны передать параметр token в GET или POST параметрах
Поддерживаются аргументы в формате json

Для проверки вашего токена вы можете перейти по ссылке (или отправить запрос любого типа) на URL:
https://api.anyshop.su/test/?token=После выпуска, токен будет отправлен в телеграм

Для методов, в которых может быть большой ответ (например, список категорий и позиций), максимум выдаётся до 500 элементов. Для таких методов доступен аргумент offset - смещение, начиная с которого будут выдаваться данные.



Методы


Получение списка магазинов

Адрес: https://api.anyshop.su/list/shops

Параметр Статус Тип Описание
Параметры не требуются

Ответ
Список запрошенных полей.

Параметр Тип Описание
id Число ID магазина
name Строка Название магазина
paid_before Число Оплачен до (в формате timestamp)
status Строка Статус магазина (Открыт | Скрыт)
Пример использования:
https://api.anyshop.su/list/shops?token=После выпуска, токен будет отправлен в телеграм



Получение списка категорий

Адрес: https://api.anyshop.su/list/categories
За один запрос можно получить до 500 категорий

Параметр Статус Тип Описание
shop_id Обязателен Число ID магазина. Можно получить в методе list/shops
offset Необязательно Число Смещение, начиная с которого выдаются данные.

Ответ
Список категорий.

Параметр Тип Описание
id Число ID категории
title Строка Название категории
hidden Число Спрятана ли категория (1 - да, иначе нет)
image Строка Ссылка на картинку категории
parent Число ID родительской категории (может быть пустым, если категория не является дочерней)
web_hidden Число Спрятана ли категория на сайте
hide_if_empty Число Прятать ли категорию, если в ней закончились товары (1 - да, иначе нет)
count Число Общее кол-во категорий
Пример использования:
https://api.anyshop.su/list/categories?shop_id=-1&token=После выпуска, токен будет отправлен в телеграм



Получение списка позиций каталога

Адрес: https://api.anyshop.su/list/catalog
За один запрос можно получить до 500 позиций

Параметр Статус Тип Описание
shop_id Обязателен Число ID магазина. Можно получить в методе list/shops
category_id Необязательно Число ID категории. Можно получить в методе list/categories (метод выше)
offset Небязательно Число Смещение, начиная с которого выдаются данные.

Ответ
Список позиций.

Параметр Тип Описание
id Число ID позиции
title Строка Название позиции
description Строка Описание позиции
price Дробное число Цена позиции в рублях
old_price Дробное число Старая цена. "Визуальная" скидка для пользователя
left Число Остаток товаров на продаже
cost_price Дробное число Себестоимость товара (для статистики)
hidden Число Спрятана ли позиция (1 - да, иначе нет)
cat_id Число ID категории
min_count Число Минимум к покупке
max_count Число Максимальная кол-во товаров к покупке за раз
use_wholesale Число Включены ли оптовые цены (1 - да, иначе нет)
wholesale_percent Число Процент оптовой скидки
wholesale_count Число Минимальное кол-во для включения оптовых цен
image Строка Ссылка на картинку позиции
hide_if_empty Число Прятать ли позицию, если закончились товары (1 - да, иначе нет)
count Число Общее кол-во позиций (в этой категории или вообще в магазине)
Пример использования:
https://api.anyshop.su/list/catalog?token=После выпуска, токен будет отправлен в телеграм&category_id=1&shop_id=1



Получение статистики магазина

Адрес: https://api.anyshop.su/stats

Параметр Статус Тип Описание
shop_id Обязателен Число ID магазина. Можно получить в методе list/shops

Ответ
Статистика магазина и телеграм бота.

Параметр Тип Описание
users_count Число Общее кол-во пользователей телеграм бота
active_users Число Кол-во активных пользователей телеграм бота (до которых доходит рассылка)
inactive_count Число Кол-во неактивных пользователей телеграм бота (до которых не доходит рассылка)
profit_total Число Общая чистая прибыль (выручка-себестоимость)
profit_month Число Общая чистая прибыль (выручка-себестоимость) с начала месяца
profit_week Число Общая чистая прибыль (выручка-себестоимость) с начала недели
profit_today Число Общая чистая прибыль (выручка-себестоимость) с начала дня
users_new_month Число Кол-во новых пользователей телеграм бота за месяц
users_new_week Число Кол-во новых пользователей телеграм бота за неделю
users_new_day Число Кол-во новых пользователей телеграм бота за день
Пример использования:
https://api.anyshop.su/stats?token=После выпуска, токен будет отправлен в телеграм&shop_id=1



Загрузка товаров

Адрес: https://api.anyshop.su/upload_goods

Параметр Статус Тип Описание
shop_id Обязателен Число ID магазина. Можно получить в методе list/shops
catalog_id Обязателен Число ID позиции. Можно получить в методе list/catalog
mode Обязателен Строка Способ загрузки товаров. Переданные данные загрузятся как один товар (single), либо переданные данные разобьются по строкам и загрузятся пачкой (multy)
body Обязателен Строка Товары для загрузки. Если режим multy - до 5000 товаров за раз. В режиме single до 4096 символов

Ответ
Статистика магазина и телеграм бота.

Параметр Тип Описание
count Число Кол-во загруженных товаров
left Число Новый остаток товаров
Пример использования:
https://api.anyshop.su/upload_goods?token=После выпуска, токен будет отправлен в телеграм&shop_id=1&catalog_id=1&mode=single&body=Тест



Выгрузка товаров

Адрес: https://api.anyshop.su/list/goods
За один запрос можно получить до 1000 товаров

Параметр Статус Тип Описание
shop_id Обязателен Число ID магазина. Можно получить в методе list/shops
catalog_id Обязателен Число ID позиции. Можно получить в методе list/catalog
offset Необязательно Число Смещение, начиная с которого выдаются данные.

Ответ
Выгруженные товары.

Параметр Тип Описание
goods Массив Список товаров позиции
count Число Сколько всего товаров доступно к выгрузке
Пример использования:
https://api.anyshop.su/list/goods?token=После выпуска, токен будет отправлен в телеграм&shop_id=1&catalog_id=1



Скрытие категорий

Адрес: https://api.anyshop.su/hide/category

Параметр Статус Тип Описание
shop_id Обязателен Число ID магазина. Можно получить в методе list/shops
category_id Обязателен Число ID категории. Можно получить в методе list/categories

Пример использования:
https://api.anyshop.su/hide/category?token=После выпуска, токен будет отправлен в телеграм&shop_id=1&category_id=1



Скрытие позиций

Адрес: https://api.anyshop.su/hide/catalog

Параметр Статус Тип Описание
shop_id Обязателен Число ID магазина. Можно получить в методе list/shops
catalog_id Обязателен Число ID позиции. Можно получить в методе list/catalog

Пример использования:
https://api.anyshop.su/hide/catalog?token=После выпуска, токен будет отправлен в телеграм&shop_id=1&catalog_id=1



Открытие категории

Адрес: https://api.anyshop.su/show/category

Параметр Статус Тип Описание
shop_id Обязателен Число ID магазина. Можно получить в методе list/shops
category_id Обязателен Число ID категории. Можно получить в методе list/categories

Пример использования:
https://api.anyshop.su/show/category?token=После выпуска, токен будет отправлен в телеграм&shop_id=1&category_id=1



Открытие позиции

Адрес: https://api.anyshop.su/show/catalog

Параметр Статус Тип Описание
shop_id Обязателен Число ID магазина. Можно получить в методе list/shops
catalog_id Обязателен Число ID позиции. Можно получить в методе list/catalog

Пример использования:
https://api.anyshop.su/show/catalog?token=После выпуска, токен будет отправлен в телеграм&shop_id=1&catalog_id=1



Получение курса доллара и списка доступных платёжных систем

Адрес: https://api.anyshop.su/pay_data

Параметр Статус Тип Описание
shop_id Обязателен Число ID магазина. Можно получить в методе list/shops

Ответ
Курс доллара, установленный в настройках магазина и список доступных платёжных систем (их ID)

Параметр Тип Описание
rate Дробное число Курс доллара
payment_systems Массив ID доступных платёжных систем

Пример использования:
https://api.anyshop.su/pay_data?token=После выпуска, токен будет отправлен в телеграм&shop_id=1



Создание оплаты

Адрес: https://api.anyshop.su/new_order

Параметр Статус Тип Описание
shop_id Обязателен Число ID магазина. Можно получить в методе list/shops
amount Обязателен Дробное число Сумма оплаты в рублях
payment_system Обязателен Число Метод оплаты, можно получить в методе pay_data

Ответ
Курс доллара, установленный в настройках магазина и список доступных платёжных систем (их ID)

Параметр Тип Описание
buy_id Число Порядковый номер оплаты
comment Строка Уникальный комментарий, можно использовать как идентификатор или временный пароль оплаты
payment_link Строка Ссылка на оплату для пользователя
payment_system Число ID платёжной системы
usd_amount Дробное число Сумма оплаты в долларах по текущему курсу, установленному в настройках магазина

Пример использования:
https://api.anyshop.su/new_order?token=После выпуска, токен будет отправлен в телеграм&shop_id=1&payment_system=19&amount=100



Проверка оплаты

Адрес: https://api.anyshop.su/check_order

Параметр Статус Тип Описание
shop_id Обязателен Число ID магазина. Можно получить в методе list/shops
comment Обязателен Строка Комментарий оплаты (получается в ответе в методе new_order)

Ответ
Статус оплаты

Параметр Тип Описание
state Строка Статус оплаты, возможные варианты: Ожидание | Оплачено | Исполнено | Истёк. Оплаченным счёт считать только если статус стоит Исполнено
comment Строка Уникальный комментарий
payment_system Строка ID платёжной системы
amount Число Сумма оплаты в рублях
usd_amount Дробное число Сумма оплаты в долларах по текущему курсу, установленному в настройках магазина

Пример использования:
https://api.anyshop.su/check_order?token=После выпуска, токен будет отправлен в телеграм&shop_id=1&comment=ghf2729871



Просмотр всех счетов на оплату

Адрес: https://api.anyshop.su/all_orders

Параметр Статус Тип Описание
shop_id Обязателен Число ID магазина. Можно получить в методе list/shops
count Необязательно Число Количество записей. Допустимые значения от 1 до 150. По умолчанию 100
offset Необязательно Строка С какой записи начинать отображение. Записи отсортированы по уменьшению ID. По умолчанию 0, допустимые значения от 0 до 1000000

Ответ
Список ордеров

Параметр Тип Описание
orders Массив Массив с объектами ордеров
Объект ордера:
ID Число Порядковый номер ордера
catalog_id Число ID позиции в каталоге
amount Число Сумма счёта. Если покупка товара - стоимость 1 шт товара, если пополнение баланса - сумма для пополнения
time Число Время создания счёта в unix timestamp
status Строка Статус оплаты: "Ожидание", "Оплачено", "Исполнено".
comment Строка Уникальная строка, которая привязывается к любой оплате
payment_system Строка ID платёжной системы
telegram_id Число BIG INT ID телеграм пользователя, который создал счёт. Если счёт создан через сайт, то значение -1
promocode Число ID промокода. Если пользователь не указывал промокод, то значение -1
is_bot_deposit Число Bool Является ли счёт пополнением баланса в боте. 1 - да, 0 - нет
usd_amount Число Сумма оплаты в долларах на момент создания ордера

Пример использования:
https://api.anyshop.su/all_orders?token=После выпуска, токен будет отправлен в телеграм&shop_id=1



Подтверждение ручной оплаты

Адрес: https://api.anyshop.su/confirm_manual

Параметр Статус Тип Описание
shop_id Обязателен Число ID магазина. Можно получить в методе list/shops
buy_id Обязателен Число ID ордера. Узнать можно в методе /all_orders или в личном кабинете

Ответ
Статус операции

Параметр Тип Описание
Специального ответа нет, либо {"status" : "ok"}, {"status" : "err"} с пояснением ошибки

Пример использования:
https://api.anyshop.su/confirm_manual?token=После выпуска, токен будет отправлен в телеграм&shop_id=1&buy_id=1



Изменение статуса оплаты

Адрес: https://api.anyshop.su/change_order_status

Параметр Статус Тип Описание
shop_id Обязателен Число ID магазина. Можно получить в методе list/shops
id Обязателен Число ID ордера. Узнать можно в методе /all_orders или в личном кабинете
status Обязателен Строка Какой статус для ордера установить. Возможные значения: "Ожидание", "Исполнено"

Ответ
Статус операции

Параметр Тип Описание
Специального ответа нет, либо {"status" : "ok"}, {"status" : "err"} с пояснением ошибки

Пример использования:
https://api.anyshop.su/change_order_status?token=После выпуска, токен будет отправлен в телеграм&shop_id=1&id=1&status=Исполнено



Информация о пользователе

Адрес: https://api.anyshop.su/telegram_user

Параметр Статус Тип Описание
shop_id Обязателен Число ID магазина. Можно получить в методе list/shops
tg_id Обязателен, если не указан username Число Телеграм ID пользователя
username Обязателен, если не указан tg_id Число Логин пользователя телеграм

Ответ
Информация о пользователе

Параметр Тип Описание
balance Дробное число Текущий баланс пользователя
nickname Строка Логин пользователя
telegram_id Строка ID телеграм пользователя
time_joined Число Время, когда пользователь создал диалог с ботом в формате UNIX

Пример использования:
https://api.anyshop.su/telegram_user?token=После выпуска, токен будет отправлен в телеграм&shop_id=1&tg_id=1234



Изменение баланса пользователя

Адрес: https://api.anyshop.su/change_balance

Параметр Статус Тип Описание
shop_id Обязателен Число ID магазина. Можно получить в методе list/shops
tg_id Обязателен Число Телеграм ID пользователя
balance Обязателен Строка На что изменяем баланс, можно отправить в 3 форматах: +число (либо pчисло, прибавит к текущему балансу число), -число (либо mчисло, вычтет из текущего баланса число), число (установит баланс на это число)
comment Необязательно Строка Этот текст отправится пользователю после изменения его баланса. Можно пояснить за что происходит снятие денег.

Ответ
Новый баланс пользователя

Параметр Тип Описание
curr_balance Дробное число Текущий баланс пользователя

Пример использования:
https://api.anyshop.su/change_balance?token=После выпуска, токен будет отправлен в телеграм&shop_id=1&tg_id=1234&balance=-100








ANYSHOP

Anyshop - сервис для быстрого создания собственных онлайн магазинов. Как создать свой онлайн магазин? Ответ прост: зайдите на anyshop