SEO, оптимизация и продвижение сайтов на «1С-Битрикс»

• Все статьи

• Разработка

• Дизайн

• Аналитика

• Маркетинг

• Бизнес

• Автоматизация

22 ноября 2019

25 мин.

21226

Алексей Семёнов
редактор

«1С-Битрикс» — популярная коммерческая CMS, которая позволяет не только разрабатывать сайты любой сложности, но также успешно продвигать их за счет встроенных SEO-инструментов.

В админку по умолчанию встроен модуль для полноценной поисковой оптимизации, который позволяет произвести как общие настройки сайта, так и оптимизировать отдельные страницы.

Доступны следующие возможности:

Стили заголовков. В режиме редактирования страницы можно задать заголовки любого уровня: h2, h3, h4 и т.д.

Заголовок окна браузера (title). Замена для любой страницы, раздела или категории.

Управление метатегами. Настройка как отдельных страниц, так и автоматическая генерация метатегов для множества страниц на основе шаблонов.

Понятные адреса страниц. Настройка ЧПУ — «человекопонятного урла». Странице присваивается адрес, который может прочитать как человек, так и робот.

Метаданные для динамического контента. Ключевые слова и описания для новостей, статей, элементов каталогов и т.п.

Настройка robots. txt и генерация sitemap.xml. Встроенные инструменты позволяют автоматически создавать и редактировать эти файлы.

Исключение CSS-кода из кода страницы. Таблицу каскадных стилей можно подключать из внешнего файла.

Ограничение активности роботов. Если некоторые боты проявляют чрезмерную активность, вы можете ограничить им доступ к сайту на определенный период.

Удаление идентификаторов сессий из адреса страниц. ID сессии мешает правильной индексации и «засоряет» индекс — вы можете отключить их.

Сбор статистики. Система определяет поисковые фразы, по которым посетители приходят на сайт.

Статистика переходов на туристический портал

Встроенные инструменты

Встроенный модуль «Поисковая оптимизация» облегчает регулярную работу по продвижению: анализирует техническое состояние сайта, отображает параметры, которые влияют на оптимизацию и дает рекомендации. Объединяет в одном интерфейсе всю информацию, которая нужна для поисковой оптимизации контента.

Часть функционала модуля «Поисковая оптимизация» реализуется с помощью модуля «Аналитика» и доступна только в редакции «Бизнес».

Возможности ориентированы не только на SEO-специалистов, но и на рядовых пользователей. Доступные инструменты можно разделить на две группы:

1. Инструменты для оптимизации всего сайта: общее количество ссылок, поисковые запросы, индексация поисковиками, оценка результативности работы сайта. Можно быстро вызвать диалоговые окна и внести изменения.

Инструменты для оптимизации сайта

2. Инструменты для оптимизации контента конкретной страницы. В публичной части выводится базовая информация по контенту, частоте индексации, запросам, по которым пользователи приходят на страницу, дополнительная информация.

Общая информация о странице. Источник

Индексация страницы поисковыми системами. Источник

Список ссылающихся сайтов. Источник

Раздел «Продвигаемые слова»

Рекомендации и исправления

Один из наиболее полезных инструментов — «Рекомендации и исправления», который показывает недочеты SEO на странице.

Возможные ошибки:

Число исходящих ссылок превышает рекомендуемое значение в 100 ссылок.

Найдено более 1 или не найдено ни одного заголовка h2.

У картинок не заполнены или отсутствуют значения атрибутов ALT и TITLE.

Отсутствуют или не заполнены метатеги.

Рекомендации по исправлениям на странице

Анализ страницы

Раздел «Анализ страницы» позволит быстро проанализировать содержимое. В правой колонке приведен список параметров, при клике по которым система выводит данные.

Больше о встроенных инструментах поисковой оптимизации — в обучающем курсе « Работа с модулем поисковой оптимизации».

Далее подробнее разберем настройки оптимизации всего сайта и настройки конкретных страниц.

