API Objects

The Mashery API allows access to a set of objects describing and controlling the Mashery product.  These objects are represented as JSON objects.  The API provides methods for manipulating these objects.

Mashery Object Types

Each domain object returned by the Mashery API will include an object_type field.  The object_type field indicates the kind of object returned.

The supported object types are

member

A Member object stores contact information for api key owners and allows developer portal access.

application

An Application is the name of the client system that a developer is building that consumes either Packages or Services.

key

A Key tracks access to your Service.

package_key

A Package Key tracks access to your Package.

package

A group of Plans.

plan

A specific set of rules that define access to Services.

service

A Service object describes a proxy service.  It also contains one or more Endpoints.

role

A Role groups members and controls access to portal features and content

Each object type also forms a namespace for calling methods related to that object.

Object Relationships

Here is an overview of how the basic Mashery API objects are related when using Packages as the primary means for distributing APIs to your developers.

Here is an overview of how the basic Mashery API objects are related when not using Packages as the primary means for distributing APIs to your developers.