Технические данные
- Опубликовано:
- 06.08.2018
- Обновлено:
- 30.06.2024
- Версия:
- 4.17.0
- Установлено:
- Более 1000 раз
- Подходящие редакции:
- «Первый сайт», «Старт», «Стандарт», «Малый бизнес», «Бизнес», «Корпоративный портал», «Энтерпрайз», «Интернет-магазин + CRM»
- Адаптивность:
- Да
- Поддержка Композита:
- Да
- Совместимо с Сайты24
- Нет
- Совместимо с PHP 8.1
- Да
Пользовательское соглашение
Описание
Видео-обзор: https://vk.com/video
Модуль помогает организовать программный интерфейс для внешних и внутренних приложений.
С 01.01.2020 запускаем программу поддержки общественных организаций, некоммерческих фондов, сообществ волонтёров, то есть всех тех компаний, которые работают на благо общества. В рамках данной программы уже поддержали проект Автоволонтёров России: https://x-15.ru Подробнее о программе вы можете узнать у наших операторов, по любым доступным каналам связи. |
Один из фактов о модуле: на основе данного модуля, студенты изучают работу REST API, а также реализуют собственные интерфейсы, которые позже сдают в виде курсовых и даже дипломных работ. |
Один из часто задаваемых вопросов: может ли модуль загружать на сайт остатки по товарам с сайта поставщика? Нет, модуль не может импортировать остатки по товарам с сайта поставщика. Модуль помогает реализовать API на вашем сайте, чтобы сторонние клиенты (другие сайты, мобильные приложения, и так далее) могли отдавать или забирать данные с вашего сайта. |
Ранее нами уже был разработан и опубликован на бесплатной основе модуль REST API. Данный модуль хорошо себя зарекомендовал для решения задач межплатформенных обменов, показателями этого факта являются отзывы и количество скачиваний. Со временем стало появляться множество запросов по доработке модуля, и как следствие, мы приняли решение о написании новой, усовершенствованной версии уже полюбившегося модуля.
В данной версии мы учли все недостатки и пожелания из прошлой версии, очень хорошо оптимизировали ядро модуля, теперь оно работает гораздо быстрее, и на этом мы делаем свой основной упор.
Помимо переработки ядра немаловажным фактором является и добавление карты роутов. За счет карты появилась возможность очень гибко настраивать параметры для любого отдельного роута.
Что получите от приобретения модуля:
- Уменьшение стоимости разработки API за счет сокращения времени на программирование интерфейса.
- Поддержка от профессионалов, имеющих большой опыт создания API.
- Готовый RESTful API интерфейс, с библиотекой встроенных методов, а также с возможностью создавать собственные, кастомные методы, реализующие любую, необходимую логику. И конечно, с автогенерируемой документацией, которую можно предоставить сторонним разработчикам.
Возможности:
- Использование API 1С-Битрикс через нативный рест-провайдер.
- Загрузка интерфейса до запуска публичной части сайта.
- Отсутствие необходимости в дополнительной настройке платформы.
- Виртуальный путь к интерфейсу, в том числе и от корня домена (https://domain.com/ или https://domain.com/{api}/ или https://api.domain.com/).
- Настройка доступа в административной части сайта к разделам модуля на уровне групп пользователей.
- Автогенерируемая документация в административном разделе.
- Автогенерируемая документация для клиента в JSON-формате.- Поддержка карт роутов.
- Создание произвольных роутов (/{api}/user/, /{api}/user/get/, /{api}/user/v1/, ... ).
- Установка собственных контроллеров для роутов (классы, внешние классы, php-файлы).
- Настройка уровня доступа к роутам.
- Валидация параметров входящего запроса.
- Авторизация по логину и паролю для конкретного роута.
- Авторизация по токену для конкретного роута.- Генерация токенов для пользователей.
- Поддержка списка "белых" логинов/токенов для конкретного роута.
- Проверка групп пользователя при авторизации для конкретного роута.
- Возможность ограничения количества запросов в единицу времени на уровне групп пользователей.
- Возможность передачи дополнительных заголовков при ответе.
- Возможность деактивировать конкретный роут.
- Кэширование входящих запросов и ответов средствами платформы.
- Журналирование запросов и ответов.
- Настройка CORS из административной части сайта.
- Наличие функций упрощающих разработку интерфейса.
- Наличие библиотеки встроенных роутов ускоряющих разработку интерфейса.- Наличие примеров и руководств для разработчика.
Более подробно все возможности, функции и примеры описаны в документации, которая имеется в модуле.
Чем данный модуль отличается от REST API Битрикса?
1.1. В REST API Битрикса мало гибкости, есть необходимость использовать именно предоставленные роуты. Данный модуль позволяет формировать свои роуты, писать свою логику при обработке запроса, то есть предоставляет больше гибкости;
1.2. REST API Битрикса реализовано не совсем согласно архитектурному стилю REST;
1.3. В REST API Битрикса, при обработке запроса порой происходят «лишние» действия, которые могут создавать дополнительную задержку при ответе клиенту, может это и не сильно критично, но API должно быть настолько быстрым, насколько это возможно;
1.4. API не всегда должно быть доступно всем, иногда оно должно быть уникально (роуты, параметры, ... ) для проекта, но за счет общего стиля REST API Битрикса, документация которого в общем доступе, эта уникальность нарушается и создает дополнительную лайзеку для атак на сайт. Используя данный модуль, можно указывать собственное имя роута, где будет работать API. Например: domain.com/rest/ или domain.com/api/, или domain.com/rest-api/, или api.domain.com, и так далее;
1.5. В REST API Битрикса нет возможности как-то управлять интерфейсом из административной части сайта;
1.6. В REST API Битрикса нет возможности регулировать доступы к роутам, ограничивать доступ по количеству запросов от клиента, журналировать запросы и ответы, и некоторые другие функции.
1.7. На текущий момент, в REST API Битрикса, например, нет возможности создать заказ через API. Используя данный модуль вы можете реализовать этот функционал.
1.8 В целом, данный модуль пишется и развивается на основе запросов пользователей, но REST API Битрикса пишется на усмотрение Битрикса. Плюс это или минус - решать вам.
Примечание:
- Минимальная версия PHP >= 8.0 (согласно требованиям платформы). Использование более ранней версии возможно, но крайне не рекомендуется, в виду возникновения ошибок.
- Обязательно наличие файла для обработки 404 ошибки (обычно имеется в корне сайта - 404.php) со всеми "директивами" 1С-Битрикса.
- Если используется веб-сервер Apache: обязательно прописать ErrorDocument 404 /404.php в .htaccess, расположенный в корне сайта, или прямо в конфигурационном файле Apache.
- Если используется веб-сервер Nginx: обязательно прописать error_page 404 = /404.php?$query_string; в секцию server конфигурационного файла (обычно nginx.conf).
- Для работы CORS-запросов необходимо чтобы на веб-сервере были разрешены запросы типа OPTIONS.
Спасибо Вам за ознакомление с нашим модулем. Если у Вас имеются какие-либо вопросы/предложения, то мы всегда готовы обсудить их через контакты, указанные в разделе поддержки.
Для наших партнёров готовы предлагать скидки на модуль по индивидуальным условиям.
Для получения подробностей напишите нашему менеджеру через раздел контактов.
4.17.0 (30.06.2024) |
|
4.16.0 (02.03.2024) |
|
4.15.0 (18.11.2023) |
|
4.14.0 (22.07.2023) |
|
4.13.2 (31.05.2023) |
|
4.13.1 (19.05.2023) |
|
4.13.0 (05.05.2023) |
|
4.12.0 (22.02.2023) |
|
4.11.0 (13.01.2023) |
|
4.10.0 (30.08.2022) |
|
4.9.0 (02.08.2022) |
|
4.8.1 (19.07.2021) |
|
4.8.0 (03.07.2021) |
|
4.7.0 (02.06.2021) |
|
4.6.0 (19.12.2020) |
|
4.5.0 (03.12.2020) |
|
4.4.0 (17.10.2020) |
|
4.3.1 (18.09.2020) |
|
4.3.0 (11.09.2020) |
|
4.2.0 (06.09.2020) |
|
4.1.0 (10.08.2020) |
|
4.0.2 (07.07.2020) |
|
4.0.1 (22.05.2020) |
|
4.0.0 (22.04.2020) |
|
3.5.0 (15.01.2020) |
|
3.4.0 (26.10.2019) |
|
3.3.2 (31.08.2019) |
|
3.3.1 (30.07.2019) |
|
3.3.0 (24.06.2019) |
|
3.2.0 (07.05.2019) |
|
3.1.0 (16.02.2019) |
|
3.0.0 (15.02.2019) |
|
2.9.3 (09.02.2019) |
|
2.9.2 (09.02.2019) |
|
2.9.1 (09.02.2019) |
|
2.9.0 (09.02.2019) |
|
2.8.0 (08.02.2019) |
|
2.7.0 (01.02.2019) |
|
2.6.0 (13.01.2019) |
|
2.5.0 (13.01.2019) |
|
2.4.0 (12.01.2019) |
|
2.3.0 (12.01.2019) |
|
2.2.0 (12.01.2019) |
|
2.1.1 (11.01.2019) |
|
2.1.0 (10.01.2019) |
|
2.0.0 (05.01.2019) |
|
1.2.0 (11.11.2018) |
|
1.1.0 (24.10.2018) |
|
1.0.2 (11.10.2018) |
|
1.0.1 (08.09.2018) |
|
После установки модуль будет расположен в разделе Сервисы.
Согласно производственному календарю России
Понедельник – Пятница
10:00 – 18:00 – Россия, Москва
12:00 – 20:00 – Россия, Екатеринбург
14:00 – 22:00 – Россия, Новосибирск
09:00 – 17:00 – Казахстан, Астана
08:00 – 16:00 – Англия, Лондон
Сайт: https://webco.io
Онлайн-чат (срочные вопросы): https://wbc.bitrix24.ru/online/chat
E-mail (вопросы общего характера): hello@webco.io
E-mail (вопросы по документам): documents@webco.io
E-mail (вопросы по поддержке): support@webco.io
E-mail (вопросы по качеству услуг): d.artamonov@webco.io
Вконтакте: https://vk.com/webco
RuTube: https://rutube.ru/u/webco
Telegram: https://t.me/WebcoRobot
Telegram-канал: https://t.me/WebcoCompany
Идентификатор ЭДО – Диадок
2BM-540550482808-20190124090719306397300000000
Банковские реквизиты
Банк – АО "ТИНЬКОФФ БАНК"
БИК – 044525974
Корр.счет – 30101810145250000974
Расч.счет – 40802810200000584808
ИНН: 540550482808
ОГРНИП: 318547600098445
Подробнее: https://egrul.nalog.ru
Отзывы
https://yandex.ru/profile/173517513051