GlotCore REST API is a WordPress plugin that extends GlotPress by exposing a REST API for programmatic access to translation data. It enables developers to integrate GlotPress with external systems, automate localization workflows, and build custom applications on top of the GlotPress platform.

The plugin follows WordPress REST API conventions and introduces a versioned API namespace to ensure clarity and future evolution.

Purpose and Scope

GlotCore REST API extends GlotPress by providing a versioned, RESTful interface for both retrieving and managing translation-related data programmatically. The plugin enables external systems and custom applications to interact with GlotPress using standard HTTP methods, without relying on internal or UI-bound APIs.

Unlike read-only integrations, GlotCore REST API exposes endpoints that support full lifecycle operations on selected resources, including:

• Creating, updating, and deleting projects
• Managing translation sets and translations
• Creating and maintaining glossaries and glossary entries
• Managing project permissions
• Accessing user profile information

This makes it possible to treat GlotPress as a headless translation platform, suitable for automation, synchronization, and integration scenarios.

Typical use cases include:

• Automating project and translation set provisioning
• Integrating GlotPress with CI/CD and localization pipelines
• Synchronizing translation data with external services
• Building custom administrative interfaces or dashboards
• Managing glossaries and terminology programmatically
• Extending GlotPress behavior using stable, public endpoints

Experimental Status

GlotCore REST API is currently in an experimental phase.

• The API is functional but still evolving
• Endpoints and response formats may change
• Versions between 0.1 and 1.0 do not guarantee backward compatibility

The plugin is intended for developers who are comfortable working with evolving APIs and providing feedback.

API Overview

All endpoints are available under the versioned namespace:

/gp/v0.1

The API provides both read and write access (where applicable) to core GlotPress resources, enabling full programmatic interaction with translation data and configuration.

Available Endpoints

Base

• /gp/v0.1
  Base endpoint providing API availability and metadata.

Formats

• /gp/v0.1/formats
  Retrieve available file formats.

Glossaries

• /gp/v0.1/glossaries
  Retrieve and create glossaries.
• /gp/v0.1/glossaries/{id}
  Retrieve, update, or delete a specific glossary.
• /gp/v0.1/glossaries/{id}/entries
  Retrieve and create glossary entries.
• /gp/v0.1/glossaries/{id}/entries/{entry_id}
  Retrieve, update, or delete a specific glossary entry.

Languages

• /gp/v0.1/languages
  Retrieve available languages.

Originals

• /gp/v0.1/originals
  Retrieve original strings.
• /gp/v0.1/originals/{id}
  Retrieve or delete a specific original string.

Projects

• /gp/v0.1/projects
  Retrieve and create projects.
• /gp/v0.1/projects/{id}
  Retrieve, update, or delete a specific project.
• /gp/v0.1/projects/{id}/permissions
  Retrieve and create project permissions.
• /gp/v0.1/projects/{id}/permissions/{permission_id}
  Retrieve or delete a specific project permission.

Translations

• /gp/v0.1/translations
  Retrieve and create translations.
• /gp/v0.1/translations/{id}
  Retrieve, update, or delete a specific translation.

Translation Sets

• /gp/v0.1/translation-sets
  Retrieve and create translation sets.
• /gp/v0.1/translation-sets/{id}
  Retrieve, update, or delete a specific translation set.

User Profiles

• /gp/v0.1/profile/me
  Retrieve the authenticated user profile.
• /gp/v0.1/profile/{id}
  Retrieve a specific user profile.

Authentication

Some endpoints require authentication.

For development and testing, the recommended approach is to use the WordPress Application Passwords with Basic Authentication.

This allows secure access without additional plugins or custom authentication layers.

Tooling and Exploration

To simplify API exploration and testing:

• A Postman collection is included
• A Postman environment file is provided
• Endpoints can be tested immediately after installation

This makes it easy to inspect responses, understand available fields, and prototype integrations.

Configuration

No additional configuration is required.

After installing and activating the plugin, the REST API endpoints become available automatically.

Intended Audience

GlotCore REST API is designed primarily for:

• WordPress and GlotPress developers
• Plugin and integration authors
• Teams building automation around translation workflows
• Organizations using GlotPress as part of a larger localization system

Future Direction

Version 0.1 establishes the foundation for a public GlotPress REST API. Future iterations may expand endpoint coverage, and work toward long-term API stability.