Поделиться через


Staffbase (предварительная версия)

С помощью соединителя Staffbase вы объединяете разнородные средства и системы и интегрируете платформу Staffbase в автоматизированные рабочие процессы. Это включает в себя приложение сотрудника или интрасеть для автоматизации процессов, выполнения задач по расписанию или уведомления пользователей о возникновении событий.

Этот соединитель доступен в следующих продуктах и регионах:

Услуга Class Регионы
Copilot Studio Премия Все регионы Power Automate , кроме следующих:
     - Правительство США (GCC)
     - Правительство США (GCC High)
     — Облако Китая, управляемое 21Vianet
     - Министерство обороны США (DoD)
Логические приложения Стандарт Все регионы Logic Apps , кроме следующих:
     — Регионы Azure для государственных организаций
     — Регионы Azure Для Китая
     - Министерство обороны США (DoD)
Power Apps Премия Все регионы Power Apps , кроме следующих:
     - Правительство США (GCC)
     - Правительство США (GCC High)
     — Облако Китая, управляемое 21Vianet
     - Министерство обороны США (DoD)
Power Automate Премия Все регионы Power Automate , кроме следующих:
     - Правительство США (GCC)
     - Правительство США (GCC High)
     — Облако Китая, управляемое 21Vianet
     - Министерство обороны США (DoD)
Контакт
Имя Поддержка Staffbase
URL https://www.staffbase.com
Адрес электронной почты support@staffbase.com
Метаданные соединителя
Publisher Staffbase GmbH
Веб-сайт https://www.staffbase.com
Политика конфиденциальности https://staffbase.com/en/privacy-policy/
Категории Коммуникация; Кадровые ресурсы

Соединитель Staffbase

Соединитель Staffbase для Power Automate позволяет преодолеть разрыв между различными инструментами и системами и включить платформу Staffbase в автоматизированные рабочие процессы. Используйте возможности автоматизированных рабочих процессов, которые включают ваше приложение-сотрудник или интрасеть для автоматизации процессов, выполнения задач по расписанию или уведомления пользователей о событиях.

Предпосылки

  • План Microsoft Power Apps или Power Automate с пользовательским компонентом соединителя
  • Лицензия Staffbase для вашей организации
  • Роль администратора вашей организации на платформе Staffbase
  • Маркер API для настройки проверки подлинности
  • Сведения о том, в каком приложении размещена инфраструктура Staffasbe, обратитесь support@staffbase.com к дополнительным сведениям

Поддерживаемые операции

ChannelGetList

Получение списка каналов новостей

ChannelGetPosts

Получение списка записей в указанном канале

ChannelPostPost

Отправка публикации в определенный канал

CommentsGet

Получение всех комментариев из экземпляра Staffbase

MediaGet

Получение всех носителей из экземпляра Staffbase

MediaGetByID

Получение носителя по идентификатору

MediaDelete

Удаление носителя по идентификатору

NotificationPost

Отправляет уведомление пользователям

PostGetAll

Получение списка записей

PostGetByID

Получение записи по идентификатору

PostDelete

Удаляет запись

PostPut

Обновляет запись

UserGetAll

Получение списка пользователей

UserPost

Приглашение пользователя по имени, фамилии и электронной почте

UserGetByID

Получение сведений о пользователе

User_delete

Удаление пользователя по идентификатору

UserPut

Обновление сведений о пользователе

UserPostRecovery

Отправка сообщения электронной почты восстановления

ProxyVersionGet

Только для внутреннего использования, чтобы проверить текущую версию прокси-сервера API

Получение учетных данных

Для базовой проверки подлинности между платформой Staffbase и рабочим процессом, созданным в Power Automate, требуется маркер API. Вы можете создать маркер API из Staffbase Experience Studio.

Начало работы

Настройте соединитель с базовой проверкой подлинности и URL-адресом размещения.

  1. В Power Automate перейдите к соединителям.
  2. Найдите соединитель Staffbase.
  3. Щелкните соединитель Staffbase. Откроется диалоговое окно для настройки соединителя.
  4. В поле маркера API добавьте маркер API с помощью следующего синтаксиса: "Базовый " [API-Token]

