Site¶

Configuration about the site.

Categories¶

Note

The URL for this API will be moving.

GET /api/v2/apps/category/¶

Returns a list of categories available on the marketplace.

Request

Standard Listing query params.

Response

Parameters:	meta (object) – Listing response meta. objects (array) – A listing of categories.
Status Codes:	200 OK – successfully completed.

GET /api/v2/apps/category/(string: slug)/¶

Returns a category.

Response

{
    "name": "Games",
    "slug": "games"
}

Carriers¶

GET /api/v2/services/carrier/¶

Returns a list of possible carriers for apps.

Response

Parameters:	meta (object) – Listing response meta. objects (array) – A listing of carriers.
Status Codes:	200 OK – successfully completed.

GET /api/v2/services/carrier/<slug>/¶

Returns a carrier.

Request

Standard Listing query params.

Response

{
    "id": "1",
    "name": "PhoneORama",
    "resource_uri": "/api/v2/services/carrier/phoneorama/",
    "slug": "phoneorama"
}

Regions¶

GET /api/v2/services/region/¶

Returns a list of possible regions for apps.

Response

Parameters:	meta (object) – Listing response meta. objects (array) – A listing of regions.
Status Codes:	200 OK – successfully completed.

GET /api/v2/services/region/<slug>/¶

Returns a region.

Request

Standard Listing query params.

Response

{
    "id": "1",
    "name": "Appistan",
    "slug": "ap",
}

Configuration¶

GET /api/v2/services/config/site/¶

Returns information about how the marketplace is configured. Not all settings and configuration options are returned - only a subset. This subset will change as features in the site change. The list of results should not be relied upon to stay consistent.

Response

Parameters:	fxa (object) – an object containing Firefox Accounts auth information if the Firefox Accounts waffle switch is active. version (string\|null) – the git commit number of the deployment. settings (object) – a subset of useful site settings. waffle (object) – an object containing a list waffle flags and switches.

Example:

{
    "fxa": {
        "fxa_auth_state": "aaabbbccctoken",
        "fxa_auth_url": "https://somelongauthurl.com?stuff=stuff"
    },
    "waffle": {
        "switches": {
            "some-switch": {
                "name": "some-switch",
                "created": "2013-12-17T15:38:10",
                "modified": "2013-12-17T15:38:10",
                "note": "",
                "active": true,
                "id": 17
            }
        },
        "flags": {
            "some-flag": {
                "note": "",
                "users": [],
                "testing": false,
                "everyone": true,
                "groups": [],
                "rollout": false,
                "id": 1,
                "staff": false,
                "superusers": true,
                "authenticated": false,
                "name": "a-flag",
                "created": "2013-12-19T10:21:56",
                "percent": null,
                "modified": "2013-12-19T10:21:56",
                "languages": ""
           }
        }
    }
    "settings": {
        "SITE_URL": "http://z.mozilla.dev"
    },
    "version": null
}

?serializer=commonplace

If you pass commonplace as a GET parameter for serializer, the switches response will be simply a list of names of the active switches.

Parameters:	switches (array) – a list of waffle switches

Example:

{
    ...

    "waffle": {
        "switches": ["user-curation", "feed"]
    },

    ...
}

For full information about waffle flags and switches, please see the waffle documentation: http://waffle.readthedocs.org/en/latest/types.html

Price tiers¶

GET /api/v2/services/price-tier/¶

Lists price tiers.

Response

Parameters:	objects – A listing of tiers.

GET /api/v2/services/price-tier/(int: id)/¶

Returns a price tier.

Response

Parameters:	resource_uri (string) – The URI for this tier. active (boolean) – Whether the price tier is active. name (string) – The price tier name. method (string; one of "operator", "card", or "operator+card".) – How payment may be submitted.

POST /api/v2/services/price-tier/¶

Create a price tier.

Note

Requires admin account.

Request

Parameters:	active (boolean) – Whether the price tier is active. name (string) – The price tier name. method (string; one of "operator", "card", or "operator+card".) – How payment may be submitted. price (decimal string) – Price in US dollars.

PUT /api/v2/services/price-tier/(int: id)/¶

Update a price tier.

Note

Requires admin account.

Request

Parameters:	active (boolean) – Whether the price tier is active. name (string) – The price tier name. method (string; one of "operator", "card", or "operator+card".) – How payment may be submitted. price (decimal string) – Price in US dollars.

DELETE /api/v2/services/price-tier/(int: id)/¶: Delete a price tier and all associated prices.

Note

Requires admin account.

GET /api/v2/services/price-currency/¶

Lists prices in various currencies.

Request

Parameters:	tier (number) – Price tier ID to select currencies for.

Response

Parameters:	objects – A listing of prices.

GET /api/v2/services/price-currency/(int: id)/¶

Fetch a single price.

Response

Parameters:

id (number) – Identifier for this price.
tier (number) – ID of tier this price belongs to.
currency (string) – Code for this price’s currency.
carrier (string) – Slug of carrier this price applies to.
price (number) – Price in this currency.
provider (string) – Name of payment provider for this price.
method (string; one of "operator", "card", or "operator+card".) – How payment may be submitted.

POST /api/v2/services/price-currency/¶

Create a price.

Note

Requires admin account.

Request

Parameters:

tier (number) – ID of tier this price belongs to.
currency (string) – Code for this price’s currency.
carrier (string) – Slug of carrier this price applies to.
price (number) – Price in this currency.
provider (string) – Name of payment provider for this price.
method (string; one of "operator", "card", or "operator+card".) – How payment may be submitted.

PUT /api/v2/services/price-currency/(int: id)/¶

Update a price.

Note

requires an admin account.

Request

Parameters:

tier (number) – ID of tier this price belongs to.
currency (string) – Code for this price’s currency.
carrier (string) – Slug of carrier this price applies to.
price (number) – Price in this currency.
provider (string) – Name of payment provider for this price.
method (string; one of "operator", "card", or "operator+card".) – How payment may be submitted.

DELETE /api/v2/services/price-currency/(int: id)/¶: Delete a price.

Note

Requires admin account.