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

Идентификатор пользователя ID и ключ для подписи запросов KEY можнно взять в профиле.

Адрес: https://monecle.com/api/

Тип запросов: GET или POST

Получение заказов

Параметры запроса:

method Метод (GetOrders)
id Идентификатор пользователя из профиля (обязательно)
key Ключ для подписи запросов (обязательно)
from Смещение заказов для выборки (по-умолчанию: 0)
count Количество заказов для выборки (по-умолчанию: 1000, максимум: 5000)
date_from Дата оформления заказ, с которой начинать выборку
date_to Дата оформления заказ, которой заканчивать выборку

Результат:

status Статус выполнения запроса (ok, error)
items Массив выбранных заказов. Заказ содержит следующие поля:
order_id Номер заказа
buyer_id Номер покупателя
date Дата оформления заказа
del Заказ удален
coupons Купоны
total_price Сумма заказа
result_price Оплаченная сумма
status Оплачено
date_paid Дата оплаты
goods Продукты
comment Комментарии менеджера
buyer_comment Комментарий покупателя
seller_comment Комментарии продавца
name Имя покупателя
fename Фамилия покупателя
otch Отчество покупателя
phone Телефон покупателя
email Email покупателя
action Состояние заказа (0-ожидание, 1-перезвонить, 2-отказ покупателя, 3-отказ менеджера)
service_sum Комиссия системы Monecle
comission Комиссия платежной системы
callcenter_sum Комиссия Call-центра
price_wo_discount Цена заказа без скидки
partner1_sum Партнёрские отчисления для партнёров 1го уровня
partner2_sum Партнёрские отчисления для партнёров 2го уровня
partner1 Данные о партнёре 1го уровня:
id Идентификатор
partner2 Данные о партнёре 2го уровня:
id Идентификатор
hash Хэш необходимый для ссылка на страницу оплаты https://monecle.com/pay?id={order_id}&hash={hash}
roistat Параметр для системы Roistat
utm_source UTM метки указанные в заказе (не обязательные поля)
utm_medium
utm_campaign
utm_term
utm_content
count Количество заказов (не зависит от переданных параметров `from` и `count`)
message Информация об ошибке

Пример запроса:
$result = file_get_contents('https://monecle.com/api/?method=GetOrders&id=ID&key=KEY');
echo $result;
{"status":"ok","items":[{"order_id":"77894",....}]}

Получение одного заказа

Параметры запроса:

method Метод (GetOrder)
id Идентификатор пользователя из профиля (обязательно)
key Ключ для подписи запросов (обязательно)
order_id Идентификатор заказа

Результат:

status Статус выполнения запроса (ok, error)
order Данные по заказу. Заказ содержит следующие поля:
order_id Номер заказа
buyer_id Номер покупателя
date Дата оформления заказа
del Заказ удален
coupons Купоны
total_price Сумма заказа
result_price Оплаченная сумма
status Оплачено
date_paid Дата оплаты
goods Продукты
comment Комментарии менеджера
buyer_comment Комментарий покупателя
seller_comment Комментарии продавца
name Имя покупателя
fename Фамилия покупателя
otch Отчество покупателя
phone Телефон покупателя
email Email покупателя
action Состояние заказа (0-ожидание, 1-перезвонить, 2-отказ покупателя, 3-отказ менеджера)
service_sum Комиссия системы Monecle
comission Комиссия платежной системы
callcenter_sum Комиссия Call-центра
price_wo_discount Цена заказа без скидки
partner1_sum Партнёрские отчисления для партнёров 1го уровня
partner2_sum Партнёрские отчисления для партнёров 2го уровня
partner1 Данные о партнёре 1го уровня:
id Идентификатор
partner2 Данные о партнёре 2го уровня:
id Идентификатор
hash Хэш необходимый для ссылка на страницу оплаты https://monecle.com /pay?id={order_id}&hash={hash}
roistat Параметр для системы Roistat
utm_source UTM метки указанные в заказе (не обязательные поля)
utm_medium
utm_campaign
utm_term
utm_content
message Информация об ошибке

Пример запроса:
$result = file_get_contents('https://monecle.com/api/?method=GetOrder&id=ID&key=KEY&order_id=111');
echo $result;
{"status":"ok","order":{"order_id":"77894",....}}

Создание заказа

Параметры запроса:

