Перейти к основному содержимому

# Доступ к BAF API

Получить доступ к подсистеме API можно по домену, указанному при развертывании BAF вида http://<baf_domain>/publicapi/docs.

Актуальная версия BAF API — v2.

примечание

<baf_domain> прописан в параметре `ingress.rules.gateway.host` файла ./cfg/baf.values,yaml.

### Получение токена​

Для авторизации в API необходимо получить токен авторизации. Токен можно взять со страницы API Tokens в BAF Dashboard, который доступен по адресу http://<baf_domain>.

примечание

<baf_domain> прописан в параметре `ingress.rules.gateway.host` файла ./cfg/baf.values,yaml.

Логин и пароль для BAF Dashboard указаны в параметре `baf-user-sercet` файла ./cfg/baf.secrets.json.

На странице находятся два токена авторизации: публичный и приватный. Тип используемого токена указан в эндпоинте каждого API-запроса.

### Использование токена​

Для использования токена в API-запросах нажмите на кнопку вверху страницы:

В открывшемся окне вставьте "Bearer {полученный токен}" и нажмите Authorize.

Например: Bearer sk_3938ab7b-cdbf-4a1a-952b-e3782f061f4b

При успешном сохранении токена появится следующее окно:

к сведению

API-запросы в категориях UploadDocuments и EmbeddedApp будут уточнены в следующих релизах.