mozilla

Compare Revisions

The generic AMO API

Change Revisions

Revision 49528:

Revision 49528 by Sheppy on

Revision 49529:

Revision 49529 by Sheppy on

Title:
The generic AMO API
The generic AMO API
Slug:
addons.mozilla.org_(AMO)_API_Developers'_Guide/The_generic_AMO_API
addons.mozilla.org_(AMO)_API_Developers'_Guide/The_generic_AMO_API
Tags:
Add-ons, "AMO API", AMO
Add-ons, "AMO API", AMO
Content:

Revision 49528
Revision 49529
nn70    <p>
71      Returns add-ons that match a specified search term. This us
 >es the same search engine as the rest of the site, so only exact 
 >matches are supported. The returned <code>searchresults</code> el
 >ement has up to 10 <code>addon</code> elements describing each in
 >dividual search result.
72    </p>
73    <h4>
74      Prototype
75    </h4>
76    <p>
77      <code><span class="nowiki">https://services.<span id="12513
 >16501779S" style="display: none;">&nbsp;</span>addons.mozilla.org
 >/api/[version]/search/[searchterm]/[optional:searchtype]/[optiona
 >l:maxresults]/[optional:search_os /[optional:search_version]</spa
 >n></code>
78    </p>
79    <h4>
80      Parameters
81    </h4>
n72        Prototypen84        searchterm
73      </dt>
74      <dd>
75        <span class="nowiki">https://services.addons.mozilla.org/
>api/[version]/search/[searchterm]/[optional:searchtype]/[optional 
>:maxresults]/[optional:search_os /[optional:search_version]</span 
>> 
76      </dd>
77      <dt>85      </dt>
78        Purpose
79      </dt>86      <dd>
87        The term to match.
80      <dd>88      </dd>
81        Returns add-ons that match the <code>[searchterm]</code>.89      <dt>
>&nbsp; Uses the same search engine as the rest of the site, so on 
>ly exact match is supported.&nbsp; The searchtype may be one of ' 
>extension', 'theme', 'plugin', 'dictionary', 'searchengine'.&nbsp 
>; If no searchtype is entered extensions and themes will be retur 
>ned. Note that a maximum of 10 search results will be returned.&n 
>bsp; The total number of matching results is specified in the <co 
>de>total_results</code> attribute of the searchresults element. F 
>or example: 
90        searchtype
91      </dt>
92      <dd>
93        The type of results to return. The default, <code>all</co
 >de>, requests that only matching extensions and themes be conside
 >red. You may also specify <code>extension</code>, <code>theme</co
 >de>, <code>plugin</code>, <code>dictionary</code>, or <code>searc
 >hengine</code>.
94      </dd>
95      <dt>
96        maxresults
97      </dt>
98      <dd>
99        The maximum number of results to return. This is pegged t
 >o no more than 10; specifying a larger number will still return n
 >o more than 10 results. The total number of available results wil
 >l be returned in the <code>total_results</code> attribute of the 
 ><code>searchresults</code> element. For example:
n88      <dd>n
89        Within the <code>searchresults</code> element there are u
>p to 10 addon elements, with the same structure as for the addon  
>method. 
90      </dd>
91      <dt>
92        Parameters
93      </dt>106      <dt>
94      <dd>
95        <dl>
96          <dt>
97            searchterm
98          </dt>
99          <dd>
100            Term to match
101          </dd>
102          <dt>
103            searchtype
104          </dt>
105          <dd>
106            Return results of this type.&nbsp; The default is 'al
>l'.&nbsp; Possible values are 'all' (which is actually 'extension 
>' plus 'theme', and not actually all types), 'extension', 'theme' 
>, 'plugin', 'dictionary', or 'searchengine'. 
107          </dd>
108          <dt>
109            maxresults
110          </dt>
111          <dd>
112            Maximum number of results to return.&nbsp; Regardless
> of what is specified, a hard maximum of 10 results will be retur 
>ned.&nbsp; If you specify a smaller number, less results will be  
>returned. 
113          </dd>
114          <dt>
115            search_os107        search_os
116          </dt>
117          <dd>
118            Return results that match the specified operating sys
>tem.&nbsp; Default is 'all'.&nbsp; Possible values are 'all', 'wi 
>nnt', 'darwin', 'linux' 
119          </dd>
120          <dt>
121            search_version
122          </dt>
123          <dd>
124            Return results that match the specified application v
>ersion. 
125          </dd>
126        </dl>
127      </dd>
128      <dt>108      </dt>
129        Example invocations
130      </dt>109      <dd>
110        Specifies the operating system for which to return result
 >s; only add-ons compatible with the specified operating system wi
 >ll be returned. The default value is <code>all</code>; other poss
 >ible values are <code>winnt</code>, <code>darwin</code>, and <cod
 >e>linux</code>.
131      <dd>111      </dd>
132        <span class="nowiki">https://services.addons.mozilla.org/112      <dt>
>en-US/firefox/api/1.3/search/popup</span><br> 
133        Search for add-ons matching "popup"<br>113        search_version
134        <br>114      </dt>
135        <span class="nowiki">https://services.addons.mozilla.org/115      <dd>
>en-US/firefox/api/1.3/search/nasa/theme</span><br> 
136        Search for themes matching "nasa"<br>116        Specifies the application version with which the returned
 > add-ons must be compatible.
137        <br>
138        <span class="nowiki">https://services.addons.mozilla.org/
>en-US/firefox/api/1.3/search/blue/all/10/WINNT/3</span><br> 
139        Search for add-ons that match "blue" of any type, return 
>a maximum of 10 results, for add-ons that will work on Windows Fi 
>refox version 3. 
tt128    <h4>
129      Examples
130    </h4>
131    <pre>
132<span class="plain">https://services.addons.mozilla.org/en-US/fir
 >efox/api/1.3/search/popup</span>
133</pre>
134    <p>
135      Searches for add-ons matching "popup".
136    </p>
137    <pre>
138<span class="plain">https://services.addons.mozilla.org/en-US/fir
 >efox/api/1.3/search/nasa/theme</span>
139</pre>
140    <p>
141      Searches for themes matching "nasa".
142    </p>
143    <pre>
144<span class="plain">https://services.addons.mozilla.org/en-US/fir
 >efox/api/1.3/search/blue/all/10/WINNT/3</span>
145</pre>
146    <p>
147      Searches for add-ons of any type that match "blue", returni
 >ng no more than 10 results. Only add-ons that are compatible with
 > the Windows version of Firefox 3 are considered.
148    </p>

Back to History