method Метод (new_order)
id Идентификатор пользователя из профиля (обязательно)
key Ключ для подписи запросов (обязательно)
goods Массив идентификаторов продуктов (обязательно)
force_price Сумма заказа
original_price Цена заказа без скидки
buyer Покупатель: array('email' => string, 'phone' => string, 'name' => string, 'fename' => string, 'country' => string, 'skype' => string, 'address' => string, 'vk_id' => integer)
order_by (строка) определяет контакт пользователя, с которого начинать поиск покупателя в базе данных ('email', 'phone')
seller_comment (строка) комментарии продавца
partner_id идентификатор партнёра
utm_source UTM метки для заказа (не обязательные поля)
utm_medium
utm_campaign
utm_term
utm_content

Результат:

status Статус выполнения запроса (ok, error)
message Сообщение о созданном заказе или об ошибке
order_id Идентификатор заказа
hash Хэш сумма

Пример запроса:
function send($url, $data) {
$curl = curl_init($url);
curl_setopt($curl, CURLOPT_POST, TRUE);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt($curl, CURLOPT_HEADER, 0);
curl_setopt($curl, CURLOPT_POSTFIELDS, http_build_query($data));
curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, FALSE);
curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, FALSE);

$response = curl_exec($curl);
curl_close($curl);
return $response;
}

function new_order()
{
$data = array(
'id' => ID,
'key' => KEY,
'method' => 'new_order',
'goods' => array(6),
'buyer' => array(
'name' => '',
'fename' => '',
'email' => '',
'phone' => '71234567890',
'country' => '',
'skype' => '',
'address' => '',
'vk_id' => '',
),
);

return json_decode(send("https://monecle.com/api/", $data));
}

Отмена заказа

Параметры запроса:

method Метод (delorder)
id Идентификатор пользователя из профиля (обязательно)
key Ключ для подписи запросов (обязательно)
order_id Идентификатор вашего заказа
reason 0 - отмена покупателем; 1 - отмена продавцом

Результат:

status Статус выполнения запроса (ok, error)
message Информация об ошибке

Пример запроса:
$result = file_get_contents('https://monecle.com/api/?method=delorder&id=ID&key=KEY&reason=1&order_id=11111');
echo $result;
{"status":"ok"}

Восстановление отменённого заказа

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

Параметры запроса:

method Метод (restoreorder)
id Идентификатор пользователя из профиля (обязательно)
key Ключ для подписи запросов (обязательно)
order_id Идентификатор вашего заказа

Результат:

status Статус выполнения запроса (ok, error)
message Информация об ошибке

Пример запроса:
$result = file_get_contents('https://monecle.com/api/?method=restoreorder&id=ID&key=KEY&order_id=11111');
echo $result;
{"status":"ok"}

Получение продуктов

Параметры запроса:

method Метод (GetGoods)
id Идентификатор пользователя из профиля (обязательно)
key Ключ для подписи запросов (обязательно)
from Смещение продуктов для выборки (по-умолчанию: 0)
count Количество продуктов для выборки (по-умолчанию: 1000, максимум: 5000)

Результат:

status Статус выполнения запроса (ok, error)
items Массив выбранных продуктов. Продукт содержит следующие поля:
good_id Номер продукта
title Наименование
content Контент
date Дата создания
good_category_id Номер категории
del Продукт удален
coupons Купоны
price_type Тип стоимости ( 0 - Фиксированная, 1 - Плавающая (покупатель указывает сам), 2 - Периодические платежи, )
pay_period Для периодических - период оплаты: 0-ежемесячно; 1-еженедельно
price Стоимость продукта
currency Валюта
on_sale Акция
price_wo_sale Стоимость без акции
on_credit Возможна рассрочка
credit_min_first Минимальный первый взнос при рассрочке
credit_max_time Максимальное кол-во дней рассрочки
credit_max_date Рассрочка до указанной даты
description Описание на странице заказа
img Изображение
on_user_calls Включен Call-центр
coupon_codes_on Выдача одноразовых паролей
video_download Разрешить скачивание видео
max_orders Ограничено максимальное количество заказов
min_partner_sales Миниманое количество партнерских продаж
service_field Сервисное поле (например для указания идентификатора в своей системе)
coupons Купоны
count Количество продуктов (не зависит от переданных параметров `from` и `count`)
message Информация об ошибке

Пример запроса:
$result = file_get_contents('https://monecle.com/api/?method=GetGoods&id=ID&key=KEY');
echo $result;
{"status":"ok","items":[{"good_id":"1794",....}]}

Создание и редактирование продукта

Параметры запроса:

