Работа с интеграциями

Для получения настроек с сервера веб-компонента BAF для работы с документами использует интеграции. Использование этих API вне веб-компоненты не рекомендуется. Во всех запросах указывается integrationId (Token), который доступен в BAF Dashboard на странице Domains.

Получение логотипа

Запрос позволяет получить информацию о логотипе интеграции.

Эндпоинт GET /publicapi/api/v2/public/Integrations/{integrationId}/Logo

Параметры:

integrationId — ID интеграции

Пример запроса:

curl -X 'GET' \
  'https://baf.ai/publicapi/api/v2/public/Integrations/a7863***/Logo' \
  -H 'accept: */*'

Пример ответа:

Status Code

200

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

Status Code

404

{
  "code": "NotFound",
  "message": "Integration with id 3fa85*** not found",
  "additionalData": null,
  "propertyErrors": null,
  "multipleErrors": null,
  "traceId": "00-4f8c2f41b6f697e3eb126e1434cf4ebd-1018441bf40b5017-00"
}

Получение данных о конфигурации

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

Эндпоинт GET /publicapi/api/v2/public/Integrations/{integrationId}/Configuration

Параметры:

integrationId — ID интеграции

Пример запроса:

curl -X 'GET' \
  'https://baf.ai/publicapi/api/v2/public/Integrations/a786***/Configuration' \
  -H 'accept: text/plain'

Пример ответа:

Status Code

200

{
  "cssStyles": "string",
  "cssVariables": "string",
  "jsonSettings": "string",
  "showConsentForm": true,
  "consentText": "string",
  "checkboxText": "string",
  "verifyFace": true,
  "hideDocumentTitle": true,
  "showQrCode": true
}

Получение данных о конфигурации без авторизации

Запрос возвращает информацию о конфигурации интеграции без авторизации: стили и настройки веб-компоненты.

Эндпоинт GET /publicapi/api/v2/public/Integrations/{integrationId}/UnauthConfiguration

Параметры:

integrationId — ID интеграции

Пример запроса:

curl -X 'GET' \
  'https://baf.ai/publicapi/api/v2/public/Integrations/a7863***/UnauthConfiguration' \
  -H 'accept: text/plain'

Пример ответа:

Status Code

200

{
  "cssStyles": "string",
  "cssVariables": "string",
  "jsonSettings": "string",
  "showConsentForm": true,
  "consentText": "string",
  "checkboxText": "string",
  "verifyFace": true,
  "hideDocumentTitle": true,
  "showQrCode": true
}