Getting Started Omeka Classic plugin

Installation

Requirements

  • Omeka Classic 3.1 or later. API Browser is built and tested on 3.2.2.
  • PHP 8.1 or later.
  • The REST API turned on, in Settings > API, for requests to work (the documentation shows either way).

API Browser creates no database tables. Its one setting, the resources the public browser documents, is an Omeka option.

Installing

  1. Unzip ApiBrowser-1.0.0.zip and copy the ApiBrowser folder into your Omeka Classic plugins/ folder.
  2. Log in to the admin as a Super User and go to Settings > Plugins.
  3. Click Install next to API Browser.

API Browser appears in the admin menu for every role that can sign in to the admin: Super Users, Admins, Contributors and Researchers.

If the REST API is off, the browser says so at the top, with a link to Settings > API for Super Users.

Upgrading

Deactivate the plugin, replace the plugins/ApiBrowser folder with the new version, then click Upgrade (or Activate) on the Plugins page.

Uninstalling

Click Uninstall on the Plugins page, then delete the folder. The public resource list is deleted.

Log in for Support