Packages

Description

A package object stores data for limit-based notifications, e.g. sending an email to a developer when they near their quota usage, as well as an array of plans. Packages are a collection of plans which in turn are a collection of services, endpoints and methods that ultimately can be used by a developer.

NOTE:This object is available when API Packager is turned on for a customer. Please contact Support or your Account Manager if you have any questions about API Packager.

Object Fields

id

The id field is the primary identifier for the object.

type	maxLength	format	default	optional	readonly	createonly	queryable	sortable
integer				no	yes	no	yes	no

name

Name of the object

type	maxLength	format	default	optional	readonly	createonly	queryable	sortable
string	255			no	no	no	yes	no

description

Description of the object

type	maxLength	format	default	optional	readonly	createonly	queryable	sortable
string				yes	no	no	yes	no

notify_developer_period

This field configures the Traffic Manager to send out notifications on an hourly, daily, weekly, or monthly basis.

type	maxLength	format	default	optional	readonly	createonly	queryable	sortable
string	8			no	no	no	yes	no

notify_developer_near_quota

If enabled, the Traffic Manager will send the developer an email when the call count for the developer is within the range, as determined by near_quota_threshold, of his or her quota.

type	maxLength	format	default	optional	readonly	createonly	queryable	sortable
boolean				no	no	no	yes	no

notify_developer_over_quota

This field configures the Traffic Manager to send out notifications when the total number of calls made by a developer exceeds the quota limit.

type	maxLength	format	default	optional	readonly	createonly	queryable	sortable
boolean				no	no	no	yes	no

notify_developer_over_throttle

This field configures the Traffic Manager to send out notifications when the total number of calls per second have been exceeded by the developer.

type	maxLength	format	default	optional	readonly	createonly	queryable	sortable
boolean				no	no	no	yes	no

notify_admin_period

This field configures the Traffic Manager to send out notifications on an hourly, daily, weekly, or monthly basis

type	maxLength	format	default	optional	readonly	createonly	queryable	sortable
string	8			no	no	no	yes	no

notify_admin_near_quota

This field configures the Traffic Manager to send out notifications when the total number of calls made by a developer exceeds a set percentage of the quota limit. For example, entering "90" in this field indicates that a notification will be sent out when the total number of calls made by a developer exceeds 90% of the total allowable calls within the rate limit.

type	maxLength	format	default	optional	readonly	createonly	queryable	sortable
boolean				no	no	no	yes	no

notify_admin_over_quota

If enabled, the Traffic Manager will send the administrator an email when the call count for the developer is within the range, as determined by near_quota_threshold, of his or her quota.

type	maxLength	format	default	optional	readonly	createonly	queryable	sortable
boolean				no	no	no	yes	no

notify_admin_over_throttle

If enabled, the Traffic Manager will send the administrator an email when the call count for the developer is within the range, as determined by near_quota_threshold, of his or her quota.

type	maxLength	format	default	optional	readonly	createonly	queryable	sortable
boolean				no	no	no	yes	no

notify_admin_emails

Comma-delimited list of email addresses used for when sending notifications to admins

type	maxLength	format	default	optional	readonly	createonly	queryable	sortable
string				yes	no	no	yes	no

near_quota_threshold

type	maxLength	format	default	optional	readonly	createonly	queryable	sortable
integer				no	no	no	yes	no

created

The date that this object was created.

type	maxLength	format	default	optional	readonly	createonly	queryable	sortable
string	20	date-time		yes	yes	no	yes	no

updated

The date this object was last updated.

type	maxLength	format	default	optional	readonly	createonly	queryable	sortable
string	20	date-time		yes	yes	no	yes	no

key_adapter

This field is populated whenever a custom algorithm is required for generating a key. During the client's implementation phase, a Mashery Engineer will write this custom algorithm per the client's requirements. This algorithm will be written as a PHP class file. The name of this file will then be listed in the Key Management Adapter field. The system will then use this file to generate the custom key. If no custom algorithm is required, then this field will be set to 0. NOTE: This field should only be changed by a Mashery engineer. Please consult Mashery engineering before making any changes.

type	maxLength	format	default	optional	readonly	createonly	queryable	sortable
string	256			yes	no	no	yes	no

key_length

This field defines the number of characters that Mashery's own key-generation algorithm will use to generate keys for an API service. The default setting is 24.

type	maxLength	format	default	optional	readonly	createonly	queryable	sortable
integer				yes	no	no	yes	no

shared_secret_length

This field defines the number of characters that Mashery's own algorithm will use to generate a shared secret for a key. This shared secret is effectively a password that only the developer will know. This shared secret can be used in a digital signature for more secure authentication of an API call. If a shared secret is not required, then this field will be set to 0.

type	maxLength	format	default	optional	readonly	createonly	queryable	sortable
integer				yes	no	no	yes	no

is_using_shared_secret

Set to "true" if the Plan requires a shared secret when developers make API calls.

type	maxLength	format	default	optional	readonly	createonly	queryable	sortable
boolean				yes	yes	no	no	no

object_type

The type of the object.

type	maxLength	format	default	optional	readonly	createonly	queryable	sortable
string	32			yes	yes	no	no	no

test

null

type	maxLength	format	default	optional	readonly	createonly	queryable	sortable
string	10			yes	no	no	no	no

Relationships

Plan

A Package has one or many related Plan objects. The related Plan objects can be accessed directly via the object.query API method by including this relationship in the query, e.g. select *, plan from packages.

Object Methods

The package namespace contains the following methods for manipulating services.

package.create

Create a package. .

package.clone

Accept a package specification and clone that package.

package.fetch

Get a specific package or a list of packages .

package.validate

Validate a package .

package.delete

Delete a package .

package.update

Update a package .

version 5 as of 11 years ago by Jeremy Pollock