Примечание. Необходимо добавить пустое пространство между "Базовым" и маркером API.

В поле "Идентификатор узла" введите идентификатор инфраструктуры, в которой размещена платформа Staffbase:

  • Немецкая инфраструктура: de1
  • Международная инфраструктура: us1

Дополнительные сведения см. на портале поддержки Staffbase.

Известные проблемы и ограничения

Соединитель Staffbase в настоящее время не поддерживает все функции API Staffbase. Дополнительные сведения об API Staffbase см. на портале разработчиков Staffbase.

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

Какие рабочие процессы можно автоматизировать с помощью соединителя Staffbase?

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

Существуют ли учебники, которые помогут мне приступить к работе с автоматизированным рабочим процессом с помощью соединителя Staffbase?

Staffbase предлагает учебники, использующие подключаемый модуль Forms и соединитель Staffbase для автоматизации управления объектами. Узнайте, как настроить его в этом разделе.

Инструкции по развертыванию

Выполните следующие команды и следуйте инструкциям.

paconn create --api-def apiDefinition.swagger.json --api-prop apiProperties.json --secret <client_secret>

Создание подключения

Соединитель поддерживает следующие типы проверки подлинности:

По умолчанию Параметры для создания подключения. Все регионы Недоступен для совместного использования

По умолчанию

Применимо: все регионы

Параметры для создания подключения.

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

Имя Тип Description Обязательно
API-Key securestring "API-Key" для экземпляра Staffbase True
Идентификатор размещения струна Укажите идентификатор размещения: hostingID True

Ограничения регулирования

Имя Вызовы Период обновления
Вызовы API для каждого подключения 100 60 секунд

Действия

Записи: обновляет запись

Обновляет запись, только измененное поле (добавочное).

Записи: получение записи по идентификатору

Запрашивает указанные записи, включая набор комментариев.

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

Получение списка комментариев.

Записи: получение списка записей

Получите список записей, доступных для маркера API.

Записи: удаление записи

Удаляет запись из системы.

Каналы: отправка записи в определенный канал

Отправьте запись в конкретный канал новостей.

Каналы: получение списка записей в указанном канале

Получение списка записей в указанном канале.

Каналы: получение списка каналов новостей

Получение списка каналов новостей.

Носитель: получение всех носителей

Описание всех носителей, доступных в текущем контексте.

Носитель: получение носителя по идентификатору

Получение метаданных для одного носителя по идентификатору.

Носитель: удаление носителя

Удаляет указанный носитель в текущем контексте.

Пользователь: обновление сведений о пользователе

Обновление сведений о пользователе.

Пользователь: отправка сообщения электронной почты восстановления

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

Пользователь: получение сведений о пользователе

Получение определенных сведений о пользователе по идентификатору пользователя.

Пользователь: получение списка пользователей

Получение списка пользователей в зависимости от маркера доступа к API.

Пользователь: приглашение пользователя

Пользователь получит сообщение электронной почты для регистрации.

Пользователь: удаление пользователя

Удаляет указанного пользователя.

Прокси: получение версии

Возвращает текущую версию прокси-сервера.

Уведомление: отправка уведомления

Отправляет уведомления указанным пользователям.

Записи: обновляет запись

Обновляет запись, только измененное поле (добавочное).

Параметры

Имя Ключ Обязательно Тип Описание
PageID
pageID True string

Это может быть либо идентификатор записи, определенный API, либо если задан внешний идентификатор postID.

внешний идентификатор
externalID string

Необязательно. Введите внешний идентификатор здесь.

местность
locale string

Вставьте языковой стандарт, например de_DE, en_US и т. д.

содержимое
content string

Введите здесь содержимое новостей.

image
image string

Введите ссылку на изображение здесь.

задира
teaser string

Введите свой тизер здесь.

title
title string

Введите свой заголовок здесь.

опубликованный
published string

Введите дату публикации здесь.

