Module: Zotero

Defined in:

lib/zotero.rb,
lib/zotero/error.rb,
lib/zotero/client.rb,
lib/zotero/fields.rb,
lib/zotero/library.rb,
lib/zotero/syncing.rb,
lib/zotero/version.rb,
lib/zotero/fulltext.rb,
lib/zotero/item_types.rb,
lib/zotero/file_upload.rb,
lib/zotero/http_config.rb,
lib/zotero/http_errors.rb,
lib/zotero/network_errors.rb,
lib/zotero/http_connection.rb,
lib/zotero/file_attachments.rb

Overview

Ruby client library for the Zotero Web API v3.

Provides a comprehensive interface for interacting with Zotero libraries, including full CRUD operations for items, collections, tags, searches, file uploads, and synchronization.

Examples:

Basic usage

client = Zotero.new(api_key: 'your-api-key')
library = client.user_library(12345)
items = library.items

See Also:

• Zotero Web API v3 Documentation

Defined Under Namespace

Modules: Fields, FileAttachments, FileUpload, Fulltext, HTTPErrors, ItemTypes, NetworkErrors, Syncing Classes: AuthenticationError, BadRequestError, Client, ConflictError, Error, HTTPConfig, HTTPConnection, Library, NotFoundError, PreconditionFailedError, PreconditionRequiredError, RateLimitError, ServerError

Constant Summary

VERSION =

"0.1.5"

Class Method Summary

• .new(api_key:) ⇒ Client

  Create a new Zotero API client.

Class Method Details

.new(api_key:) ⇒ Client

Create a new Zotero API client.

Parameters:

• api_key (String) —

  Your Zotero API key

Returns:

• (Client) —

  A new Zotero client instance

# File 'lib/zotero.rb', line 25

def self.new(api_key:)
  Client.new(api_key: api_key)
end