method string Метод (EditGood)
id integer Идентификатор пользователя из профиля (обязательно)
key string Ключ для подписи запросов (обязательно)
good_id integer Идентификатор продукта (для редактирования продукта)
title string Название продукта
description string Текст на странице заказа
content string Контент, доступный после покупки в личном кабинете
pay_page string Текст на странице оплаты
landing_url string Ссылка на страницу с информацией о продуке для менеджеров Call-центра и партнеров
selling_end_url string Ссылка на страницу после завершения продаж
speaker_сontacts string Контактные данные спикеров
start_lessons string Начало занятий (Московское время)
feedback_lessons string Как происходит обратная связь между занятиями
address_lessons string Адрес проведения занятий
terms_lessons string Сроки проведения занятий
time_every_lessons integer Продолжительность занятий в минутах
good_dimensions string Размеры продукта
data_departure string Данные для отправления
title_buy string Заголовок на странице заказа
order_button_text string Текст кнопки заказа
service_field string Информационное поле, которое присутствует в выгрузке продуктов через API
success_url string Страница после успешной оплаты
buy_letter string Текст письма при оформлении заказа
good_category_id integer Идентификатор категории
price_type integer Номер типа стоимости (0-фиксированная, 1-плавающая, 2-периодическая)
pay_period integer Для периодических - период оплаты: 0-ежемесячно; 1-еженедельно
price integer Стоимость продукта
on_sale integer Акция
price_wo_sale integer Стоимость без акции
currency string Валюта ("", "USD", "EUR")
price_hide integer Скрывать цену на странице заказа
on_credit integer Возможность рассрочки
credit_min_first integer Минимальная сумма первого взноса
credit_max_time integer Максимальный срок рассрочки в днях
credit_max_date date Максимальная дата рассрочки
comission_1_value_1 integer Партнерские отчисления первого уровня при первой продаже
comission_1_type_1 integer Тип партнерских отчислений первого уровня при первой продаже (0-%, 1-РУБ)
comission_1_value_2 integer Партнерские отчисления первого уровня при последующих продажах
comission_1_type_2 integer Тип партнерских отчислений первого уровня при последующих продажах (0-%, 1-РУБ)
comission_2_value_1 integer Партнерские отчисления второго уровня при первой продаже
comission_2_type_1 integer Тип партнерских отчислений второго уровня при первой продаже (0-%, 1-РУБ)
comission_2_value_2 integer Партнерские отчисления второго уровня при последующих продажах
comission_2_type_2 integer Тип партнерских отчислений второго уровня при последующих продажах (0-%, 1-РУБ)
good_type integer Тип продукта (0-'Запись', 1-'Онлайн', 2-'Живой', 3-'Физический')
on_selling_end integer Завершить продажи после даты
cancel_unpaid integer Аннулирование неоплаченные заказы (0-'Нет', 1-'Через несколько дней', 2-'В определенный день')
cancel_unpaid_after_days integer Аннулировать неоплаченные заказы через N дней
source_client integer Источник клиентов (0-'Не выбрано', 1-'Вебинар', 2-'Воронка (трафик->сайт->заявка)')
record_time integer Продолжительность записи в минутах
size_files integer Размер файлов (Мб)
num_lessons integer Общее количество занятий
num_lessons2week integer Количество занятий в неделю
time_lessons integer Примерная продолжительность занятий (мин)
allow_look_lessons integer Доступность записей для просмотра
allow_download_lessons integer Доступность записей для скачивания
payment_on_delivery integer Оплата при получении
on_user_calls integer Подключение Call-центра
user_calls_time integer Позвонить клиенту через N часов
video_download integer Разрешить скачивание видео
coupon_codes_on integer Выдача паролей
max_orders integer Максимальное количество заказов
buy_input_skype integer Поле skype в форме заказа
buy_input_address integer Поле комментария в форме заказа
min_partner_sales integer Минимальное количество партнерских продаж
is_deferred_pay integer Отложенная оплата
is_deferred_date integer Отправить письма на оплату автоматически
selling_end array(0 => 'dd.mm.YYYY', 1 => '00:00') Дата окончания продаж
cancel_unpaid_date array(0 => 'dd.mm.YYYY', 1 => '00:00') Дата аннулирования неоплаченных заказов
date_lessons array(0 => 'dd.mm.YYYY', 1 => '00:00') Дата и время начала занятий
deferred_date array(0 => 'dd.mm.YYYY', 1 => '00:00') Дата и время отправления писем при отложенной оплате
pay_timer array(0 => %sec%, 1 => %min%, 2 => %hours%, 3 => %days%) Таймер на оплату
pay_timer_hard integer Недоступно оплатить заказ после окончания таймера
good_video array('title' => array(%good_video_id% => array(string)), 'thumbnail' => array(%good_video_id% => array(string)), 'type' => array(%good_video_id% => array(integer)), 'link' => array(%good_video_id% => array(string)), 'description' => array(%good_video_id% => array(string)), 'description' => array(%good_video_id% => array(string)), 'created_time' => array(%good_video_id% => array(datetime)), 'modified_time' => array(%good_video_id% => array(datetime)), 'key' => array(%good_video_id% => array(string)), 'duration' => array(%good_video_id% => array(integer)), 'download' => array(%good_video_id% => array(string))) Видео, доступные после покупки
coupon_codes array(string, string, ...) Выдаваемые пароли
good_coupons array('code' => array(string), 'discount' => array(integer), 'discount_type' => array(integer), 'is_limit_date' => array(integer), 'limit_date' => array(date), 'limit_time' => array(time)) Купоны
good_notices array('type' => array(string), 'contact' => array(string), 'is_buy' => array(integer), 'is_pay' => array(integer)) Дополнительные уведомления по данному продукту
coauthors array('user_id' => array(integer), 'comission' => array(integer), 'comission_type' => array(integer)) Соавторы
partners array('user_id' => array(integer), 'comission_1_value_1' => array(integer), 'comission_1_type_1' => array(integer), 'comission_1_value_2' => array(integer), 'comission_1_type_2' => array(integer), 'comission_2_value_1' => array(integer), 'comission_2_type_1' => array(integer), 'comission_2_value_2' => array(integer), 'comission_2_type_2' => array(integer)) Партнеры
good_upsale array(integer, integer, ...) Массив идентификаторов продуктов для допродажи
good_speakers array(string, string, ...) Cпикеры