Записи: получение записи по идентификатору

Запрашивает указанные записи, включая набор комментариев.

Параметры

Имя Ключ Обязательно Тип Описание
PageID
pageID True string

Это идентификатор записи.

Возвращаемое значение

Тело
postData

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

Получение списка комментариев.

Параметры

Имя Ключ Обязательно Тип Описание
Manage
manage boolean

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

Лимит
limit integer

Количество возвращаемых элементов (по умолчанию и максимум 100).

Смещение
offset integer

Определите смещение для получения элементов, начиная с этого числа.

Filter
filter string

Фильтрация в формате SCIM2 с частичной поддержкой. В настоящее время поддерживаются только неструктурированные структуры (не вложенные предложения) и предложения сравнения, такие как eq = "equals", gt = "больше", ge = "больше или равно", lt = "меньше", le = "меньше или равно". Для поддерживаемых примечаний поля фильтра создаются и обновляются. Значение этих полей можно указать в строке UTC DateTime, представляющей или длинное число миллисекундах эпохи Unix. Пример 1: filter=updated ge "2020-11-26T10:14:48.947Z" и обновлен le "2020-11-26T10:14:48.947Z". В этом примере фильтр диапазона DateTime применяется к обновленному полю с предложениями ge и le сравнения и логическое предложение. Пример 2: filter=created gt "2020-11-26T10:14:48.947Z". Получите все примечания, созданные после указанной даты.

Возвращаемое значение

Имя Путь Тип Описание
итог
total integer

Общее количество найденных комментариев.

limit
limit integer

Количество возвращаемых элементов.

offset
offset integer

Текущее определенное смещение для получения элементов, начиная с этого числа.

данные
data array of object
id
data.id string

Это идентификатор комментария.

parentID
data.parentID string

Идентификатор родительского элемента комментария может быть либо записью, либо комментарием.

parentType
data.parentType string

Родительский тип может быть записью или комментарием.

текст примечания
data.text string

Это содержимое комментариев и само тестирование.

идентификатор записи
data.rootID string

Это идентификатор публикации, с чем связан этот комментарий.

автор
data.author authorObject
итог
data.likes.total integer

Это число примечаний.

isLiked
data.likes.isLiked string

Нравится ли этот комментарий?

создано
data.created string

Дата создания комментария.

Обновлено
data.updated string

Обновленная дата комментария.

image
data.image imageObject

Записи: получение списка записей

Получите список записей, доступных для маркера API.

Параметры

Имя Ключ Обязательно Тип Описание
Query
query string

Строка, которую можно использовать для поиска содержимого публикации.

Лимит
limit integer

Количество возвращаемых элементов (по умолчанию и максимум 100).

Смещение
offset integer

Определите смещение для получения элементов, начиная с этого числа.

Выполнимый
manageable boolean

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

ContentType
contentType string

Необязательный фильтр для заданных типов контента публикации. (По умолчанию не фильтруется)

Возвращаемое значение

Имя Путь Тип Описание
итог
total integer

Общее количество найденных записей.

limit
limit integer

Количество возвращаемых элементов.

offset
offset integer

Текущее определенное смещение для получения элементов, начиная с этого числа.

данные
data array of postData

Записи: удаление записи

Удаляет запись из системы.

Параметры

Имя Ключ Обязательно Тип Описание
PageID
pageID True string

Это может быть либо идентификатор записи, определенный API, либо если задан внешний идентификатор postID.

Возвращаемое значение

Имя Путь Тип Описание
идентификатор
identifier integer

Идентификатор удаления.

код состояния
statusCode integer

Код состояния действия.

сообщение
message string

Сообщение действия.

type
type string

Тип действия.

Каналы: отправка записи в определенный канал

Отправьте запись в конкретный канал новостей.

Параметры

Имя Ключ Обязательно Тип Описание
ChannelID
channelID True string

Вставьте здесь идентификатор канала.

внешний идентификатор
externalID string

Необязательно. Введите внешний идентификатор здесь.

местность
locale string