Оптимизация сайта

Подключение HTTPS

Наличие шифрования на сайте — важное требование поисковых систем. Особенно это важно для интернет-магазинов, которые принимают оплату и получают персональные данные пользователей. Если у сайта нет ssl-сертификата, он понижается в выдаче. Более того — браузеры могут его блокировать или помечать специальным значком опасности.

Как получить сертификат
Рекомендации «Яндекс»: «Инструкция по переходу на HTTPS»
Рекомендации Google: «Защитите свой сайт с помощью HTTPS»
Инструкция: «Бесплатный ssl-сертификат для интернет магазина на Битрикс».

Настройка редиректов

Чтобы в индексе поисковых систем не было дублей сайта, а была только одна версия, необходимо грамотно настроить редиректы. В целом переадресация на «1С-Битрикс» настраивается аналогично любым сайтам, которые работают на Apache 2. Но есть один нюанс — «1С-Битрикс» использует собственный обработчик адресов страниц (URL) — urlrewrite. php, который подключается через файл. htaccess и позволяет использовать ЧПУ.

Переадресацию нужно настроить раньше, чем будет подключен обработчик. Для настройки переадресации нужно выбрать вариант написания адреса сайта. Обычно выбирают вариант без www и со слешем (/) на конце, например, site.ru/page/ — это стандартный вариант.

Чтобы реализовать такую переадресацию, используйте код:

RewriteCond %{REQUEST_URI} !\?
RewriteCond %{REQUEST_URI} !\&
RewriteCond %{REQUEST_URI} !\=
RewriteCond %{REQUEST_URI} !\.
RewriteCond %{REQUEST_URI} !\/$
RewriteCond %{HTTP_HOST} ^www\. (.*)$ http://%1/$1/ [L,R=301]

Получите доступ к файлам сайта через FTP.

Вставьте код переадресации в блоке mod_rewrite, до подключения urlrewrite.php.

Откройте файл. htaccess, он находится в корневой папке вашего сайта.

Блок выглядит следующим образом:

<IfModule mod_rewrite.c>
  Options +FollowSymLinks
  RewriteEngine On
“Здесь должен быть ваш код”
</IfModule>

Переадресация заработает сразу — перезагрузка сервера не понадобится.

Настроить переадресацию можно разными способами. Описанный нами — лишь один из них. Лучше доверить эту задачу программистам, но если решили разобраться самостоятельно, рекомендуем создавать бэкапы на хостинге.

Добавление счетчиков

Вы можете установить на сайт любой счетчик:

Используя Google Tag Manager, можно одновременно установить несколько счетчиков — это не повлияет на производительность сайта.

Google Analytics можно использовать в исходном виде.

В «Яндекс.Метрике» нужно отметить галочкой пункт «Асинхронный код» — это позволит снизить нагрузку на сайт.

Счетчики нужно устанавливать в начале страниц в header.php. Он расположен по адресу /bitrix/templates/имя_вашего_шаблона/header.php. Откройте его в любом редакторе или в панели администрирования «1С-Битрикс» на странице редактирования шаблона. Разместите код счетчика перед закрывающим тегом </head>, сохраните изменения и обновите кэш сайта.

Подключение к кабинетам вебмастеров

Модуль позволяет подключить сайт к сервисам «Яндекса» и Google — это может быть полезно, если вам удобнее отслеживать всю информацию непосредственно из административной панели сайта. Также можно пользоваться рядом функций.

Подключить сайт можно следующим путем: Маркетинг > Поисковая оптимизация > Поисковые системы > Яндекс.

После подключения вам станет доступна информация об индексации и популярные запросы, по которым приходят на сайт. Еще одна полезная возможность — заявку на авторство оригинальных текстов можно оформлять сразу из административной панели.

Загрузка оригинальных текстов

Аналогично подключается Google.

Рекомендуем ознакомиться с подробной инструкцией

