Difference between revisions of "Aurweb RPC interface"

From ArchWiki
Jump to: navigation, search
m (formatting)
(Use extended form of Wikipedia external link)
 
(57 intermediate revisions by 18 users not shown)
Line 1: Line 1:
[[Category: Package management (English)]]
+
[[Category:Package management]]
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.
+
[[Category:Arch projects]]
 +
[[ja:AurJson]]
 +
[[pt:Aurweb RPC interface]]
 +
{{Related articles start}}
 +
{{Related|Official repositories web interface}}
 +
{{Related articles end}}
 +
The [https://aur.archlinux.org/rpc.php Aurweb RPC interface] is a lightweight [[Wikipedia:Remote procedure call|RPC]] interface for the [[AUR]]. Queries are send as HTTP GET requests and the server responds with [http://www.json.org/ JSON].
 +
{{Note|This article describes v5 of the RPC Interface API, as updated with AUR v4.7.0 on July 7, 2018.}}
  
== API Usage ==
+
== API usage ==
  
The interface has two major query types:
+
=== Query types ===
 +
 
 +
There are two query types:  
  
 
* search
 
* search
 
* info
 
* info
  
Each method requires the following HTTP GET syntax:
+
==== search ====
  
type=methodname&arg=data
+
Package searches can be performed by issuing requests of the form:
  
Where '''''methodname''''' is the name of an allowed method, and '''''data''''' is the argument to the call.
+
/rpc/?v=5&type=search&by=''field''&arg=''keywords''
  
Data is returned in json encapsulated format.
+
where {{ic|''keywords''}} is the search argument and {{ic|''field''}} is one of the following values:
  
=== Query Types ===
+
* {{ic|name}} (search by package name only)
 +
* {{ic|name-desc}} (search by package name and description)
 +
* {{ic|maintainer}} (search by package maintainer)
 +
* {{ic|depends}} (search for packages that depend on keywords)
 +
* {{ic|makedepends}} (search for packages that makedepend on keywords)
 +
* {{ic|optdepends}} (search for packages that optdepend on keywords)
 +
* {{ic|checkdepends}} (search for packages that checkdepend on keywords)
  
As noted above, there are two query types:
+
The {{ic|by}} parameter can be skipped and defaults to {{ic|name-desc}}.
* search
+
Possible return types are {{ic|search}} and {{ic|error}}.
* info
+
 
* msearch
+
If a maintainer search is performed and the search argument is left empty, a list of orphan packages is returned.
 +
 
 +
Examples:
  
==== Search ====
+
Search for {{ic|foobar}}:
 +
<nowiki>https://aur.archlinux.org/rpc/?v=5&type=search&arg=foobar</nowiki>
  
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'''''.
+
Search for packages maintained by {{ic|john}}:
 +
<nowiki>https://aur.archlinux.org/rpc/?v=5&type=search&by=maintainer&arg=john</nowiki>
  
Example:
+
Search for packages that have {{ic|foobar}} as `makedepends`:
  <nowiki>http://aur-url/rpc.php?type=search&arg=foobar</nowiki>
+
  <nowiki>https://aur.archlinux.org/rpc/?v=5&type=search&by=makedepends&arg=foobar</nowiki>
  
The above is a query of type '''''search''''' and the search argument is "foobar".
+
Search with callback:
 +
<nowiki>https://aur.archlinux.org/rpc/?v=5&type=search&arg=foobar&callback=jsonp1192244621103</nowiki>
  
==== Info ====
+
==== 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.
+
Package information can be performed by issuing requests of the form:
  
Examples:
+
  /rpc/?v=5&type=info&arg[]=''pkg1''&arg[]=''pkg2''&…
  <nowiki>http://aur-url/rpc.php?type=info&arg=1123</nowiki>
 
<nowiki>http://aur-url/rpc.php?type=info&arg=foobar</nowiki>
 
  
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.
+
where {{ic|''pkg1''}}, {{ic|''pkg2''}}, … are the exact matches of names of packages to retrieve package details for.
  
==== msearch ====
+
Possible return types are {{ic|multiinfo}} and {{ic|error}}.
  
A '''''msearch''''' type query takes an argument of a string, or partial string, with which to perform a search by maintainer name. Possible return types are '''''error''''' and '''''msearch'''''.
+
Examples:
  
Example:
+
Info for single {{ic|foobar}} package:
  <nowiki>http://aur-url/rpc.php?type=msearch&arg=cactus</nowiki>
+
  <nowiki>https://aur.archlinux.org/rpc/?v=5&type=info&arg[]=foobar</nowiki>
  
The above is a query of type '''''msearch''''' and the search argument is "cactus".
+
Info for multiple {{ic|foobar}} and {{ic|bar}} packages:
 +
<nowiki>https://aur.archlinux.org/rpc/?v=5&type=info&arg[]=foo&arg[]=bar</nowiki>
  
=== Return Types ===
+
=== Return types ===
  
The return payload is of one format, and currently has three main types.
+
The return payload is of one format, and currently has three main types. The response will always return a type so that the user can determine if the result of an operation was an error or not.
  
 
The format of the return payload is:
 
The format of the return payload is:
  {"type":ReturnType,"results":ReturnData}
+
  {"version":5,"type":''ReturnType'',"resultcount":0,"results":''ReturnData''}
 +
 
 +
{{ic|''ReturnType''}} is a string, and the value is one of:
  
ReturnType is a string, and the value is one of:
+
* {{ic|search}}
* error
+
* {{ic|multiinfo}}
* search
+
* {{ic|error}}
* info
 
  
The type of ReturnData is dependent on the query type:
+
The type of {{ic|''ReturnData''}} is an array of dictionary objects for the {{ic|search}} and {{ic|multiinfo}} {{ic|''ReturnType''}}, and an empty array for {{ic|error}} {{ic|''ReturnType''}}.
* If ReturnType is '''''error''''' then ReturnData is a string.
 
* If ReturnType is '''''search''''' then ReturnData is an array of dictionary objects.
 
* If ReturnType is '''''info''''' then ReturnData is a single dictionary object.
 
  
==== Error ====
+
==== error ====
The error type has an error response string as the return value. An error response can be returned from either a '''''search''''' or an '''''info''''' query type.
+
The error type has an error response string as the return value. An error response can be returned from either a {{ic|search}} or an {{ic|info}} query type.
  
Example of ReturnType '''''error''''':
+
Example of {{ic|''ReturnType''}} {{ic|error}}:
  {"type":"error","results":"No results found"}
+
  {"version":5,"type":"error","resultcount":0,"results":[],"error":"Incorrect by field specified."}
  
==== Search ====
+
==== search ====
The search type is the result returned from a search request operation. Returning the type as search is useful for detecting whether the response to a search operation is search data or an error.
+
The search type is the result returned from a search request operation. '''The actual results of a search operation will be the same as an info request for each result. See the info section.'''
  
Example of ReturnType '''''search''''':
+
Example of {{ic|''ReturnType''}} {{ic|search}}:
  {"type":"search","results":[{"Name":"pam_abl","ID":"1995"}]}
+
  {"version":5,"type":"search","resultcount":2,"results":[{"ID":206807,"Name":"cower-git", ...}]}
  
==== Info ====
+
==== info ====
The info type is the result returned from an info request operation. Returning the type as search is useful for detecting whether the response to a search operation is search data or an error.
+
The info type is the result returned from an info request operation.
  
Example of ReturnType '''''info''''':
+
Example of {{ic|''ReturnType''}} {{ic|multiinfo}}:
 
  <nowiki>
 
  <nowiki>
 
  {
 
  {
     "type": "info",
+
    "version":5,
     "results": {
+
     "type":"multiinfo",
         "Description": "Provides auto blacklisting of hosts and users responsible for repeated failed authentication attempts",  
+
    "resultcount":1,
         "ID": "1995",  
+
     "results":[{
         "License": "",  
+
         "ID":229417,
         "Name": "pam_abl",  
+
         "Name":"cower",
         "NumVotes": "4",  
+
         "PackageBaseID":44921,
         "OutOfDate": "0",  
+
         "PackageBase":"cower",
         "URL": "http://www.hexten.net/pam_abl",
+
         "Version":"14-2",
         "URLPath": "/packages/pam_abl/pam_abl.tar.gz",  
+
         "Description":"A simple AUR agent with a pretentious name",
         "Version": "0.2.3-1"
+
         "URL":"http:\/\/github.com\/falconindy\/cower",
     }
+
        "NumVotes":590,
 +
        "Popularity":24.595536,
 +
        "OutOfDate":null,
 +
        "Maintainer":"falconindy",
 +
        "FirstSubmitted":1293676237,
 +
        "LastModified":1441804093,
 +
         "URLPath":"\/cgit\/aur.git\/snapshot\/cower.tar.gz",
 +
         "Depends":[
 +
            "curl",
 +
            "openssl",
 +
            "pacman",
 +
            "yajl"
 +
        ],
 +
        "MakeDepends":[
 +
            "perl"
 +
        ],
 +
        "License":[
 +
            "MIT"
 +
        ],
 +
        "Keywords":[]
 +
     }]
 
  }
 
  }
 
  </nowiki>
 
  </nowiki>
Line 108: Line 145:
  
 
Example Query:
 
Example Query:
  <nowiki>http://aur-url/rpc.php?type=search&arg=foobar&callback=jsonp1192244621103</nowiki>
+
  <nowiki>https://aur.archlinux.org/rpc/?v=5&type=search&arg=foobar&callback=jsonp1192244621103</nowiki>
  
 
Example Result:
 
Example Result:
  jsonp1192244621103({"type":"error","results":"No results found"})
+
  /**/jsonp1192244621103({"version":5,"type":"search","resultcount":1,"results":[{"ID":250608,"Name":"foobar2000","PackageBaseID":37068,"PackageBase":"foobar2000","Version":"1.3.9-1","Description":"An advanced freeware audio player (uses Wine).","URL":"http:\/\/www.foobar2000.org\/","NumVotes":39,"Popularity":0.425966,"OutOfDate":null,"Maintainer":"supermario","FirstSubmitted":1273255356,"LastModified":1448326415,"URLPath":"\/cgit\/aur.git\/snapshot\/foobar2000.tar.gz"}]})
  
This would automatically call the JavaScript function <tt>jsonp1192244621103</tt> with the parameter set to the results of the RPC call. (In this case, <tt><nowiki>{"type":"error","results":"No results found"}</nowiki></tt>)
+
This would automatically call the JavaScript function {{Ic|jsonp1192244621103}} with the parameter set to the results of the RPC call.
  
== More Examples ==
+
== Limitations ==
  
Example Query and Result:
+
* HTTP GET requests are limited to URI of 8190 bytes maximum length. However, the official AUR instance running on a nginx server with HTTP/2 uses the [https://nginx.org/en/docs/http/ngx_http_v2_module.html#http2_max_field_size default URI maximum length] limit of 4443 bytes. Info requests with more than about 200 packages as argument will need to be split.
<nowiki>
+
* The API rate is limited to a maximum of 4000 requests per day per IP.
http://aur-url/rpc.php?type=search&arg=foobar
 
{"type":"error","results":"No results found"}
 
</nowiki>
 
  
Example Query and Result:
+
== Reference clients ==
<nowiki>
 
http://aur-url/rpc.php?type=search&arg=pam_abl
 
{"type":"search","results":[{"Name":"pam_abl","ID":"1995"}]}
 
</nowiki>
 
 
 
Example Query and Result:
 
<nowiki>
 
http://aur-url/rpc.php?type=info&arg=pam_abl
 
{
 
    "type": "info",
 
    "results": {     
 
        "Description": "Provides auto blacklisting of hosts and users responsible for repeated failed authentication attempts",
 
        "ID": "1995",
 
        "License": "",
 
        "Name": "pam_abl",
 
        "NumVotes": "4",
 
        "OutOfDate": "0",
 
        "URL": "http://www.hexten.net/pam_abl",
 
        "URLPath": "/packages/pam_abl/pam_abl.tar.gz",
 
        "Version": "0.2.3-1"
 
    }
 
}
 
</nowiki>
 
  
== Reference Clients ==
+
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/2b72a1723bfc8ae64eed6a3c40cb154accae3974/aurjson_examples
  
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].
+
== Associated code ==
  
Both examples are available at the following url: https://github.com/cactus/random/tree/master/aurjson_examples
+
* {{AUR|python3-aur}}: Python modules for interacting with the remote AUR RPC interface, among other AUR services. See [http://xyne.archlinux.ca/projects/python3-aur/ python3-aur] for details.
 +
* {{AUR|python-aur}}: Python modules for interacting with the remote AUR RPC interface (RPCv1).

Latest revision as of 20:53, 15 July 2018

The Aurweb RPC interface is a lightweight RPC interface for the AUR. Queries are send as HTTP GET requests and the server responds with JSON.

Note: This article describes v5 of the RPC Interface API, as updated with AUR v4.7.0 on July 7, 2018.

API usage

Query types

There are two query types:

  • search
  • info

search

Package searches can be performed by issuing requests of the form:

/rpc/?v=5&type=search&by=field&arg=keywords

where keywords is the search argument and field is one of the following values:

  • name (search by package name only)
  • name-desc (search by package name and description)
  • maintainer (search by package maintainer)
  • depends (search for packages that depend on keywords)
  • makedepends (search for packages that makedepend on keywords)
  • optdepends (search for packages that optdepend on keywords)
  • checkdepends (search for packages that checkdepend on keywords)

The by parameter can be skipped and defaults to name-desc. Possible return types are search and error.

If a maintainer search is performed and the search argument is left empty, a list of orphan packages is returned.

Examples:

Search for foobar:

https://aur.archlinux.org/rpc/?v=5&type=search&arg=foobar

Search for packages maintained by john:

https://aur.archlinux.org/rpc/?v=5&type=search&by=maintainer&arg=john

Search for packages that have foobar as `makedepends`:

https://aur.archlinux.org/rpc/?v=5&type=search&by=makedepends&arg=foobar

Search with callback:

https://aur.archlinux.org/rpc/?v=5&type=search&arg=foobar&callback=jsonp1192244621103

info

Package information can be performed by issuing requests of the form:

/rpc/?v=5&type=info&arg[]=pkg1&arg[]=pkg2&…

where pkg1, pkg2, … are the exact matches of names of packages to retrieve package details for.

Possible return types are multiinfo and error.

Examples:

Info for single foobar package:

https://aur.archlinux.org/rpc/?v=5&type=info&arg[]=foobar

Info for multiple foobar and bar packages:

https://aur.archlinux.org/rpc/?v=5&type=info&arg[]=foo&arg[]=bar

Return types

The return payload is of one format, and currently has three main types. The response will always return a type so that the user can determine if the result of an operation was an error or not.

The format of the return payload is:

{"version":5,"type":ReturnType,"resultcount":0,"results":ReturnData}

ReturnType is a string, and the value is one of:

  • search
  • multiinfo
  • error

The type of ReturnData is an array of dictionary objects for the search and multiinfo ReturnType, and an empty array for error ReturnType.

error

The error type has an error response string as the return value. An error response can be returned from either a search or an info query type.

Example of ReturnType error:

{"version":5,"type":"error","resultcount":0,"results":[],"error":"Incorrect by field specified."}

search

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

Example of ReturnType search:

{"version":5,"type":"search","resultcount":2,"results":[{"ID":206807,"Name":"cower-git", ...}]}

info

The info type is the result returned from an info request operation.

Example of ReturnType multiinfo:

 {
    "version":5,
    "type":"multiinfo",
    "resultcount":1,
    "results":[{
        "ID":229417,
        "Name":"cower",
        "PackageBaseID":44921,
        "PackageBase":"cower",
        "Version":"14-2",
        "Description":"A simple AUR agent with a pretentious name",
        "URL":"http:\/\/github.com\/falconindy\/cower",
        "NumVotes":590,
        "Popularity":24.595536,
        "OutOfDate":null,
        "Maintainer":"falconindy",
        "FirstSubmitted":1293676237,
        "LastModified":1441804093,
        "URLPath":"\/cgit\/aur.git\/snapshot\/cower.tar.gz",
        "Depends":[
            "curl",
            "openssl",
            "pacman",
            "yajl"
        ],
        "MakeDepends":[
            "perl"
        ],
        "License":[
            "MIT"
        ],
        "Keywords":[]
    }]
 }
 

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.

Example Query:

https://aur.archlinux.org/rpc/?v=5&type=search&arg=foobar&callback=jsonp1192244621103

Example Result:

/**/jsonp1192244621103({"version":5,"type":"search","resultcount":1,"results":[{"ID":250608,"Name":"foobar2000","PackageBaseID":37068,"PackageBase":"foobar2000","Version":"1.3.9-1","Description":"An advanced freeware audio player (uses Wine).","URL":"http:\/\/www.foobar2000.org\/","NumVotes":39,"Popularity":0.425966,"OutOfDate":null,"Maintainer":"supermario","FirstSubmitted":1273255356,"LastModified":1448326415,"URLPath":"\/cgit\/aur.git\/snapshot\/foobar2000.tar.gz"}]})

This would automatically call the JavaScript function jsonp1192244621103 with the parameter set to the results of the RPC call.

Limitations

  • HTTP GET requests are limited to URI of 8190 bytes maximum length. However, the official AUR instance running on a nginx server with HTTP/2 uses the default URI maximum length limit of 4443 bytes. Info requests with more than about 200 packages as argument will need to be split.
  • The API rate is limited to a maximum of 4000 requests per day per IP.

Reference clients

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/2b72a1723bfc8ae64eed6a3c40cb154accae3974/aurjson_examples

Associated code

  • python3-aurAUR: Python modules for interacting with the remote AUR RPC interface, among other AUR services. See python3-aur for details.
  • python-aurAUR: Python modules for interacting with the remote AUR RPC interface (RPCv1).