Перейти до вмісту
Blackbird API

Sitecore XM Cloud

View on Github

Sitecore є однією з провідних систем керування контентом корпоративного рівня, що дозволяє редакторам веб-контенту та маркетологам повністю контролювати всі аспекти свого сайту, від соціальної інтеграції та блогів до розширеної персоналізації, електронної комерції тощо. Цей додаток зосереджується на інтеграції між елементами Sitecore, мовами та рештою екосистеми Blackbird. На відміну від інших додатків Blackbird, для початку роботи вам потрібно встановити спеціально розроблений плагін на ваш екземпляр Sitecore.

Цей додаток розроблено для Sitecore XP. Для Sitecore XM Cloud див. цей посібник.

Перед налаштуванням

Перш ніж підключитися, переконайтеся, що:

  • У вас є доступ до XM Cloud Deploy, його керування обліковими даними та активний проєкт Sitecore.
  • У вас є доступ до репозиторію вихідного коду (Github) проєкту Sitecore та можливість налаштовувати нові плагіни.
  • Ви завантажили останній пакет плагіна Blackbird Sitecore звідси.

Встановлення плагіна

Припускаючи, що ваш репозиторій вихідного контенту форкнуто з цього репозиторію.

  1. Розпакуйте файли з package.zip
  2. Скопіюйте 2 конфігураційні файли з package\files\App_Config\Include\BlackBird у пакеті до authoring\platform\App_Config\Include\ у репозиторії вихідного коду.
  3. Скопіюйте 2 dll файли з package\files\bin у пакеті до authoring\platform\_dlls у репозиторії вихідного коду.
  4. Відкрийте XmCloudAuthoring.sln у Visual Studio (або будь-якому іншому IDE, сумісному з .NET) і додайте посилання на додані .dll файли у проєкті Platform.
  5. Також включіть посилання на файли для 2 конфігураційних файлів.

Тепер ваше рішення має виглядати приблизно так:

1738074666500

  1. Зберіть та/або відправте свій код, щоб ініціювати повторне розгортання.

Створення API-ключа

  1. Перейдіть до Content Editor.
  2. Перейдіть до System -> Settings -> Services -> API Keys.
  3. Вставте новий елемент API Key.

1706110975432

  1. Заповніть наступні поля:
    • Allowed controllers: встановіть * або виберіть контролери.
    • Impersonation User: запит буде виконано від імені цього користувача. Адміністратор Sitecore може створювати користувачів з певними обмеженнями, якщо потрібно. Анонімні користувачі будуть імітуватися як цей користувач, якщо поле порожнє.
  2. Опублікуйте елемент.

1706111272004

  1. Скопіюйте ID елемента (включно з дужками) - це ваш ключ, який можна використовувати в наступних кроках.

Створення клієнта XM Cloud

  1. У XM Cloud перейдіть на вкладку облікових даних.
  2. Натисніть Create credentials і додайте розпізнавану мітку.
  3. Скопіюйте Client ID і Client Secret для наступних кроків.

Підключення

  1. Перейдіть до додатків і знайдіть Sitecore XM Cloud.
  2. Натисніть Add Connection.
  3. Назвіть своє підключення для подальшого використання, наприклад, ‘My Sitecore connection’.
  4. Заповніть базову URL-адресу вашого екземпляра Sitecore.
  5. Заповніть API-ключ з розділу Створення API-ключа.
  6. Заповніть Client ID і Client Secret з розділу Створення клієнта XM Cloud.
  7. Натисніть Connect.

1738074896204

Actions

  • Search items знаходить елементи на основі ваших критеріїв пошуку, включаючи останні оновлення, створення, мову, шлях тощо.
  • Get all configured languages повертає всі мови, які налаштовані в цьому екземплярі Sitecore.
  • Get item content as HTML отримує вміст елемента у вигляді HTML-файлу, щоб його можна було обробляти за допомогою NMT або TMS. Ви можете вказати, яку версію/мову слід отримати.
  • Update item content from HTML оновлює вміст конкретної версії/мови. Крім того, ви можете вибрати, щоб завжди створювати нову версію.
  • Delete item content видаляє елемент.
  • Get Item ID from HTML отримує ID елемента з HTML-вмісту. Коли ви отримуєте перекладений HTML-вміст, ми додаємо ID елемента до заголовка HTML-файлу, ця дія дозволяє вам отримати ID елемента з HTML-документа.

Events

  • On items created спрацьовує, коли створюються нові елементи.
  • On items updated спрацьовує, коли будь-який елемент оновлюється.

Приклад

Цей приклад показує, як можна отримати підмножину елементів на основі користувацьких критеріїв, завантажити ці елементи у вигляді HTML-файлів, перекласти їх за допомогою будь-якого NMT-провайдера та оновити переклади.

1706274178376

Зворотній зв’язок

Хочете використовувати цей додаток або маєте відгуки щодо нашої реалізації? Зв’яжіться з нами через встановлені канали або створіть проблему.