Вставьте языковой стандарт, например de_DE, en_US и т. д.

содержимое
content string

Введите здесь содержимое новостей.

image (ссылка)
image string

Введите ссылку на изображение здесь.

задира
teaser string

Введите свой тизер здесь.

title
title string

Введите свой заголовок здесь.

опубликованный
published string

Введите дату публикации здесь.

Каналы: получение списка записей в указанном канале

Получение списка записей в указанном канале.

Параметры

Имя Ключ Обязательно Тип Описание
ChannelID
channelID True string

Вставьте здесь идентификатор канала, например полученный getChannels.

Лимит
limit integer

Количество возвращаемых элементов (по умолчанию и максимум 100).

Смещение
offset integer

Определите смещение для получения элементов, начиная с этого числа.

Возвращаемое значение

Имя Путь Тип Описание
итог
total integer

Общее количество найденных записей.

limit
limit integer

Количество возвращаемых элементов.

offset
offset integer

Текущее определенное смещение для получения элементов, начиная с этого числа.

данные
data array of postData

Каналы: получение списка каналов новостей

Получение списка каналов новостей.

Возвращаемое значение

Имя Путь Тип Описание
итог
total integer

Общее количество найденных каналов.

limit
limit integer

Количество возвращаемых элементов.

offset
offset integer

Текущее определенное смещение для получения элементов, начиная с этого числа.

данные
data array of object
id
data.id string

Это идентификатор канала.

локализация
data.config.localization array of object
title
data.config.localization.title string

Название канала, локализованное.

местность
data.config.localization.locale string

Это языковой стандарт заголовка канала.

spaceID
data.spaceID string

Идентификатор пространства, которому назначен канал.

создано
data.created string

Дата создания канала.

опубликованный
data.published string

Дата публикации канала.

Обновлено
data.updated string

Обновленная дата канала.

Носитель: получение всех носителей

Описание всех носителей, доступных в текущем контексте.

Параметры

Имя Ключ Обязательно Тип Описание
Лимит
limit integer

Ограничение количества элементов здесь.

Смещение
offset integer

Задайте смещение для запроса.

Возвращаемое значение

Имя Путь Тип Описание
итог
total integer

Общее количество найденных ресурсов.

limit
limit integer

Количество возвращаемых элементов.

offset
offset integer

Текущее определенное смещение для получения элементов, начиная с этого числа.

данные
data array of mediaData

Носитель: получение носителя по идентификатору

Получение метаданных для одного носителя по идентификатору.

Параметры

Имя Ключ Обязательно Тип Описание
Средний идентификатор
mediumID True string

Запрашивает сведения о определенном носителе.

Возвращаемое значение

Тело
mediaData

Носитель: удаление носителя

Удаляет указанный носитель в текущем контексте.

Параметры

Имя Ключ Обязательно Тип Описание
Средний идентификатор
mediumID True string

Удаляет носитель по идентификатору. Хотя это немедленно приведет к удалению ресурса с наших серверов, CDN по-прежнему может доставлять содержимое по URL-адресу, указанному в resourceInfo.url, пока CDN не будет недействительным.

Пользователь: обновление сведений о пользователе

Обновление сведений о пользователе.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор пользователя
userID True string

Идентификатор может быть основан на идентификаторе userID, автоматически созданном платформой Staffbase или внешним ИДЕНТИФИКАТОРом, если он добавляется для пользователя.

id
id string

Идентификатор пользователя

внешний идентификатор
externalID string

Внешний идентификатор пользователя

Имя
firstName string

Имя пользователя

lastName
lastName string

Фамилия пользователя

publicEmailAddress
publicEmailAddress string

Общедоступная электронная почта пользователя

местность
locale string

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

электронная почта
value string

Адрес электронной почты

основной
primary boolean

Это основной адрес электронной почты?

идентификаторы групп
groupIDs array of string
позиция
position string

Позиция пользователя

отдел
department string

Отдел пользователя

location
location string

Расположение пользователя

номер телефона
phoneNumber string

Номер телефона пользователя

создано
created string

