Использование API¶
Процесс подготовки проектов мебельных изделий для производства возможно автоматизировать задействовав функционал сервиса. Используя определенную последовательность запросов к API сервиса можно выполнять преобразование (конвертацию) данных из программ для моделирования мебели в форматы программного обеспечения предназначенного для подготовки проекта к производству.
Токен доступа¶
Для выполнения авторизованных запросов к API сервиса необходимо использовать токен доступа, который можно узнать в кабинете пользователя. В связи с тем, что токен открывает доступ к учетной записи, не рекомендуется передавать его посторонним.
Примечание
При случайной публикации своего токена доступа, или при подозрении его компрометации, рекомендуется сгенерировать в кабинете пользователя новый токен для доступа к учетной записи. После этого доступ по прежнему токену станет невозможным.
Выполнение запросов к API¶
Запросы к API сервиса выполняются по протоколу HTTP с защищенным соединением на адреса начинающиеся с:
https://mebel-pro.one/api/
Каждый запрос должен сопровождаться дополнительным заголовком «X-Token», значение которого должно содержать персональный токен доступа.
Конвертация из одного формата в другой¶
Для преобразования данных из одного формата в другой необходимо выполнить как минимум два запроса к API сервиса:
загрузить данные из файла в определенном формате и в ответе получить идентификатор созданного проекта;
выгрузить по идентификатору данные проекта в другом формате.
Для импорта данных необходимо отправить POST-запрос с прикрепленным файлом по адресу:
https://mebel-pro.one/api/projects/import/?format=<ИД_ФОРМАТА>
, где <ИД_ФОРМАТА> - идентификатор формата.
В ответе на запрос передается идентификатор созданного проекта.
Получить список доступных для импорта форматов можно с помощью GET-запроса по адресу:
https://mebel-pro.one/api/projects/import/formats
—
Для экспорта данных необходимо отправить GET-запрос по адресу:
https://mebel-pro.one/api/projects/<ИД_ПРОЕКТА>/export/?format=<ИД_ФОРМАТА>
, где <ИД_ФОРМАТА> - идентификатор формата.
В ответе на запрос передаются данные проекта в запрашиваемом формате.
Получить список доступных для экспорта форматов можно с помощью GET-запроса по адресу:
https://mebel-pro.one/api/projects/export/formats
—
Если нет необходимости хранить импортированный проект в списке проектов, то можно удалить его отправив DELETE-запрос по адресу:
https://mebel-pro.one/api/projects/<ИД_ПРОЕКТА>
—
Скачать примеры: