Bloomreach

Get the Bloomreach configuration

get

/api/{tenantId}/admin/extensions/bloomreach

Returns the non-secret Bloomreach configuration for this tenant and whether an API key secret is currently stored. Returns 404 when Bloomreach is not configured. The API key secret itself is never returned.

Required scopes

This endpoint requires the following scopes:

Authorizations

OAuth2implicitRequired

Authorization URL:

Path parameters

tenantIdstringRequired

Responses

200

Configuration returned.

Response body for Bloomreach configuration.

projectTokenstring · min: 1Required

Bloomreach project token.

baseUrlstring · uriRequired

Bloomreach API base URL.

apiKeyIdstring · min: 1Required

API key ID used for Basic authentication.

hasApiKeySecretbooleanRequired

Whether an API key secret is currently stored in the secret repository.

401

Caller not authenticated.

403

Caller lacks required scope.

404

Bloomreach is not configured for this tenant.

get/api/{tenantId}/admin/extensions/bloomreach

GET /api/{tenantId}/admin/extensions/bloomreach HTTP/1.1
Host: app.neostore.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "projectToken": "text",
  "baseUrl": "https://example.com",
  "apiKeyId": "text",
  "hasApiKeySecret": true,
  "cache": {
    "customer": null
  }
}

Set Bloomreach configuration

put

/api/{tenantId}/admin/extensions/bloomreach

Validates credentials against the Bloomreach API, then saves the configuration to server/bloomreach.yml. Omit apiKeySecret to update settings without rotating the secret (the existing stored secret is used for the credential check).

Required scopes

This endpoint requires the following scopes:

Authorizations

OAuth2implicitRequired

Authorization URL:

Path parameters

tenantIdstringRequired

Body

Request body for setting Bloomreach configuration.

projectTokenstring · min: 1Required

Bloomreach project token.

baseUrlstring · uriRequired

Bloomreach API base URL.

apiKeyIdstring · min: 1Required

API key ID used for Basic authentication.

apiKeySecretstring · nullableOptional

API key secret used for Basic authentication. Stored in the secret repository under BLOOMREACH-APIKEYSECRET. When omitted, the existing secret is preserved.

Responses

204

Configuration saved.

No content

400

Request body is invalid or the credentials failed to validate against the Bloomreach API.

401

Caller not authenticated.

403

Caller lacks required scope.

put/api/{tenantId}/admin/extensions/bloomreach

PUT /api/{tenantId}/admin/extensions/bloomreach HTTP/1.1
Host: app.neostore.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 119

{
  "projectToken": "text",
  "baseUrl": "https://example.com",
  "apiKeyId": "text",
  "apiKeySecret": null,
  "cache": {
    "customer": null
  }
}

No content