Developer Classes

Description

Developer Classes allow for the management of keys as a group, enabling the ability to block traffic and/or change limits without having to go to each and every key or change the limits on the Service, or API, and affect all developers. For example, you might have a set of developers that are trying out your API and a set of developers who are in production mode, both of which require different limits, e.g. 1000 calls/day for trial developers and 10,000 calls/day for production developers. If you were experiencing unexpected volume from a large number of trial developers and this call volume was impacting the performance of the production developers, you could simply go in and block the calls for the Trial Developers developer class and instantly all of those associated keys would be blocked, i.e. no calls allowed.

NOTE: For a customer who is using Packager and is not in legacy mode, this feature is not enabled. While available to customers in legacy mode, Developer Classes is a deprecated but still support feature. API Packager is the new way for achieving the above use case as well as enabling more sophisticated packaging of your APIs.

Object Fields

id

The id field is the primary identifier for the object.

type	maxLength	format	default	optional	readonly	createonly	queryable	sortable
integer				yes	yes	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

name

Name of the object

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

description

Description of the object

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

rate_limit_override_allowed

Flag to determine if keys associated with the Developer Class can have their individual rate limits changed. "true" equals "allow overrides to occur" and "false" is "do not allow overrides".

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

qps_limit_override_allowed

Flag to determine if keys associated with the Developer Class can have their QPS rate limits changed. "true" equals "allow overrides to occur" and "false" is "do not allow overrides".

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

block_calls

Flag to determine if call traffic should be blocked for keys associated to a given Developer Class. "true" equals "block traffic" and "false" is "accept traffic".

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

object_type

The type of the object.

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

Relationships

Key

A Developer Class has zero or many related Key objects. The associated Keys to a Developer Class cannot be retrieved from the Developer Class object itself. It is a unidirectional relationship in that you can access a Key's Developer Class from the Key object but not the associated Keys from the Developer Class object.

Service Class

A Developer Class has one or many related Service Class objects. The associated Service Classes to a Developer Class can be retrieved from the Developer Class object itself.