Создание sitemap.xml

Карта сайта — специальный документ, который содержит информацию для роботов поиска о тех страницах и разделах сайта, которые нужно проиндексировать.

Для создания такого файла в «1С-Битрикс» предусмотрен специальный инструмент.

Генератор карты сайта

Карта сайта создается автоматически, вам всего лишь нужно снять галочки с тех разделов, которые не должны индексироваться. Управление настройками осуществляется в соответствующем разделе: Маркетинг > Поисковая оптимизация > Настройка sitemap.xml.

Созданная карта разделяется на файлы по 10мб и автоматически обновляется — это удобно для интернет-магазинов с большими каталогами. Вручную редактировать файл не нужно.

Пример карты сайта

Также рекомендуем ознакомиться с подробной инструкцией по генерации карты сайта

Настройка robots.txt

В CMS уже есть встроенный инструмент для создания файла robots. txt, который ограничивает доступ и индексацию поисковых роботам. С его помощью можно управлять доступностью информации для поисковых «пауков». Роботы сначала читают инструкции в этом файле, а потом сканируют сайт.

Настройка robots.txt

В генераторе есть несколько кнопок, с помощью которых можно управлять файлом: запрещать или разрешать сканирование, указывать главное зеркало, задавать интервал между запросами на сканирование, указывать карту сайта.

Первая кнопка — «Стартовый набор» — создает стандартный файл.

В robots. txt запишутся следующие правила:

