API Documentation

Glossary

API key
API keys
An API key is a token you need to provide in order to access the Metro Publisher API. The owner of a Metro Publisher instance can create an API key and supply it to the developer(s) of an application that wants to access the Metro Publisher instance's data (such as articles, section information, etc.). See QuickStart to learn how API keys are created and used.
article
articles
See content type.
Bearer Token
Bearer Tokens
A specific type of token handed out with an OAuth 2 workflow. http://tools.ietf.org/html/draft-ietf-oauth-v2-bearer
blog
A blog is a collection of content objects, i.e. articles or reviews.
blogentry
blogentries

Attention

As of Metro Publisher 2.8, "blogentries" are no longer a separate content type. They are either articles or reviews associated with a blog instead of a section.

See content type.

CDN
Content Delivery Network
content type
content types
content object
content objects

Content types in the context of Metro Publisher is one of the following:

  • article
  • blogentry (deprecated as a separate content type as of Metro Publisher 2.8)
  • event
  • review_album
  • review_book
  • review_location
  • review_product
  • video (deprecated as a separate content type as of Metro Publisher 2.9)

All of the above content types have a number of attributes in common, such as title, description, and content.

Articles are the most basic content type. All other content types are based on them, but have additional attributes specific to their type.

Articles and reviews can be associated with either a section or a blog. Articles and reviews may indirectly be associated with a section if their assigned blog resides in a section.

Directory Add-On
This Add-On enables the directory for the particular Metro Publisher instance. A directory is a collection of locations, and the individual locations may have additional properties.
event
events
See content type.
GeoNames

GeoNames is a database for geographical names, such as cities and countries.

Metro Publisher uses GeoName IDs for location addresses, specifically the location's city.

For example, Willemstad is the capital city of Curaçao and has the GeoName ID 3513090. A location with an address in Willemstad therefore has the geoname_id 3513090.

HTML-XML
Content-XML

There several fields in Metro Publisher objects that allow XML-compliant HTML. However, there are restrictions on the tags allowed in the XML. The field is validated using RelaxNG with the schema files shown in RelaxNG Schema for XML-compliant HTML.

The content field of content objects allows an additional tag:

<slot id="{UUID}" />

This tag is used to add inline media to the content.

http accept
HTTP Specification

The specification for the HTTP Protocol.

issued
Some objects in Metro Publisher have an 'issued' date/time. Any published item will only appear on the public site on and after the 'issued' date/time.
JSON

JSON (JavaScript Object Notation) is the standard data format for the Metro Publisher API. It is a lightweight text-based open standard for human-readable data exchange.

location
locations
A location is an object with geo information, i.e. latitude and longitude. A location can be assigned to an event or a review.
mailing list

A place where users of the Vanguardistas API can get together and help each other or exchange ideas. https://groups.google.com/forum/?hl=en&fromgroups#!forum/metro-publisher-api

The mailing list is both public and moderated.

Media
Media Slot
Media Slots
Slot
Slots
As of Metro Publisher 2.12, content objects may have several lists of media attached to them. Each list of media is contained in a slot. See Content Media and the respective API resources.
Metro Publisher instance id

A Metro Publisher instance id ({iid} in a resource url) is the numerical id of a Metro Publisher instance, e.g. 123.

See Accessing the API to read where the instance id can be found in the Metro Publisher Service Dashboard.

The instance id is also returned in the response to the authentication token request.

MIME type
MIME types
MP
Metro Publisher

Metro Publisher is Cloud Computing / Software as a Service (SaaS). It comes with a suite of tools to help any media company, regardless of its size, build a credible website and online business.

OAuth 2

A specification for authorization. See

permission
permissions
The permissions of a role define what access the API key allows.
plist
Property list
pypi
The Python Package Index is a repository of software for the Python programming language. http://pypi.python.org/pypi
python
The Python programming language. http://python.org/
REST
Representational State Transfer
An architecture style for Web APIs. http://en.wikipedia.org/wiki/Representational_state_transfer
review
reviews
review_album
review_book
review_location
review_product
See content type.
role

A role is a collection of permissions.

A Metro Publisher API key is associated with a role. The role (via its permissions) defines what parts of the API can be accessed with the API key (see API Roles).

roundup_location
See content type.
section
sections
The navigational parts of an MP instance are called sections.
Service Dashboard

The Metro Publisher Service Dashboard is the place where purchase of the service (:term`Metro Publisher`) is set up and managed. Only the main account owner who initiated the service can log into the Service Dashboard. Users can upgrade or downgrade plan, change payment options, view all paid and unpaid invoices, add new or discontinue subscriptions, and manage API users and API keys.

tag predicate
tag predicates

Tag predicates describe the relationship between a tag and an object that is tagged with the tag.

The current tag predicates are:

  • for articles, reviews, roundups, and events:
    • authored
      • the tag is the author of the content object
    • describes
      • the tag is describes something within the content object
    • edited
      • the tag is the editor of the content object
  • for reviews:
    • is_brand_of_reviewed (album, book, product)
      • the tag is the brand of the object being reviewed, e.g. the company producing a product
    • is_type_of_reviewed (album, book, product)
      • the tag is the type of the object being reviewed, e.g. the genre of a book
    • created_reviewed (album, book)
      • the tag is the creator of the object being reviewed, e.g. the publisher of a book
    • illustrated_reviewed (book)
      • the tag is the illustrator of the object being reviewed, e.g. the illustrator of a book
    • translated_reviewed (book)
      • the tag is the translator of the object being reviewed, e.g. the translator of a book
  • for files:
    • describes
      • the tag is describes the file, e.g. something shown in an image
    • photographed
      • the tag is the photographer of an image
    • illustrated
      • the tag is the illustrator of an image, e.g. if the image depicts a comic strip

Table of tag predicates

topics page
topics pages
Topics pages are automatically generated pages that aggregate and display all articles, blog posts, reviews, events, and images that contain the same tag.
urlname
Most objects in Metro Publisher have a 'urlname', i.e. an identifier which is used for constructing the url of the object. Depending on the type of object, the urlname must be unique to the MP instance or unique inside a section/subpart of the MP instance. The urlname must not start with either '@' nor '+' and must not contain a '/'.
uuid
uuids
UUID stands for universally unique identifier. See http://en.wikipedia.org/wiki/UUID.
video
videos

Attention

As of Metro Publisher 2.9, "videos" are no longer a separate content type. They are either articles or reviews with the video information in the media slots.

See content type.

Previous topic

Metro Publisher Facets