The '''AurJson''' interface is a lightweight remote interface for the [[AUR]]. It utilizes http GET queries as the request format, and [http://www.json.org/ json] as the response data exchange format.

−

The AurJson interface is a lightweight remote interface for the AUR. It utilizes [http://www.json.org/ json] as the data exchange format.

+

== API Usage ==

== API Usage ==

−

The interface has two major query types:

+

The [https://aur.archlinux.org/rpc.php RPC interface] has four major query types:

* search

* search

+

* msearch

* info

* info

+

* multiinfo

Each method requires the following HTTP GET syntax:

Each method requires the following HTTP GET syntax:

Line 20:

Line 21:

=== Query Types ===

=== Query Types ===

−

As noted above, there are two query types:

+

As noted above, there are four query types:

* search

* search

+

* msearch

* info

* info

+

* multiinfo

−

==== Search ====

+

==== search ====

−

A '''''search''''' type query takes an argument of a string, or partial string, with which to perform a package search. Possible return types are '''''error''''' and '''''search'''''.

+

A '''''search''''' type query takes an argument of a string with which to perform a package search. Possible return types are '''''error''''' and '''''search'''''.

Example:

Example:

Line 33:

Line 36:

The above is a query of type '''''search''''' and the search argument is "foobar".

The above is a query of type '''''search''''' and the search argument is "foobar".

−

==== Info ====

+

==== msearch ====

+

+

A '''''msearch''''' type query takes an argument of a string with which to perform a search by maintainer name. Possible return types are '''''error''''' and '''''msearch'''''.

+

+

Example:

+

<nowiki>http://aur-url/rpc.php?type=msearch&arg=cactus</nowiki>

+

+

The above is a query of type '''''msearch''''' and the search argument is "cactus".

+

+

==== info ====

An '''''info''''' type query takes an argument of a string '''''or''''' an integer. If an integer, the integer must be an exact match to an existing packageID, or an '''''error''''' type is returned. If a string, the string must be an exact match to an existing packageName, or an '''''error''''' type is returned.

An '''''info''''' type query takes an argument of a string '''''or''''' an integer. If an integer, the integer must be an exact match to an existing packageID, or an '''''error''''' type is returned. If a string, the string must be an exact match to an existing packageName, or an '''''error''''' type is returned.

Line 43:

Line 55:

The two examples above are both queries of type '''''info'''''. The first query is using an integer type argument, and the second is using a packageName argument. If packageID 1123 corresponded to packageName foobar, then both of the above queries would return the details of the foobar package.

The two examples above are both queries of type '''''info'''''. The first query is using an integer type argument, and the second is using a packageName argument. If packageID 1123 corresponded to packageName foobar, then both of the above queries would return the details of the foobar package.

−

=== Return Values ===

+

==== multiinfo ====

−

The return payload is of one format, and currently has three main types.

+

The majority of "real world" info requests come in hefty batches. AUR can handle these in one request rather than

The multiinfo type is the result returned from a multiinfo request operation. '''The actual results of a multiinfo operation will be the same as an info request for each result. See the info section.'''

+

+

Example of ReturnType '''''multiinfo''''':

+

{"type":"multiinfo","results":[{"Name":"pam_abl","ID":1995, ...}]}

=== jsonp ===

=== jsonp ===

−

If you are working with a javascript page, and need a jsonp callback mechanism, you can do it.

+

If you are working with a javascript page, and need a json callback mechanism, you can do it.

−

You just need to provide an additional variable callback. This callback is usually handled via the javascript library, but here is an example.

+

You just need to provide an additional callback variable. This callback is usually handled via the javascript library, but here is an example.

This would automatically call the JavaScript function {{Ic|jsonp1192244621103}} with the parameter set to the results of the RPC call. (In this case, {{Ic|<nowiki>{"type":"error","results":"No results found"}</nowiki>}})

Sometimes things are easier to see by examples. If this is such a case for you, I have created two reference implementations for people to peruse. One in python using [http://pypi.python.org/pypi/simplejson/ simplejson], and one in javascript using [http://jquery.com/ jQuery].

+

Sometimes things are easier to understand with examples. A few reference implementations (jQuery, python, ruby) are available at the following url: https://github.com/cactus/random/tree/master/aurjson_examples

−

Both examples are available in a tarball at the following url:

+

== See also ==

−

http://archlinux.org/~eliott/zomgstuff/rpc_examples.tar.gz

+

* [[Official Repositories Web Interface]]

Revision as of 11:14, 30 October 2013

The AurJson interface is a lightweight remote interface for the AUR. It utilizes http GET queries as the request format, and json as the response data exchange format.

API Usage

Where methodname is the name of an allowed method, and data is the argument to the call.

Data is returned in json encapsulated format.

Query Types

As noted above, there are four query types:

search

msearch

info

multiinfo

search

A search type query takes an argument of a string with which to perform a package search. Possible return types are error and search.

Example:

http://aur-url/rpc.php?type=search&arg=foobar

The above is a query of type search and the search argument is "foobar".

msearch

A msearch type query takes an argument of a string with which to perform a search by maintainer name. Possible return types are error and msearch.

Example:

http://aur-url/rpc.php?type=msearch&arg=cactus

The above is a query of type msearch and the search argument is "cactus".

info

An info type query takes an argument of a string or an integer. If an integer, the integer must be an exact match to an existing packageID, or an error type is returned. If a string, the string must be an exact match to an existing packageName, or an error type is returned.

The two examples above are both queries of type info. The first query is using an integer type argument, and the second is using a packageName argument. If packageID 1123 corresponded to packageName foobar, then both of the above queries would return the details of the foobar package.

multiinfo

The majority of "real world" info requests come in hefty batches. AUR can handle these in one request rather than
multiple by allowing AUR clients to send multiple arguments.

multiinfo

The multiinfo type is the result returned from a multiinfo request operation. The actual results of a multiinfo operation will be the same as an info request for each result. See the info section.

Example of ReturnType multiinfo:

{"type":"multiinfo","results":[{"Name":"pam_abl","ID":1995, ...}]}

jsonp

If you are working with a javascript page, and need a json callback mechanism, you can do it.
You just need to provide an additional callback variable. This callback is usually handled via the javascript library, but here is an example.