User-Agent: *
Disallow: */index.php
Disallow: /bitrix/
Disallow: /*show_include_exec_time=
Disallow: /*show_page_exec_time=
Disallow: /*show_sql_stat=
Disallow: /*bitrix_include_areas=
Disallow: /*clear_cache=
Disallow: /*clear_cache_session=
Disallow: /*ADD_TO_COMPARE_LIST
Disallow: /*ORDER_BY
Disallow: /*PAGEN
Disallow: /*?print=
Disallow: /*&print=
Disallow: /*print_course=
Disallow: /*?action=
Disallow: /*&action=
Disallow: /*register=
Disallow: /*forgot_password=
Disallow: /*change_password=
Disallow: /*login=
Disallow: /*logout=
Disallow: /*auth=
Disallow: /*backurl=
Disallow: /*back_url=
Disallow: /*BACKURL=
Disallow: /*BACK_URL=
Disallow: /*back_url_admin=
Disallow: /*?utm_source=
Disallow: /*?bxajaxid=
Disallow: /*&bxajaxid=
Allow: /bitrix/components/
Allow: /bitrix/cache/
Allow: /bitrix/js/
Allow: /bitrix/templates/
Allow: /bitrix/panel/

Здесь уже заданы правила для всех поисковых роботов: закрыты от индексации технические страницы, страницы авторизации, пагинации и заказа, сессий.

Что стоит закрыть:

Списки сравнения

Страницы с результатами фильтрации

Системные папки

Поиск по сайту

Служебные страницы

URL с параметрами

К базовым правилам стоит указать главное зеркало: нажимаем на соответствующую кнопку и ставим галочку напротив https (если он подключен) и прописываем основной домен сайта.

Затем нужно добавить путь к карте сайта: нажимаем кнопку и вписываем абсолютную ссылку на документ, например, site.ru/sitemap.xml.

Микроформаты

Микроформаты — вариант семантической разметки данных в коде страницы — позволяют поисковым роботам лучше и быстрее понимать содержимое страницы. Это особенно полезно интернет-магазинам, которые таким образом могут помечать свои товары и ускорять их индексацию.

«1С-Битрикс» поддерживает формат Schema.org. В HTML-коде страниц создаются специальные метки: цена, товар, телефон и другие атрибуты, которые делают контент машиночитаемым.

Шаблоны метатегов

К тому времени, когда понадобится заполнить метатеги, у вас уже должен быть список ключевых слов для каждой страницы, раздела, категории. Как собрать семантическое ядро для интернет-магазина, мы рассказали ранее в статье.

В каталоге интернет-магазина могут быть сотни и тысячи товаров, поэтому заполнять метатеги вручную — долго и неэффективно. Удобно, что в «1С-Битрикс» есть возможность генерировать их на основе шаблонов и автоматически заполнять в CMS.

Рекомендуем ознакомиться с инструкцией по составлению шаблонов метатегов для каталога интернет-магазина.

Обратите внимание. В настоящее время не нужно заполнять поле Keywords — поисковые системы перестали его учитывать.

Оптимизация картинок

Вкладка SEO позволяет работать с картинками: указывать шаблоны альтернативных описаний (alt), заголовков (title), названий файлов, задавать метаописания. Это повышает качество сайта — роботы смогут понимать, что изображено, и будут выдавать картинки с сайта в ответ на запрос пользователя.

Пример: DSC01373.JPG > shapka-vyazanaya.jpg — вместо абстрактной цифровой комбинации появилось наименование товара.

Обратите внимание. Все поля задаются автоматически только для тех изображений, которые были загружены после внесения изменений. Все, что было загружено ранее, останется со старыми наименованиями.

Поля для описания картинок

Оптимизация страниц

Каждую страницу сайта также необходимо оформлять в соответствии с требованиями поисковых систем.

Основные требования:

Все картинки должны иметь описание и заголовок.

Заголовок и описание страницы должны быть уникальными для каждой страницы.

Адреса страниц должны быть понятными (ЧПУ).

Необходимо соблюдать иерархию заголовков: h2, h3 и т. д.

Текст и изображения на странице должны быть уникальными.

Контент должен быть структурированным: разделен на главы, разделы, блоки, небольшие абзацы по 3−5 строк, маркированные и нумерованные списки

Должен присутствовать графический контент: инфографика, фотографии, видео.

Адреса страниц, которые могут быть прочитаны людьми, называются «человекопонятными», то есть могут быть осмыслены и прочитаны пользователям, а не представляют из себя случайный набор символов. Такие адреса формируют четкую и понятную структуру сайта. В «1С-Битрикс» есть встроенный генератор URL.

Администратор сайта вводит название страницы на русском языке, а генератор преобразует его в URL. Возможны два варианта: URL — это либо транскрипция русского звучания латиницей, либо перевод на английский язык. Оба варианта приемлемы и понимаются поисковыми машинами.

URL в русской транскрипции

Пример автоматического создания URL на английском языке

Метатеги

Метатеги можно задать двумя способами.

1. Через административную панель в свойствах страницы.

Заголовок и описание страницы

2. Через модуль SEO в разделе управление в публичной части сайта.

Здесь также можно задать h2, заголовок и описание страницы в браузере.

Дополнительные SEO модули

В «1С-Битрикс: Маркетплейс» доступны дополнительные модули, которые помогут в поисковой оптимизации и продвижении сайта.

Каталог дополнительных решений для SEO

Возможности дополнительных модулей:

Анализ проблемных страниц

Сканирование сайта для SEO по статическим файлам и по инфоблокам

Управление схемами ЧПУ на всем сайте

Отслеживание дублей метатегов

Управление выводом нужной информации в метатегах

Отслеживание трафика: сколько пришло с поиска на конкретную страницу

Добавление нужных страниц в sitemap.xml

Полезные бесплатные решения

Оптимизация картинок

Преимущества:

Нет нагрузки на сервер

Картинки сжимаются в 5−10 раз и автоматически оптимизируются

Используются рекомендуемые форматы Google: jpegoptim и optipng

Проверка текстов на уникальность

Преимущества:

Определяется процент заспамленности

Автоматически подсчитывается количество символов

Можно не только проверить уникальность, но и найти грамматические ошибки

Генератор иконок сайта (Favicon generator)

Преимущества:

Есть шаблоны

Доступно несколько вариантов иконок

Можно легко создать фавиконку для сайта

Оригинальные тексты

Преимущества:

Доступен список отправленных текстов

Есть возможность ручного добавления текстов

Оригинальные тексты автоматически отправляются в «Яндекс. Вебмастер»

CMS «1С-Битрикс» хорошо продумана с точки зрения SEO — по умолчанию доступно всё для настройки сайта. Самые важные инструменты для продвижения присутствуют во всех редакциях продукта: это значит, что оптимизировать сайт одинаково легко могут владельцы и крупного, и малого бизнеса. Просто следуйте описанной нами инструкции и получайте трафик из поиска. Желаем удачи!

Читайте по теме

#Сайт

#Сайты

#SEO-продвижение сайтов

#SEO-продвижение

#SEO на этапе разработки сайта

#Битрикс

вернуться к списку статей

Оцените статью

Подпишитесь на нашу рассылку

Мы отправляем полезные материалы, которые помогут вам в работе

Другие статьи

27 октября 2022

25 мин.

563

Как оформить крутую презентацию, если вы не дизайнер

15 сентября 2021

Темная тема на сайте: инструкция по применению

РБК

8 декабря 2021

7 проверенных инструментов B2B-пиара на примере компаний

vc.ru

Услуги

Сайты и сервисы

Создаем удобные и эффективные сайты, которые нравятся пользователям и хорошо продвигаются в поисковых системах.

Дизайн

Сервисный дизайн на основе аналитики, метрик и пользовательского опыта — продуктовый подход для создания привлекательных и эффективных решений.

Аналитика

Изучаем бизнес клиента и его конкурентов, подбираем инструменты и способы продвижения.

SEO-продвижение

Увеличиваем органический трафик на сайте и снижаем затраты на привлечение клиентов.

Установка и настройка дополнения для битрикс Умный поиск с исправлением ошибок в запросе и подсказками

Установка решения

Установка данного решения включает в себя размещение и настройку компонентов, поэтому без базовых навыки работы с кодом не обойтись. Процесс установки решения не сложен и занимает в среднем около часа. При необходимости помогу с установкой и отвечу на вопросы — пишите на почту [email protected]

Важная базовая информация:

1. Перед установкой пройдите «Проверку системы» на сайте стандартным инструментом битрикса (Админка->Настройки->Инструменты->Проверка системы). Если там есть ошибки — исправьте их. Особенно критичны константы UFT и работа со строками — если в этих пунктах есть ошибки, решение будет работает некорректно.

2. 
   Решение включает в себя 2 компонента: Умный поиск по заголовкам (search. title) — интерактивный поиск и Умная страница поиска (search.page) — поисковая страница

3. 
   Решение имеет набор общих настроек. Для изменения настроек нажмите «Настройки» в верхней части админ-панели и в списке модулей выберите «Умный поиск с исправлением ошибок и подсказками»

4. 
   После установки и настройки решения не забывайте переиндексировать модуль поиска

Ситуация 1. У вас на сайте не установлены компоненты поиска

В этой ситуации нам нужно с нуля настроить компоненты и разместить их в шаблоне либо на определенных страницах

1. Создайте тестовую страничку для первичного размещения и настройки компонента. Измените страничку в Визуальном редакторе

2. Разместите на данной странице компонент «Умный поиск по заголовкам» (search.title)

3. В настройках компонента (двойной клик по размещенному компоненту в визуальном редакторе) сделайте следующие настройки:

• 
  «Количество категорий поиска» — укажите 1. Указание большего количества категорий не рекомендуется, т.к. крайне негативно влияет на скорость работы поиска

• 
  Обязательно заполните «Ограничение области поиска». В этой настройке выберите только важные данные по которым нужно искать (например каталог товаров). Пример настройки для поиска по каталогу:

• 
  Если решение устанавливается на редакцию малый бизнес или старше, в настройках будет возможность указать цену которую нужно вывести и конвертацию в валюту

• 
  Остальные настройки такие как сортировка, количество результатов заполните исходя из ваших задач

• 
  После завершения настроек сохраните настройки и страницу

4. После завершения настройки и проверки интерактивного поиска откройте страничку в режиме html-кода, скопируйте код уже настроенного компонента и разместите его в шаблоне сайта, шапке или других запланированных местах

5. После размещения интерактивного поиска в шаблоне сайта, удалите его с тестовой страницы. Разместите на странице компонент «Умная страница поиска» (search.page) и настройте (настройки страницы схожи с настройками интерактивного поиска).

6. Скопируйте код настроенного компонента поисковой страницы и разместите на нужной странице.

Если редакция с каталогом и требуется настроить вывод результатов поиска на странице в виде карточек, компонент поисковой страницы нужно установить в компонент catalog.search, заменив в нём стандартный компонент bitrix:search.page, на тот что вы настроили ранее.

Ситуация 2. У вас на сайте установлены стандартные компоненты bitrix:search.page, bitrix:search.title (90% случаев)

В данной ситуации нам необходимо найти вызовы стандартны компонентов и заменить их на вызовы компонентов, установленных модулем

1. Первым делом найдем вызов компонента интерактивного поиска, чаще всего он расположен в шаблоне сайта (header.php, footer.php) либо во включаемых областях, расположенных в шаблоне сайта. Вызов компонента выглядит следующим образом:

2. Замените подчеркнутые надписи на «arturgolubev» (пространство имён) и «.default» (шаблон)

3. Сохраните и проверьте работу. Настраивать в данном случае не обязательно, т.к. при подобной замене сделанные ранее настройки стандартного компонента перекочевали на компонент модуля.

4. Откройте вашу поисковую страницу. Изучите что расположено на данной странице.

• Если на странице расположен компонент bitrix:search.page, то замените его вызов по схеме ниже
• Если расположен компонент bitrix:catalog.search, то необходимо в шаблоне данного компонента (template.php) найти вызов компонента bitrix:search.page и заменить по схеме ниже
• Если на странице расположен комплексный компонент bitrix:catalog, то необходимо в шаблоне компонента вызываемый компонент bitrix:catalog. search, далее в его шаблоне найти bitrix:search.page и заменить по схеме ниже

После того как мы нашли компонент Cтраницы поиска bitrix:search.page нужно как и в ситуации с интерактивным поиском заменить вызов:

на

5. Если необходимо сохранить дизайн, который использовался до установки решения

Готово : )

@2bad/bitrix — нпм

• 🔥 Без бреда
• ✨ Выразительный API
• 💪 Строго типизированные методы и результаты запросов с помощью TypeScript
• 🚀 Управляет пакетной обработкой записей и ограничением скорости
• ❤️ На основе обещаний

Установить

 npm install @2bad/bitrix 

Usage

Инициировать клиент с конечной точкой Bitrix API и токеном доступа и использовать клиент для облегчения боли Bitrix:

 импортировать Битрикс из '@2bad/bitrix'
const bitrix = Bitrix('https://ИМЯ_ПОРТАЛА. bitrix24.ru/rest', 'ACCESS_TOKEN')
// Получить сделку
bitrix.deals.get('77')
  .then(({результат}) => {
    // Получаем типизированную полезную нагрузку
    const { НАЗВАНИЕ } = результат // строка
    console.log(НАЗВАНИЕ)
  })
  .catch(консоль.ошибка)
// Получить все сделки
bitrix.deals.list({ выберите: ["*", "UF_*"] })
  .then(({результат}) => {
    const titles = result.map((e) => e.TITLE)
    console.log(заголовки)
  })
  .catch(консоль.ошибка) 

Аутентификация

Прежде чем вы сможете использовать REST API Битрикс, вам необходимо пройти аутентификацию.

Это можно сделать двумя способами:

1. Более сложный, но правильный способ — создать приложение Битрикс и авторизоваться по OAuth.

   Аутентификация с помощью OAuth требует некоторых дополнительных шагов, и вам решать, как справиться с этим с помощью лямбда-функции, какого-либо сервера или почтальона.

   Это даст токен доступа. Используйте его для инициализации клиента:

    const bitrix=Битрикс('https://ИМЯ_ПОРТАЛА. bitrix24.ru/rest', 'ACCESS_TOKEN') 

   Обратите внимание, что токен доступа живет всего 30 минут и должен периодически обновляться с помощью токена обновления OAuth, который, в свою очередь, живет 1 месяц.

2. Более простой способ — создать входящий вебхук Битрикс с необходимыми разрешениями.

   Он мгновенно предоставит вам конечную точку с токеном внутри нее. Для его использования не требуется дополнительная аутентификация или токены доступа:

    const bitrix=Битрикс('https://ИМЯ_ПОРТАЛА.bitrix24.ru/rest/1/WEBHOOK_TOKEN') 

   Эта конечная точка существует неопределенно долго. Радуйтесь и надейтесь, что это не обернется для вас неприятными последствиями.

API

• Общий
  • вызов()
  • список()
  • партия()
• CRM
  • Компания
  • Контакт
  • Валюта
  • Сделка
  • Свинец
  • Статус
• Пользователь

Как это работает

Клиент изо всех сил старается обеспечить последовательный, строго типизированный и в то же время легкий опыт.

Он заботится о любой необходимой пакетной обработке для запуска «больших» команд, таких как получение всех сделок или потенциальных клиентов с наименьшим возможным сетевым запросом. Это позволяет достичь чтения 250 000 и обновления 5000 записей в минуту с помощью одной строки кода.

Все клиентские методы автоматически ограничиваются по скорости и помещаются в очередь, если это необходимо, чтобы справиться с ограничением Bitrix REST API в 2 запроса в секунду, поэтому вы никогда не должны видеть ошибки Bitrix о превышении ограничений скорости.

Требуемые параметры методов и возвращаемые типы полезной нагрузки автоматически разрешаются на основе интерфейса методов, который эффективно описывает все поддерживаемые в настоящее время методы.

Для улучшения архитектуры клиент разделен на уровни:

1. Методы — в основном универсальные методы, такие как , вызывают для работы с методами Bitrix API. Они заботятся о рутине и обеспечивают основу для более сложных операций.
2. Клиент — универсальный клиент, который выполняет некоторые дополнительные рутинные задачи, такие как установка токена доступа для каждого запроса, настройка очереди для ограничения скорости и предоставление универсальных методов.
3. Сервисы — каждый сервис предоставляет выразительный интерфейс для работы с определенной группой операций REST API Битрикс. По сути, они управляют универсальными клиентскими методами и параметрами для получения надлежащих результатов.
4. Битрикс-клиент — поставщик универсального метода и сервисов верхнего уровня. Простой способ работы с REST API Bitrix с помощью интуитивно понятного API, который берет на себя всю базовую сложность.

Часто задаваемые вопросы

Закончено?

Ядро готово и стабильно. С его помощью можно произвольно вызывать любые методы REST API Битрикс.

Однако не все методы REST API Битрикс пока выставлены как удобные клиентские сервисы (например, bitrix. deals.list() ).

Если вам нужна конкретная служба, добавьте ее, выполнив запрос на включение, следуя структуре уже существующих служб и инструкциям «Добавление новых методов».

Я не являюсь пользователем расы мастеров типизированного языка. Могу ли я использовать его с обычным JavaScript?

Конечно. Просто установите и импортируйте его как любой другой модуль NPM. Но The Type Police уже в пути для вас.

Обратите внимание, что эта библиотека не была разработана с учетом обычного JavaScript, поэтому она не выполняет ненужных динамических проверок. Не будьте слишком настойчивы в передаче неправильных параметров — это может привести к неожиданным результатам. В конце концов, TypeScript — рекомендуемый способ его использования.

Должен ли я проверять свойства полезной нагрузки error на наличие ошибок?

Вы не должны. Вместо этого перехватывайте отказы, так как библиотека отклонит их, если в полезной нагрузке есть какие-либо ошибки.

Метод списка не возвращает пользовательские поля!

Bitrix API по умолчанию этого не делает. Используйте подстановочные знаки в выберите параметр , чтобы принудительно включить пользовательские поля:

 bitrix.deals.list({ select: ['*', 'UF_*'] }) 

Пользовательские поля введены неправильно

Клиент не может знать о нестандартных свойствах полезных данных. Из-за этого предполагается, что любая полезная нагрузка может иметь любые дополнительные поля типа 9.0070 [ключ: строка]: строка :

 bitrix.leads.get({ ID: '77' })
  .then(({результат}) => {
    // известное свойство типа `string`
    постоянный заголовок = результат. НАЗВАНИЕ
    // неизвестное свойство типа `string`
    const некоторые данные = результат.UF_23232323
    console.log(название, некоторые данные)
  }) 

Мне нужно вызвать метод Битрикс, который еще не поддерживается

Используйте соответствующие низкоуровневые клиентские методы с приведением типов, например:

 bitrix. call('some.new.get' как любой, { ID: '77' } как любой)
  .then((полезная нагрузка) => полезная нагрузка как GetPayload)
bitrix.list('some.new.list' как любой, { select: ["TITLE"] })
  .then((полезная нагрузка) => полезная нагрузка как ListPayload) 

Мне нужно вызвать определенный набор команд. Как это сделать эффективно?

Используйте метод партии . Он будет обрабатывать всю рутину:

Я использую самоподписанный SSL-сертификат и получаю [RequestError]: самоподписанный сертификат . Что я должен делать?

Переопределить получил параметры в конструкторе:

 const bitrix = Bitrix('https://ИМЯ_ПОРТАЛА.bitrix24.ru/rest', 'ACCESS_TOKEN', {https: { rejectUnauthorized: false }}) 

 bitrix.batch({
  ведущий: { метод: Method.GET_LEAD, параметры: {ID: '77' } },
  сделки: { метод: Method.LIST_DEALS, параметры: {} }
}) 

Разработка

• npm test — запустить все тесты и собрать полный отчет о покрытии
• npm run test:unit — запустить модульные тесты и собрать отчет о покрытии
• npm run test:integration — запустить интеграционные тесты и собрать отчет о покрытии
• npm run test:watch — следить за изменениями и запускать все тесты
• npm run test:unit:watch — отслеживать изменения и запускать модульные тесты
• npm run test:integration:watch — отслеживать изменения и запускать интеграционные тесты
• npm run build — собрать библиотеку для релиза

Добавление новых методов

Правильная обработка параметров метода и типов полезной нагрузки требует некоторой процедуры при добавлении любого нового метода. Надеюсь, в будущем мы сможем сделать это лучше, а пока следуйте этим шагам:

1. Добавить новый метод в перечисление Method .
2. Добавьте его в массив LISTABLE_METHODS , если он выводится в виде списка (с разбивкой на страницы). Не все, что в списке, можно перечислить, поэтому проверьте это.
3. Добавить или обновить связанную службу:
   1. Поместить общедоступные методы службы в файл index.ts . Убедитесь, что вы правильно сопоставляете аргументы метода службы с параметрами call или list .
   2. Добавить связанные сущности в сущности.ts .
   3. Добавить интерфейс, описывающий сервисные методы, в method.ts . Протестируйте и проверьте тип полезной нагрузки метода, чтобы убедиться, что вы правильно его описали!
   4. Расширьте интерфейс Methods с добавленным интерфейсом для конкретной службы. Таким образом, клиент будет знать, как разрешать параметры и типы полезной нагрузки для добавленного метода.
      

      This entry was posted in Популярное