Публичное API: заказы

Раздел «Заказы» внешнего API нужен для интеграции с CRM: внешняя система забирает заявки, которые клиенты оставили в планировщике. Общие правила (базовый URL, sync_key) — в статье «Публичное API: обзор».

Получить заказы

GET  ОсновнойURL/api/get_items/orders?sync_key=ВАШ_КЛЮЧ

В ответ приходит массив объектов заказов. Поля объекта:

Поле	Тип	Описание
id	number	ID заказа
name	string	ФИО клиента
email	string	email клиента
phone	string	телефон
comments	string	комментарий клиента
project_file	string	имя файла-проекта (сохранение)
date	string	дата создания заказа
price	string	стоимость проекта
referred	string	не используется (пустая строка)

Файл проекта

Поле project_file содержит имя файла сохранённого проекта. Скачать сам файл можно по адресу вида:

https://planplace.ru/clients/<имя_аккаунта>/clients_orders/<имя_файла_проекта>

(подставьте имя своего аккаунта и значение project_file).

Связь с заявками в кабинете

То же самое, что приходит этим методом, видно в кабинете в разделе «Заявки на расчёт». API просто отдаёт эти заявки внешней системе для автоматической обработки.

Передача заказов «в обратную сторону». Если нужно, чтобы PlanPlace сам отправлял заказ во внешнюю систему в момент его оформления (push), это настраивается отдельно — см. передачу заказов в статье «Синхронизация по API». Метод get_items/orders — это, наоборот, чтение (pull) накопленных заявок.

Типовой сценарий (CRM ← PlanPlace)

1. По расписанию CRM запрашивает GET api/get_items/orders.
2. Новые заказы (по id/date) заводятся как сделки/лиды.
3. При необходимости скачивается файл проекта по ссылке из project_file.

Коротко

GET api/get_items/orders?sync_key=... возвращает массив заявок клиентов: ФИО, email, телефон, комментарий, имя файла проекта, дату и цену. Файл проекта скачивается по ссылке из project_file. Это «чтение» заявок для CRM; «отправку» заказа в момент оформления настраивают через синхронизацию по API.