Дата создания пользователя

Обновлено
updated string

Обновленная дата пользователя

активированный
activated string

Активируется ли пользователь?

Возвращаемое значение

Тело
userData

Пользователь: отправка сообщения электронной почты восстановления

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

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор пользователя
userID True string

Идентификатор может быть основан на идентификаторе userID, автоматически созданном платформой Staffbase или внешним ИДЕНТИФИКАТОРом, если он добавляется для пользователя.

Пользователь: получение сведений о пользователе

Получение определенных сведений о пользователе по идентификатору пользователя.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор пользователя
userID True string

Идентификатор может быть основан на идентификаторе userID, автоматически созданном платформой Staffbase или внешним ИДЕНТИФИКАТОРом, если он добавляется для пользователя.

Возвращаемое значение

Тело
userData

Пользователь: получение списка пользователей

Получение списка пользователей в зависимости от маркера доступа к API.

Параметры

Имя Ключ Обязательно Тип Описание
Нотация SCIM может использоваться для фильтрации
filter string

Нотация SCIM может использоваться для фильтрации.

Полнотекстовый поиск можно объединить с фильтром
query string

Здесь вы можете выполнить сераш в любом поле профиля.

Пользователь: приглашение пользователя

Пользователь получит сообщение электронной почты для регистрации.

Параметры

Имя Ключ Обязательно Тип Описание
электронная почта
email string

Это адрес электронной почты пользователя.

Имя
firstName string

Это имя пользователя.

lastName
lastName string

Это последнее имя пользователя.

Пользователь: удаление пользователя

Удаляет указанного пользователя.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор пользователя
userID True string

Идентификатор может быть основан на идентификаторе userID, автоматически созданном платформой Staffbase или внешним ИДЕНТИФИКАТОРом, если он добавляется для пользователя.

Прокси: получение версии

Возвращает текущую версию прокси-сервера.

Уведомление: отправка уведомления

Отправляет уведомления указанным пользователям.

Параметры

Имя Ключ Обязательно Тип Описание
accessorIds
accessorIds array of string
местность
locale string

Вставьте языковой стандарт, например de_DE, en_US и т. д.

title
title string

Вставка зависимого от языка заголовка.

link
link string

Optinal: вставьте ссылку здесь.

Возвращаемое значение

Имя Путь Тип Описание
id
id string

Это идентификатор уведомления.

accessorIds
recipients.accessorIds array of string

Это список идентификаторов получателей.

содержимое
content array of object
title
content.title string

Заголовок уведомления, локализованного.

местность
content.locale string

Это языковой стандарт заголовка.

link
link string

Это ссылка на уведомление.

type
type string

Это тип уведомления.

createdAt
createdAt string

Дата создания уведомления.

создано
created string

Дата создания уведомления.

Определения

mediaData

Имя Путь Тип Описание
id
id string

Это идентификатор ресурса.

ownerID
ownerID string

Это идентификатор владельца этого ресурса.

parentID
parentID string

Это идентификатор родительского ресурса мультимедиа.

publicID
publicID string

Это общедоступный идентификатор для доступа к ресурсу.

type
resourceInfo.type string

Это тип ресурса ресурса.

байт
resourceInfo.bytes integer

Это размер ресурса (в байтах).

Ширина
resourceInfo.width integer

Это ширина ресурса.

height
resourceInfo.height integer

Это высота ресурса.

URL-адрес
resourceInfo.url string

Это URL-адрес ресурса.

format
resourceInfo.format string

Это формат ресурса.

тип MIME
resourceInfo.mimeType string

Это тип MIME ресурса.

fileName
fileName string

Это имя файла мультимедиа.

title
title string

Это название носителя.

label
label string

Это метка мультимедиа.

создано
created string

Дата создания ресурса.

userData

Имя Путь Тип Описание
id
id string

Идентификатор пользователя

внешний идентификатор
externalID string

Внешний идентификатор пользователя

Имя
firstName string

Имя пользователя

lastName
lastName string

Фамилия пользователя

