Integrations
BAF Web component uses integrations to receive settings from the server. All requests require an integrationId (Token), which can be taken from the Domains page of BAF Dashboard. Using these APIs outside of a Web component is not recommended.
Get a logo
The request allows you to obtain information about the integration logo.
Endpoint: GET /api/v2/public/Integrations/{integrationId}/Logo
Parameters:
integrationId
Request example:
curl -X 'GET' \
'https://baf.3divi.ai/publicapi/api/v2/public/Integrations/a7863***/Logo' \
-H 'accept: */*'
Response example:
Status Code | 200 |
Possible errors:
Status Code | 404 |
{
"code": "NotFound",
"message": "Integration with id 3fa85*** not found",
"additionalData": null,
"propertyErrors": null,
"multipleErrors": null,
"traceId": "00-4f8c2f41b6f697e3eb126e1434cf4ebd-1018441bf40b5017-00"
}
Get configuration data
The request allows you to obtain information about the styles and settings of the Web component.
Endpoint: GET /api/v2/public/Integrations/{integrationId}/Configuration
Parameters:
integrationId
Request example:
curl -X 'GET' \
'https://baf.3divi.ai/publicapi/api/v2/public/Integrations/a786***/Configuration' \
-H 'accept: text/plain'
Response example:
Status Code | 200 |
{
"cssStyles": "string",
"cssVariables": "string",
"jsonSettings": "string",
"showConsentForm": true,
"consentText": "string",
"checkboxText": "string",
"verifyFace": true,
"hideDocumentTitle": true,
"showQrCode": true
}
Get configuration data without authorization
The request returns information about the integration configuration without authorization: styles and settings of the Web component.
Endpoint: GET /api/v2/public/Integrations/{integrationId}/UnauthConfiguration
Parameters:
integrationId
Request example:
curl -X 'GET' \
'https://baf.3divi.ai/publicapi/api/v2/public/Integrations/a7863***/UnauthConfiguration' \
-H 'accept: text/plain'
Response example:
Status Code | 200 |
{
"cssStyles": "string",
"cssVariables": "string",
"jsonSettings": "string",
"showConsentForm": true,
"consentText": "string",
"checkboxText": "string",
"verifyFace": true,
"hideDocumentTitle": true,
"showQrCode": true
}