Link Search Menu Expand Document

REST API

Traduttore adds new routes to both the WordPress REST API as well as the API provided by GlotPress.

API Endpoints

/traduttore/v1/incoming-webhook

Methods:

  • POST

Traduttore can be set up to listen to incoming webhooks from GitHub. This way, translations can be updated every time you push changes to your GitHub repository.

Check out the Getting Started guide to learn how to set up webhooks.

Example:

https://<home_url>/wp-json/traduttore/v1/incoming-webhook

/github-webhook/v1/push-event

Methods:

  • POST

This deprecated REST API route works the same way as /traduttore/v1/incoming-webhook, except only for GitHub repositories. For backward compatibility reasons it has not been removed.

Users are encouraged to use the /traduttore/v1/incoming-webhook route for webhooks for all of the providers.

Example:

https://<home_url>/wp-json/github-webhook/v1/push-event

/api/translations/<project>

Methods:

  • GET

This API route is used to distribute all the available language packs for a given project. This way, a WordPress site can be configured to download translations for a specific plugin via the API.

Example:

Fetching https://<home_url>/api/translations/my-project would result in a response like this:

{
  "translations": [
    {
      "language": "de_DE",
      "version": "1.0",
      "updated": false,
      "english_name": "German",
      "native_name": "Deutsch",
      "package": "https://<home_url>/content/traduttore/my-project-de_DE.zip",
      "iso": [
        "de"
      ]
    }
  ]
}