Evaluate feature flags — Voidhash Docs

Authorization

x-publishable-key<token>

A project publishable key, which ships inside apps. Send the end user's distinct id in x-distinct-id with it.

In: header

Header parameters

x-distinct-id*string

The distinct id of the end user the request acts for: the anonymous vh_anon_… id the SDK generated, or the id the app identified them with. At most 255 characters.

x-distinct-id-encoding?"percent"

percent when x-distinct-id holds the RFC 3986 percent-encoded UTF-8 form of an id that is not printable ASCII; leave it out when the header holds the id as is.

Value in

"percent"

x-publishable-key*string

The project's publishable key, vh_pk_…. A test key, vh_pk_test_…, works with store sandbox and test purchases.

x-client-bundle-id*string

The app's bundle id on iOS or package name on Android, which picks the project's store configuration for purchases and promotional offers.

x-client-locale?string

The end user's most preferred locale, such as en-US.

x-client-version?string

The app's version, such as 2.4.1.

x-is-backgrounded*string

true when the app sent the request from the background, otherwise false.

Value in

"true"
"false"

x-is-debug-build*string

true when the app is a debug build, otherwise false. Only debug builds can make simulated development purchases.

Value in

"true"
"false"

x-nonce?string

A random id, new for every request, such as a lowercase UUID.

x-observer-mode*string

true when the SDK runs in observer mode: another billing integration owns purchases and the SDK only reports them. Otherwise false.

Value in

"true"
"false"

x-platform*string

The platform the app runs on, such as ios, android or web. Records where a new person signed up.

x-platform-brand?string

The device's manufacturer, such as Apple or Google.

x-platform-device?string

The device's model, such as iPhone15,2; in a browser, its navigator.platform.

x-platform-flavor*string

native in an app, browser in a web page.

Value in

"native"
"browser"

x-platform-flavor-version?string

The version of the app hosting the SDK; native SDKs send the app's version, the web SDK leaves it out.

x-platform-version?string

The operating system's version, such as 17.4; in a browser, its user agent.

x-preferred-locales?string

The end user's preferred locales, most preferred first, separated by commas, such as en-US,de-DE.

x-sdk*string

The SDK making the request: ios, android, react-native or web. A native SDK driven by another reports the outer one, such as react-native.

Value in

"react-native"
"web"
"ios"
"android"

x-sdk-version*string

The version of the SDK making the request, such as 1.4.0.

x-storefront?string

The app store storefront (country) the end user buys from, when the SDK knows it.

Request body

application/json

TypeScript definitions

Use the request body type in TypeScript.

flagKeys?array<string>|

The keys of the flags to evaluate; absent or empty evaluates every flag of the project. Unknown keys are left out of the answer.

Examples

curl -X POST "https://api.voidhash.com/api/v1/sdk/evaluate-flags" \  -H "x-distinct-id: user_8231" \  -H "x-publishable-key: vh_pk_..." \  -H "x-client-bundle-id: com.example.app" \  -H "x-is-backgrounded: true" \  -H "x-is-debug-build: true" \  -H "x-observer-mode: true" \  -H "x-platform: ios" \  -H "x-platform-flavor: native" \  -H "x-sdk: react-native" \  -H "x-sdk-version: 0.0.1-alpha.1" \  -H "Content-Type: application/json" \  -d '{    "flagKeys": [      "new-checkout",      "checkout-headline"    ]  }'

{  "flags": [    {      "key": "new-checkout",      "enabled": true,      "variantKey": null,      "payload": null    },    {      "key": "checkout-headline",      "enabled": true,      "variantKey": "ff_var_h7d2k9m4x1c6v8b3n5q0w2e7",      "payload": "Unlock every workout"    }  ]}

{  "_tag": "Api/SdkValidationError",  "message": "string"}

{  "_tag": "Api/AuthenticationError",  "cause": "string",  "message": "string"}

{  "_tag": "Api/SdkServiceError",  "cause": "string"}

Response body

`application/json`

`application/json`

`application/json`

`application/json`