Результат:

status Статус выполнения запроса (ok, error)
message Информация об ошибке
good_id Идентификатор продукта

Пример запроса:
$params = Array ( 'method' => 'EditGood', 'id' => ID, 'key' => 'KEY', 'good_id' => 6159, 'title' => 'Название продукта', ... );
$url = 'https://monecle.com/api/';
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($params));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
if (!curl_errno($ch)) {
echo $response;
}
curl_close($ch);
{"status":"ok","good_id":6159,"good":{"title": "Название продукта", ...},"coupon_codes":[],"good_video":[],"good_coupon":[],"coauthors":[],"partners":[],"good_upsale":[],"good_speakers":[],"good_notices":[],"action":"edit"}

Получение покупателя

Параметры запроса:

method Метод (get_buyer)
contact Контакт покупателя (email или телефон)

Результат:

status Статус выполнения запроса (ok, error)
buyer Массив данных о покупателе:
buyer_id Идентификатор покупателя
name Имя
fename Фамилия
otch Отчество
email Адрес электронной почты
phone Телефон
phone2 Запасной телефон
country Страна
city Город
phone_confirm Телефон подтвержден
email_confirm Email подтвержден
avatar Ссылка на аватарку
vk_id Идентификторв ВКонтакте
skype Скайп
snlink Ссылка на социальную сеть
address Адрес
date Дата регистрации
message Информация об ошибке

Пример запроса:
$result = file_get_contents('https://monecle.com/api/?method=get_buyer&id=ID&key=KEY');
echo $result;
{"status":"ok","buyer":[{"buyer_id":1794,....}]}

Получение покупателя

Параметры запроса:

method Метод (get_buyer_by_id)
id Идектификатор покупателя

Результат:

status Статус выполнения запроса (ok, error)
buyer Массив данных о покупателе:
buyer_id Идентификатор покупателя
name Имя
fename Фамилия
otch Отчество
email Адрес электронной почты
phone Телефон
phone2 Запасной телефон
country Страна
city Город
phone_confirm Телефон подтвержден
email_confirm Email подтвержден
avatar Ссылка на аватарку
vk_id Идентификторв ВКонтакте
skype Скайп
snlink Ссылка на социальную сеть
address Адрес
date Дата регистрации
message Информация об ошибке

Пример запроса:
$result = file_get_contents('https://monecle.com/api/?method=get_buyer_by_id&id=ID&key=KEY');
echo $result;
{"status":"ok","buyer":[{"buyer_id":1794,....}]}