Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
dev:web_api:v3:start [2014/06/12 22:26] – [Zotero Web API v3] dstillmandev:web_api:v3:start [2022/06/23 22:02] (current) – [API Documentation] dstillman
Line 1: Line 1:
-<html><p style="color:red; font-weight:bold">This is draft documentation. APIv3 is not yet available for use.</p></html> 
- 
 ====== Zotero Web API v3 ====== ====== Zotero Web API v3 ======
  
-This is the recommended API version for all new development. To use this version, you currently must [[basics#api_versioning|specify the version]] in all requests. The current default version of the API is [[:dev/web_api/v1/start|version 1]].+This is the default version of the API, and it is recommended for new development.
 ===== API Documentation ===== ===== API Documentation =====
  
Line 10: Line 8:
   * [[Write Requests]]   * [[Write Requests]]
   * [[file_upload|File Uploads]]   * [[file_upload|File Uploads]]
 +  * [[fulltext_content|Full-Text Content]]
   * [[Syncing]]   * [[Syncing]]
 +  * [[Streaming API]]
   * [[oauth|OAuth Authentication]]   * [[oauth|OAuth Authentication]]
   * [[changes_from_v2|Changes from API Version 2]]   * [[changes_from_v2|Changes from API Version 2]]
  
 +===== Client Libraries =====
 +
 +Known client libraries for the Zotero API  include:
 +
 +  * [[https://github.com/tnajdek/zotero-api-client]] (JavaScript)
 +  * [[https://github.com/urschrei/pyzotero]] (Python)
 +  * [[https://github.com/fcheslack/libZotero]] (PHP and Python)
 +  * [[https://github.com/shazino/SZNZotero]] (Objective-C)
 +  * [[https://github.com/retorquere/zotero-sync]] (TypeScript)
 ===== API Support ===== ===== API Support =====
  
 Please post questions regarding the Zotero API to the [[http://groups.google.com/group/zotero-dev|zotero-dev]] mailing list. Please post questions regarding the Zotero API to the [[http://groups.google.com/group/zotero-dev|zotero-dev]] mailing list.
  
-===== API Implementations ===== 
- 
-Known client libraries for the Zotero API include: 
- 
-  * [[https://github.com/fcheslack/libZotero]] (PHP and Python) 
-  * [[https://github.com/shazino/SZNZotero]] (Objective-C) 
-  * [[https://github.com/urschrei/pyzotero]] (Python) 
-  * [[https://github.com/clioweb/phpZotero]] (PHP, no longer maintained) 
-  * [[https://github.com/scholarpress/scholarpress-workshop]] 
  
-The API‌ forms a fundamental part of several projects, including: 
-  * The online library view at zotero.org, which is built using the same API‌ 
-  * [[http://wordpress.org/extend/plugins/zotpress/|Zotpress]], a WordPress plugin for including citations to items in your Zotero library in blog posts. The plugin makes extensive use of the read API and implements both key-based and OAuth for access control. 
-  * [[http://www.bibliobouts.org/|Biblio Bouts]], an game where participants compete to collect high quality sources online. The game uses the API‌ to see what items participants have saved. 
-  * [[https://github.com/krueschan/phpZoteroWebDAV|phpZoteroWebDAV]], a WebDAV implementation in PHP which allows users to sync their attachments to their own webservers, including an online library and attachment view building off the read API. (AGPL) 
-  * [[https://github.com/jmschanck/Scanner-For-Zotero|Scanner for Zotero]], Android app which saves items to Zotero libraries using the write API (Java, GPL-licensed) 
-  * [[https://github.com/ajlyon/zandy|Zandy]] Android app using the read and write APIs to provide full access to Zotero libraries (Java, AGPL-licensed) 
-  * [[http://www.zotpad.com|ZotPad]] iPad/iPhone app using the read and file upload APIs to provide read access to Zotero libraries and read/write access to attachment files.  Write access is planned. (Objective C, GPL-licensed) 
-  * [[http://www.zoteroreader.com|Zotero Reader]] Browser app that provides read access to Zotero library and read/write access to PDF attachments. (Javascript/PHP) 
-  * [[http://plugins.spip.net/zotspip.html|ZotSpip]], a SPIP plugin to synchronise a Zotero library with SPIP (a content management system). References can be presented in web pages and searched through a dedicated webpage. A complementary plugin (BiblioCheck) allows a research unit to manage corrections to apply to the unit bibliography. (PHP) 
dev/web_api/v3/start.1402626368.txt.gz · Last modified: 2014/06/12 22:26 by dstillman