Product Config API

watch.meta.product.retrieve

This API provides configuration details for the specified product, including information such as the supported authentication mechanisms, whether signup is permitted, the maximum session duration, and other relevant settings.

Endpoint

GET v2/watch/meta/product-config

Headers

The authorization header must carry the API key that was provided during application registration.

Header	Value
Authorization	Bearer api_key

Query Parameters

Parameter	Type	Requirement	Description
`device`	String	Required	Specifies the app device on which the API endpoints will be consumed. Values allowed - `Browser`,`iPad`,`AppleTV`,`Firestick`,`Roku`.

Response Body

    {
        "key": "prd-01hj35p9e3pv2hnwzksjzn8gxx",
        "auth_type": "PIN",
        "signup_allowed": true,
        "refresh_token_lifetime_persist": 172800,
        "minimum_app_version": "1.0",
        "app_name": "ABC FYC",
        "screener_reactivation_allowed": false,
        "extras_enabled": true,
        "assets": {
            "terms_and_conditions_enterprise_pdf": {
                "links": [
                    "https://cms.indee.tv/terms_and_conditions.pdf?Expires=1719599515&Signature=wliNxx[%E2%80%A6]nU3FBA66Kx20~kMogfjLEpum59w__&Key-Pair-Id=K3HM5NS5Q9ETxx",
                ],
                "filetype": "PDF"
            },
        },
        "store_links": [
            {
                "device": "iPad",
                "link": "https://apps.apple.com/us/app/glimpse-screeners/id1581737782"
            },

        ],
        "status_code": "W0000"
    }

Field	Type	Description
`key`	String	Unique identifier of the watch product.
`auth_type`	String	Specifies the auth mechanism in place. This could be `PIN` or `PWD`.
`refresh_token_lifetime_persist`	Integer	Shows how long the refresh token will stay active. The frontend developer would typically want to show this information in the equivalent of "Keep me logged in for x days".
`minimum_app_version`	String	The minimum version of the app that is now supported.
`app_name`	String	The exact name of the app as seen on the app store.
`screener_reactivation_allowed`	Boolean	Feature flag. This indicates whether the user for this product can request for reactivation of a screener which is expired.
`extras_enabled`	Boolean	Feature flag. This indicates whether "Extras" on a title are supported for this product.
`assets`	JSON	Provides all the necessary static assets for the product. It includes logos, background images, and documents such as the Terms of Service.
`code`	String	The unique code for a static asset.
`links`	Array	An array of links corresponding to a specific asset code, arranged in the order they need to appear on the frontend.
`filetype`	String	The type of the asset file. Supported values are `IMG` and `PDF`.
`store_links`	JSON	A dictionary mapping native devices to the links of apps on their respective app stores.
`device`	String	The device where the native app is running. Supported values are `Browser`, `iPad`, `AppleTV`, `Firestick`, `Roku`.
`link`	String	The link to the specific device app.
`signup_allowed`	Boolean	Indicates whether this product allows users to sign up for an account.
`generic_error_message`	String	Message to show the user when an unexpected error occurs.
`resume_playback_enabled`	Boolean	Feature flag. Indicates whether playback can resume from where the viewer left off.
`watchlist_enabled`	Boolean	Feature flag. Indicates whether the watchlist is available for this product.
`retrieve_credentials_enabled`	Boolean	Feature flag. Indicates whether viewers can retrieve their credentials.
`tv_chat_session_url`	String	URL used to start a TV support chat session.
`custom_config`	JSON	Product specific configuration passed through to the client.
`bonus_content_label`	String	The label to display for bonus content in the app.
`status_code`	String	The Indee status code for the response.
`status_message`	String	Human readable message describing the response.

Status Codes

Indee status code	HTTP Response Code	Description
W0000	HTTP 200	Success
W2000	HTTP 401	Authorization header was either not passed or there was some issue parsing it
W2001	HTTP 401	API key is invalid or expired, or is not fully configured
W2009	HTTP 401	ClientID header was either not passed or is malformed
W2100	HTTP 403	Origin domain is not whitelisted for this API key
W2108	HTTP 403	Watch product is inactive
W2102	HTTP 451	Request blocked by geofencing for the resolved region
W4900	HTTP 400	Malformed request body
W5001	HTTP 429	Rate limited
W5000	HTTP 500	Unknown server error occurred