Fireplace

Fireplace is the consumer client for the Marketplace. It has some special API’s. These are not recommended for consumption by other clients and can change in conjunction with the Fireplace client.

App

GET /api/v2/fireplace/app/

A copy of the app API. The response only contains the specific subset of fields Fireplace needs.

Error reporter

POST /api/v2/fireplace/report_error

An entry point for reporting client-side errors via Sentry.

Request

Takes a sentry.interfaces.Exception JSON object.

Example:

[{
    "value": "important problem",
    "stacktrace": {
        "frames": [{
               "abs_path": "/real/file/name.py"
                "filename": "file/name.py",
                "function": "myfunction",
                "vars": {
                    "key": "value"
                },
                "pre_context": [
                    "line1",
                    "line2"
                ],
                "context_line": "line3",
                "lineno": 3,
                "in_app": true,
                "post_context": [
                    "line4",
                    "line5"
                ],
            }]
        }
}]

Response

Status Codes:

• 204 No Content – Message sent.

Search

GET /api/v2/fireplace/search/

A copy of the search API. Like the App API above, the response only contains the specific subset of fields Fireplace needs.

Featured Search

GET /api/v2/fireplace/search/featured/

A copy of the search API. Like the App API above, the response contains the specific subset of fields Fireplace needs.

Only kept for backwards-compatibility purposes, don’t use in new code.

Multi Search

GET /api/v2/fireplace/multi-search/

A copy of the multi-search API. Like the App API above, the response only contains the specific subset of fields Fireplace needs.

Consumer Information

GET /api/v2/fireplace/consumer-info/

Return information about the client making the request.

Response

Parameters:

• region (string) – The region slug for this client.

If user authentication information is passed to the request, the following will also be added to the response:

Parameters:

• apps.developed (array) – IDs of apps the user has developed.
• apps.installed (array) – IDs of apps the user has installed.
• apps.purchased (array) – IDs of apps the user has purchased.
• enable_recommenations – A boolean if we should show app recommendations.