Actions | Products | Languages | Countries | Errors

XMLEngine - Documentation

1 - Presentation

1.1 - Presentation of the xmlEngine 0.1

2 - Using the xmlEngine

2.1 - Supported products and services

2.1.1 - List of supported products and services

2.1.2 - Unsupported actions (per product).

2.2 - Authentication

2.2.1 - Creation of your account

2.2.2 - Authentication parameters

2.2.3 - Authentication problems

2.3 - Actions

2.3.1 - The CAT action

2.3.2 - The CONT action

2.3.3 - The TOP action

2.3.4 - The NEWS action

2.3.5 - The NEWSON action

2.3.6 - The SEARCH action

2.3.7 - The COMP action

2.3.8 - The COMPBRAND action

2.3.9 - The PRODUCT action

2.3.10 - The COUNTRY action

2.3.11 - The PRICES action

2.3.12 - The USERAGENT action

2.3.13 - The GAMESCONT action

2.3.14 - The GAMESDETAIL action

2.4 - List of parameters

2.4.1 - The " vhost " parameter

2.4.2 - The " type " parameter

2.4.3 - The " language " parameter

2.4.4 - The " action " parameter

2.4.5 - The " country " parameter

2.4.6 - The " hot " parameter

2.4.7 - The " search " parameter

2.4.8 - The " page " parameter

2.4.9 - The " num_per_page " parameter

2.4.10 - The " cat " parameter

2.4.11 - The " preview " parameter

2.4.12 - The " game " parameter

2.4.13 - The " phone " parameter

2.5 - Managing errors

2.6 - Associated XML and DTD models

1 - Presentation

1.1 - Presentation of the xmlEngine 0.1

Thanks to its xmlEngine, Mediaplazza is able to allow its partners to access products and services via an xml feed.

The xmlEngine allows you to:

- Search different parameters on all of Mediaplazza's products.

- Browse through the different categories of Mediaplazza's products.

- Receive a list of the most downloaded products.

- Receive a list of the most recent products.

- Receive a list of the phones and brands compatible with a specific product.

- Receive a list of the available methods of payment and prices of each method.

- Receive a list of the available countries and languages.

The engine uses the HTTP protocol.

A list of the products and services available via the xmlEngine is online and updated frequently at the following URL: http://mpxml.mediaplazza.com/docs/xml_engine/supported-products.php

2 - Using the xmlEngine

2.1 - Supported products and services

2.1.1 - List of supported products and services

A list of the products and services available via the xmlEngine is online and updated frequently at the following URL: http://mpxml.mediaplazza.com/docs/xml_engine/supported-products.php

2.1.2 - Unsupported actions (per product)

Certain actions ('CAT', 'SEARCH', etc) aren't supported by all products. A list of supported actions for each product is available and updated frequently at the following URL: http://mpxml.mediaplazza.com/docs/xml_engine/supported-products.php

2.2 - Authentication

2.2.1 - Registration of your account

The access to the xmlEngine is secure and requires an authentication.

To create an account to the xmlEngine, please contact us at dev@mediaplazza.net

2.2.2 - Authentication parameters

Your authentication is processed with two parameters (login and pwd) that are required to access the xmlEngine. These identifiers will be sent to you upon the creation of your account. If you have forgotten your identifiers, please contact us at dev@mediaplazza.net.

2.2.3 - Authentication problems

If a problem occurs during the authentication on the xmlEngine, please contact dev@mediaplazza.net.

2.3 - Actions

Note: Only one action can be processed at a time.

2.3.1 - The CAT action (CATEGORIES)

The CAT action allows you to obtain a list of categories associated with a specific product. For example, the CAT action will allow you to obtain the list of categories associated with polyphonic ringtones.

2.3.2 - The CONT action (CONTENT)

The CONT action allows to browse directly through the different resources for a product. Most of the time, when a CONT action is used, a cat parameter has to be specified according to the category of which you wish to view the different resources.

