http://learn.agilezen.com/ 2010-09-09T06:27:12+00:00 http://learn.agilezen.com/ http://learn.agilezen.com/lib/images/favicon.ico text/html 2009-07-30T03:08:21+00:00 http://learn.agilezen.com/api/concepts/enrichments?rev=1248923301&do=diff Just like the application itself, the Zen API is designed to be as flexible as possible. By default, a GET request will return only a short summary of information about a resource. You can customize the information that is sent back by using enrichments. Enrichments work on both entity and container resources -- when used on container resources, the enrichments are applied to all entities within the container. text/html 2009-07-31T21:37:28+00:00 http://learn.agilezen.com/api/concepts/filters?rev=1249076248&do=diff Responses describing container resources can be customized by specifying one or more filters in the URI. Filters are defined by supplying where arguments, which are key/value pairs as follows: where=blocked:true To negate the value of a property (the equivalent of a NOT): text/html 2009-08-02T18:09:14+00:00 http://learn.agilezen.com/api/concepts/formatting?rev=1249236554&do=diff The Zen API can communicate in two wire formats, XML and JSON. The format for input and output is controlled via the use of HTTP headers, specifically Content-Type and Accept. To refer to the formats, you use their MIME types: Format MIME type XML application/xml JSON application/json If you don't specify a wire format, Zen will speak XML by default. text/html 2009-07-31T03:42:49+00:00 http://learn.agilezen.com/api/concepts/overview?rev=1249011769&do=diff The Zen API is designed around a concept called REST. In a RESTful system, information is organized into resources, each of which is uniquely identified via a URI. Different resources support different actions, which are specified by using HTTP verbs. text/html 2009-07-30T14:48:58+00:00 http://learn.agilezen.com/api/concepts/pagination?rev=1248965338&do=diff When you make a request to a container resource, Zen will reply with a paginated response. Default Responses Roughly, a paginated response takes this form, where ENTITY is the type of resource you are accessing: <?xml version="1.0" encoding="utf-8"?> <ENTITIES> <page>1</page> <pageSize>10</pageSize> <totalPages>1</totalPages> <totalItems>1</totalItems> <items> <ENTITY>...</ENTITY> <ENTITY>...</ENTITY> ...additional entities... </items> </ENTITIES> text/html 2009-08-03T13:41:15+00:00 http://learn.agilezen.com/api/concepts/security?rev=1249306875&do=diff API Keys Zen uses API keys to associate requests with the users that are making them. API keys are identified by a token, which is just a unique series of letters and numbers. Anyone can create an API key via the Developer tab on the Settings screen, and you can have as many keys as you like. Keys can be enabled and disabled as necessary, and all requests using a given key will be denied while the key is disabled.