publicEmailAddress
publicEmailAddress string

Общедоступная электронная почта пользователя

местность
config.locale string

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

сообщения электронной почты
emails array of object

Сведения о электронной почте пользователя

электронная почта
emails.value string

Адрес электронной почты

основной
emails.primary boolean

Это основной адрес электронной почты?

идентификаторы групп
groupIDs array of string
позиция
position string

Позиция пользователя

отдел
department string

Отдел пользователя

location
location string

Расположение пользователя

номер телефона
phoneNumber string

Номер телефона пользователя

создано
created string

Дата создания пользователя

Обновлено
updated string

Обновленная дата пользователя

активированный
activated string

Активируется ли пользователь?

postData

Имя Путь Тип Описание
id
id string

Идентификатор записи.

автор
author authorObject
contents
contents array of object
содержимое
contents.content string

Содержимое публикации, локализованное.

image
contents.image imageObject
задира
contents.teaser string

Пост тизер, который локализован.

title
contents.title string

Название записи, локализованное.

местность
contents.locale string

Это языковой стандарт элемента.

id
channel.id string

Это идентификатор канала.

локализация
channel.config.localization array of object
title
channel.config.localization.title string

Это название канала, локализованное.

местность
channel.config.localization.locale string

Это языковой стандарт заголовка канала.

опубликованный
published string

Дата публикации.

создано
created string

Дата создания записи.

Обновлено
updated string

Обновленная дата публикации.

authorObject

Имя Путь Тип Описание
Имя
firstName string

Это имя автора.

id
id string

Это идентификатор автора.

lastName
lastName string

Это последнее имя автора.

URL-адрес
avatar.original.url string

Это исходный URL-адрес изображения аватара автора.

Ширина
avatar.original.width integer

Это исходная ширина изображения аватара автора.

height
avatar.original.height integer

Это исходное изображение аватара автора.

size
avatar.original.size integer

Это исходный образ аватара автора (в байтах).

format
avatar.original.format string

Это исходный формат аватара автора.

тип MIME
avatar.original.mimeType string

Это изображение аватара athor, исходное mimeType.

создано
avatar.original.created string

Это дата создания аватара автора.

URL-адрес
avatar.icon.url string

Это URL-адрес значка аватара автора.

Ширина
avatar.icon.width integer

Это ширина значка аватара автора.

height
avatar.icon.height integer

Это высота значка аватара автора.

format
avatar.icon.format string

Это формат значка аватара автора.

тип MIME
avatar.icon.mimeType string

Это значок аватара автора mimeType.

URL-адрес
avatar.thumb.url string

Это URL-адрес аватара автора.

Ширина
avatar.thumb.width integer

Это ширина аватара автора.

height
avatar.thumb.height integer

Это высота аватара автора.

format
avatar.thumb.format string

Это формат аватара автора.

тип MIME
avatar.thumb.mimeType string

Это миметип аватара афора.

publicID
avatar.publicID string

Это общедоступный идентификатор аватара автора.

imageObject

Имя Путь Тип Описание
URL-адрес
original.url string

Это исходный URL-адрес изображения.

Ширина
original.width integer

Это исходная ширина изображения.

height
original.height integer

Это исходная высота изображения.

size
original.size integer

Это исходный размер изображения (в байтах).

format
original.format string

Это исходный формат изображения.

тип MIME
original.mimeType string

Это исходный mimeType изображения.

URL-адрес
original_scaled.url string

Это исходный URL-адрес изображения.

Ширина
original_scaled.width integer

Это исходная ширина изображения.

height
original_scaled.height integer

Это исходная высота изображения.

format
original_scaled.format string

Это исходный формат изображения.

тип MIME
original_scaled.mimeType string

Это исходный mimeType изображения.

URL-адрес
compact.url string

Это url-адрес сжатия изображения.

Ширина
compact.width integer

Это компактная ширина изображения.

height
compact.height integer

Это компактная высота изображения.

format
compact.format string

Это компактный формат изображения.

тип MIME
compact.mimeType string

Это компактный mimeType изображения.