2.3.3 - The TOP action (Top downloads)

The TOP action is used to access the most popular resources, all categories included.

2.3.4 - The NEWS action (New releases)

The NEWS action is used to access the last recorded resources, all categories included.

2.3.5 - The NEWSON action (Ringtones, in all formats)

The NEWSON action is used to access a specific ringtone, with all formats of that ringtone returned.

2.3.6 - The SEARCH action

The SEARCH action allows you to process queries on different products.

The search action implies the existence of corresponding num_per_page and page parameters in relation to the resources displayed per page and the specific page. Of course, queries are based on a sample corresponding to the q parameter.

2.3.7 - The COMP action (compatibilities)

The COMP action allows you to get the mobile compatible with the specific product.

2.3.8 The COMPBRAND action (brand compatibilities)

The COMPBRAND action allows you to get the mobile brand compatible with the specific product.

2.3.9 The PRODUCT action (product type)

The PRODUCT action allows you to get the all available product types.

2.3.10 The COUNTRY action

The COUNTRY action allows you to get the all available countries.

2.3.11 The PRICES action (prices per method of payment)

The PRICES action allows you to get the all available methods of payment and the price for each method.

2.3.12 The USERAGENT action (specific user information)

The USERAGENT action allows you to get the information about the user: the phone model, type, carrier, id, etc.

2.3.13 The GAMESCONT action (games content)

The GAMESCONT action allows you to browser through the content of the games category.

2.3.14 The GAMESDETAIL action (games detail)

The GAMESDETAIL action allows you to get the details of a specific game by entering a game id in the game parameter.

2.4 - List of parameters

2.4.1 - The " vhost " parameter

The vhost parameter is defined by your sub-domain.

2.4.2 - The " type " parameter

The type parameter defines the type of resource (product) looked for.

A list of the supported type of resources is available and updated frequently at this URL: http://mpxml.mediaplazza.com/docs/xml_engine/supported-products.php

2.4.3 - The " language " parameter

The language parameter determines the language in which you wish to receive a description of the resources.

A list of supported languages is available and updated frequently at this URL: http://mpxml.mediaplazza.com/docs/xml_engine/supported-languages.php

2.4.4 - The " action " parameter

The action parameter defines the action. A list of supported actions is available here:

http://mpxml.mediaplazza.com/docs/xml_engine/supported-actions.php

2.4.5 - The " country " parameter

The country parameter defines the country.

A list of available countries can be found at the following URL: http://mpxml.mediaplazza.com/docs/xml_engine/supported-countries.php

2.4.6 - The " hot " parameter

The hot parameter filters the HOT content. If you set h to 1, you will receive hot content as well as non-hot content. Setting hot to 0 will send only non-hot content.

2.4.7 - The " search " parameter

The search parameter defines the search query used with the SEARCH category.

2.4.8 - The " page " parameter

The page parameter defines the current page you want to receive.

2.4.9 - The " num_per_page " parameter

The num_per_page parameter defines the number of result you want to receive per page.

2.4.10 - The " cat " parameter

The cat parameter defines the specific category you want to display.

2.4.11 - The " preview " parameter

The preview parameter defines the size of the preview for the logo colors and animated logo colors. This parameter can be set to 64x64 or 40x40 (wap display). By Default, this value is set to 64x64.

2.4.12 - The " game " parameter

The game parameter defines the id number for the specific game you want to display.

2.4.13 - The " phone " parameter

The phone parameter defines the id number for the specific phone you, if you wish to only view compatible games for that model phone.

2.5 - Managing errors

A list of the errors can be found at the following URL: http:/mpxml.mediaplazza.com/docs/xml_engine/errors.php

2.6 - Associated XML and DTD models

The DTD model can be found at the following URL: http://mpxml.mediaplazza.com/dtd/default.dtd

Be carefull: The DTD and the XML structure can change without any notification. (ie: some fields can be added to the xml feed)