Full API Specification
Notes: The following api specification was lifted directly from the code comments.
Any options that are grayed out like this are planned but
have not yet been implemented. Clicking on an examples icon ( )
will take you to an example on the examples page that uses that option.
Taken directly from the code comments:
/**
* Main entry point for MLA review syndication.
* Uses cached templates. Provides a speed increase by not requiring
* database access in some (cached) cases.
Preliminary spec for parameter list:
Product ID (one of the following is required):
mms_pid=nnnn // where nnnn is the product id used by Murphy's
mla_pid=nnnn // where nnnn is the pid used in the MLA database
mla_sku=nnnn // where nnnn is the sku identifier used by MLA
Product info (one or more of the following required OR product ID):
title=xxxx // where xxxx is the url encode product title
author=xxxx // where xxxx is the url encode product author
// Note: When using product info the item with the
// closest match will be returned. Please
// check to be sure this is what you want.
Premium (optional):
p=0 // free service (default)
p=1 // premium service
// your server's ip address is used to verify
Styles (optional):
darkbg=0 // colors for sites with light backgrounds (default)
darkbg=1 // uses graphics and white text for dark backgrounds
cssclass=0 // do not include css class attributes (default)
cssclass=1 // include css class attributes (eg. <td class="MLA_TD">)
Content (optional):
content=brief // brief content - no review text (default)
content=full // full content - reviews, rating, links
Diagnostic (optional):
diag=checkip // Display client's server ip address in output.
// May be helpful for clients to discover their ip
// address for use in setting up premium service.
Notes:
The "cssclass" parameter allows the user to control the content
style by either defining CSS attributes for the basic elements (a,
td, h2, etc.) OR by defining CSS classes for the reviews section
(MLA_A, MLA_TD, MLA_H2, etc.) in their style sheet, depending on
how they use CSS at their site.
The "content" parameter allows the specification of a "brief"
mode which does not print the full individual reviews, instead
providing a link to them. This might be particularly useful if
the client site has pages with multiple products shown in list.
Other template or style options would be possible but it
might be more efficient to start producing some output to see
what we might really need before we pre-define too many more
options of this kind.
*/
|
 |
