Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision |
dev:web_api:v3:basics [2017/11/12 19:53] – external edit 127.0.0.1 | dev:web_api:v3:basics [2019/02/05 03:43] – [Resources] dstillman |
---|
<html><p id="zotero-5-update-warning" style="color: red; font-weight: bold">We’re | |
in the process of updating the documentation for | |
<a href="https://www.zotero.org/blog/zotero-5-0">Zotero 5.0</a>. Some documentation | |
may be outdated in the meantime. Thanks for your understanding.</p></html> | |
| |
| |
====== Zotero Web API Documentation ====== | ====== Zotero Web API Documentation ====== |
| |
- As an HTTP header in the form ''Zotero-API-Key: P9NiFoyLeZu2bZNvvuQPDWsd'' \\ | - As an HTTP header in the form ''Zotero-API-Key: P9NiFoyLeZu2bZNvvuQPDWsd'' \\ |
- As an HTTP header in the form ''Authorization: Bearer P9NiFoyLeZu2bZNvvuQPDWsd''\\ | - As an HTTP header in the form ''Authorization: Bearer P9NiFoyLeZu2bZNvvuQPDWsd''\\ |
- As a URL query parameter, in the form ''key=P9NiFoyLeZu2bZNvvuQPDWsd'' | - As a URL query parameter, in the form ''key=P9NiFoyLeZu2bZNvvuQPDWsd'' (not recommended) |
| |
Use of an HTTP header is recommended, as it allows use of URLs returned from the API (e.g., for pagination) without modification. | Use of an HTTP header is recommended, as it allows use of URLs returned from the API (e.g., for pagination) without modification. |
==== User and Group Library URLs ==== | ==== User and Group Library URLs ==== |
| |
Requests for data in a specific library begin with ''/users/<userID>'' or ''/groups/<groupID>''. User IDs are different from usernames and can be found on the [[/settings/keys|API Keys]] page and in OAuth responses. | Requests for data in a specific library begin with ''/users/<userID>'' or ''/groups/<groupID>'', referred to below as ''<userOrGroupPrefix>''. User IDs are different from usernames and can be found on the [[/settings/keys|API Keys]] page and in OAuth responses. |
| |
^ URI ^ Description ^ | ^ URI ^ Description ^ |
^ Parameter ^ Values ^ Default ^ Description ^ | ^ Parameter ^ Values ^ Default ^ Description ^ |
| ''style'' | string | ''chicago-note-bibliography'' | Citation style to use for formatted references. Can be either the file name (without the .csl extension) of one of the styles in the [[https://www.zotero.org/styles/|Zotero Style Repository]] (e.g., ''apa'') or the URL of a remote CSL file. | | | ''style'' | string | ''chicago-note-bibliography'' | Citation style to use for formatted references. Can be either the file name (without the .csl extension) of one of the styles in the [[https://www.zotero.org/styles/|Zotero Style Repository]] (e.g., ''apa'') or the URL of a remote CSL file. | |
| | ''locale'' | string | ''en-US'' | Bibliography locale. See the [[https://github.com/citation-style-language/locales|available CSL locales]]. Note that some styles use a fixed locale and cannot be localized. | |
| |
| |