Update:Remora API Docs: Difference between revisions

no edit summary
No edit summary
No edit summary
Line 14: Line 14:
API calls are served via
API calls are served via


  http://services.addons.mozilla.org/api
  https://services.addons.mozilla.org/api


You may localize the returned content by adding a locale string to this URL as follows:
You may localize the returned content by adding a locale string to this URL as follows:
  http://services.addons.mozilla.org/[locale]/api
  https://services.addons.mozilla.org/[locale]/api
for example
for example
  http://services.addons.mozilla.org/en-US/api
  https://services.addons.mozilla.org/en-US/api
  http://services.addons.mozilla.org/de/api
  https://services.addons.mozilla.org/de/api


=== Available Methods ===
=== Available Methods ===
==== addon ====
==== addon ====
Invoke as:
Invoke as:
http://services.addons.mozilla.org/api/addon/[id]
https://services.addons.mozilla.org/api/addon/[id]
Returns details of an addon
Returns details of an addon


==== search  ====
==== search  ====
Invoke as:
Invoke as:
http://services.addons.mozilla.org/api/search/[searchterm]/[optional:searchtype]
https://services.addons.mozilla.org/api/search/[searchterm]/[optional:searchtype]


Returns addons that match the searchterm.  Uses the same search engine as  
Returns addons that match the searchterm.  Uses the same search engine as  
Line 39: Line 39:
==== list ====
==== list ====
Invoke as:
Invoke as:
http://services.addons.mozilla.org/api/list/[optional:listtype]/[optional:addontype]/[optional:number]
https://services.addons.mozilla.org/api/list/[optional:listtype]/[optional:addontype]/[optional:number]


Returns a [randomized] list of addons.
Returns a [randomized] list of addons.
Line 48: Line 48:
==== cumulative_downloads ====
==== cumulative_downloads ====
Invoke as:
Invoke as:
http://services.addons.mozilla.org/api/cumulative_downloads/[id]
https://services.addons.mozilla.org/api/cumulative_downloads/[id]


Retrieves cumulative downloads for the specified addon.
Retrieves cumulative downloads for the specified addon.
Line 54: Line 54:
==== update_pings ====
==== update_pings ====
Invoke as:
Invoke as:
http://services.addons.mozilla.org/api/update_pings/[id]/[optional:period]/[optional:querydate]
https://services.addons.mozilla.org/api/update_pings/[id]/[optional:period]/[optional:querydate]


Returns update pings for the specified addon.
Returns update pings for the specified addon.
Period may be 'day', 'week', or 'month' and defaults to 'day'.
Period may be 'day', 'week', or 'month' and defaults to 'day'.
Querydate will be the last date in the period you wish to query.  Default is today.  Date format is YYYY-MM-DD.  Invalid dates will default to today.
Querydate will be the last date in the period you wish to query.  Default is today.  Date format is YYYY-MM-DD.  Invalid dates will default to today.
1,071

edits