ZUzuora
SDK Feature Decision Engine

Retrieve a single decision

For compatibility with CDN, any web headers (Referrer, User-Agent) will be accepted and passed onto the rule engine

get/zephr/decision-engine

Request

  • Base URL
    https://demo-site
  • URL
    https://demo-site/zephr/decision-engine
  • Auth
    • API key in cookie blaize_session
    • or API key in query parameter jwt
    • or API key in header x-blaize-jwt
    • or API key in header x-zephr-jwt
    • or HTTP bearer
    • or API key in cookie blaize_jwt

Query parameters

sdkFeatureSlugstring required

Feature SDK slug

sessionstring required

Zephr Session ID, required for trials.

foreign_id.xxxstring required

Foreign ID used to identify the user. The foreign system is parsed as the remainder of the parameter key name following 'foreign_id.'

ipstring required

Client IP address, defaults to request IP.

userAgentstring required

Client user agent

pathstring required

Request path, required for trials.

content_idstring required

Content ID, used to perform requests to a 3rd party API for additional content information used in making a decision.

jwtstring required

A Json web token, may include identity or product holding claims.

rawboolean required

Should output raw value

Response

Raw parameter response

sdkFeatureSlugstring required

The slug of the SDK feature which has been evaluated.

outputType'ENUM' | 'STRING' | 'NUMBER' | 'JSON' | 'TRANSFORMATION' | 'COMPONENT'

Feature output type. Present if there were no errors.

outputValuestring

Feature output value. Present if there were no errors.

  • For the 'JSON_COMPONENT' output type, the response will be stringified JSON.
  • For the 'TRANSFORMATION' output type, the response will contain a stringified JSON array of transformations to be applied, including ENABLE_CONTENT, CUSTOM_COMPONENT, TEMPLATE_COMPONENT and FORM.
errorstring

The error message explaining why this decision failed to resolve. Present only if there was an error.

Example response

{
  "sdkFeatureSlug": "sdk-feature-1",
  "outputValue": "YES",
  "error": "500: Internal error ..."
}

Changes

No recorded changes to this operation across all 2 revisions of this API.