Access to BAF API

To get access to the API subsystem, follow the link: http://<baf_domain>/publicapi/docs.

The current version of BAF API is v2.

note

<baf_domain> is specified in the ingress.rules.gateway.host parameter of the ./cfg/baf.values,yaml file.

Get a Token

To authorize in API subsystem, you need to get a token. The token can be obtained from the API Tokens page in BAF Dashboard available at http://<baf_domain>.

note

<baf_domain> is specified in the ingress.rules.gateway.host parameter of the ./cfg/baf.values,yaml file.

Login and password for BAF Dashboard are given in baf-user-sercet parameter of the ./cfg/baf.secrets.json file.

There are two authorization tokens on the page: public and secret. The type of token used can be viewed in the endpoint of API request.

Authorize

To use the token in API requests, click the button at the top of the page:

In the opened window insert "Bearer {received token}" and click Authorize.

Example: Bearer sk_3938ab7b-cdbf-4a1a-952b-e3782f061f4b

If the token is successfully saved, the following window will appear:

info

API requests in the UploadDocuments and EmbeddedApp categories are to be clarified in future releases.