Weblates REST-API#

Die API ist unter der URL /api/ erreichbar und basiert auf dem Django-REST-Framework. Sie können sie direkt oder über den Weblate-Client verwenden.

Authentifizierung und allgemeine Parameter#

Die öffentliche Projekt-API ist ohne Authentifizierung verfügbar, allerdings werden nicht authentifizierte Anfragen stark gedrosselt (standardmäßig auf 100 Anfragen pro Tag), so dass eine Authentifizierung empfohlen wird. Für die Authentifizierung wird ein Token verwendet, das Sie in Ihrem Profil erhalten können. Verwenden Sie es in der Authorization-Kopfzeile:

ANY /#

Das allgemeine Anfrageverhalten für die API, die Header, Statuscodes und Parameter hier gelten für alle Endpunkte gleichermaßen.

Abfrageparameter:

  • format – Antwortformat (hat Vorrang vor Accept). Mögliche Werte hängen von der Einrichtung des REST-Frameworks ab, standardmäßig werden json und api unterstützt. Letzteres bietet eine Webbrowser-Schnittstelle für die API.

  • page – Gibt eine Seite mit paginierten Ergebnissen zurück (verwenden Sie die Felder next und previous in der Antwort, um die Navigation zu automatisieren).

Anfrage-Header:

  • Accept – der Inhaltstyp der Antwort hängt vom Accept-Header ab

  • Authorization – optionales Token zur Authentifizierung als Authorization: Token YOUR-TOKEN

Antwort-Header:

  • Content-Type – dies hängt vom Accept-Header der Anfrage ab

  • Allow – aufgelistete zulässige HTTP-Methoden für das Objekt

JSON-Objekt-Antwort:

  • detail (string) – ausführliche Beschreibung des Ergebnisses (für andere HTTP-Statuscodes als 200 OK)

  • count (int) – gesamte Anzahl der Elemente für Objektlisten

  • next (string) – URL der nächsten Seite für Objektlisten

  • previous (string) – URL der vorherigen Seite für Objektlisten

  • results (array) – Ergebnisse für Objektlisten

  • url (string) – URL für den Zugriff auf diese Ressource über die API

  • web_url (string) – URL für den Zugriff auf diese Ressource mit einem Webbrowser

Statuscodes:

Authentifizierungstoken#

Geändert in Version 4.10: Projektspezifische Token wurden in der Version 4.10 eingeführt.

Jeder Benutzer hat ein persönliches Zugangstoken, das im Benutzerprofil abgerufen werden kann. Neu generierte Benutzertoken haben das Präfix wlu_.

Es ist möglich, projektspezifische Token für den API-Zugang nur für ein bestimmtes Projekt zu erstellen. Diese Token können durch das Präfix wlp_ identifiziert werden.

Beispiele für die Authentifizierung#

Beispielanfrage:

GET /api/ HTTP/1.1
Host: example.com
Accept: application/json, text/javascript
Authorization: Token YOUR-TOKEN

Beispielantwort:

HTTP/1.0 200 OK
Date: Fri, 25 Mar 2016 09:46:12 GMT
Server: WSGIServer/0.1 Python/2.7.11+
Vary: Accept, Accept-Language, Cookie
X-Frame-Options: SAMEORIGIN
Content-Type: application/json
Content-Language: en
Allow: GET, HEAD, OPTIONS

{
    "projects":"http://example.com/api/projects/",
    "components":"http://example.com/api/components/",
    "translations":"http://example.com/api/translations/",
    "languages":"http://example.com/api/languages/"
}

CURL-Beispiel:

curl \
    -H "Authorization: Token TOKEN" \
    https://example.com/api/

Beispiele für die Parameterübergabe#

Bei der POST-Methode können die Parameter entweder als Formularübermittlung (application/x-www-form-urlencoded) oder als JSON (application/json) angegeben werden.

Formular-Anfrage-Beispiel:

POST /api/projects/hello/repository/ HTTP/1.1
Host: example.com
Accept: application/json
Content-Type: application/x-www-form-urlencoded
Authorization: Token TOKEN

operation=pull

JSON-Anfrage-Beispiel:

POST /api/projects/hello/repository/ HTTP/1.1
Host: example.com
Accept: application/json
Content-Type: application/json
Authorization: Token TOKEN
Content-Length: 20

{"operation":"pull"}

CURL-Beispiel:

curl \
    -d operation=pull \
    -H "Authorization: Token TOKEN" \
    http://example.com/api/components/hello/weblate/repository/

CURL-JSON-Beispiel:

curl \
    --data-binary '{"operation":"pull"}' \
    -H "Content-Type: application/json" \
    -H "Authorization: Token TOKEN" \
    http://example.com/api/components/hello/weblate/repository/

Komponenten und Kategorien#

Um auf eine Komponente zuzugreifen, die in einer Kategorie verschachtelt ist, müssen Sie den Kategorienamen in einen URL-kodierten und durch einen Schrägstrich getrennten Komponentennamen ändern. Zum Beispiel usage in einer docs Kategorie muss als docs%252Fusage verwendet werden. Die vollständige URL wäre in diesem Fall zum Beispiel https://example.com/api/components/hello/docs%252Fusage/repository/.

API-Ratenbegrenzung#

Die Anzahl der API-Anfragen ist begrenzt; die Standardkonfiguration beschränkt sie auf 100 Anfragen pro Tag für anonyme Benutzer und 5000 Anfragen pro Stunde für authentifizierte Benutzer.

Die Ratenbegrenzung kann in settings.py eingestellt werden; siehe Drosselung in Django REST-Framework Dokumentation für weitere Details zur Konfiguration.

Im Docker-Container kann dies mit WEBLATE_API_RATELIMIT_ANON und WEBLATE_API_RATELIMIT_USER konfiguriert werden.

Der Status der Ratenbegrenzung wird in den folgenden Kopfzeilen gemeldet:

X-RateLimit-Limit

Limit der Anzahl der auszuführenden Anfragen

X-RateLimit-Remaining

Verbleibendes Limit für Anfragen

X-RateLimit-Reset

Anzahl der Sekunden bis zum Zurücksetzen des Ratenbegrenzungsfensters

Geändert in Version 4.1: Statuskopfzeilen für die Ratenbegrenzung hinzugefügt.

Siehe auch

Ratenbegrenzung, Ratenbegrenzung, WEBLATE_API_RATELIMIT_ANON, WEBLATE_API_RATELIMIT_USER

API-Einstiegspunkt#

GET /api/#

Der API-Root-Einstiegspunkt.

Beispielanfrage:

GET /api/ HTTP/1.1
Host: example.com
Accept: application/json, text/javascript
Authorization: Token YOUR-TOKEN

Beispielantwort:

HTTP/1.0 200 OK
Date: Fri, 25 Mar 2016 09:46:12 GMT
Server: WSGIServer/0.1 Python/2.7.11+
Vary: Accept, Accept-Language, Cookie
X-Frame-Options: SAMEORIGIN
Content-Type: application/json
Content-Language: en
Allow: GET, HEAD, OPTIONS

{
    "projects":"http://example.com/api/projects/",
    "components":"http://example.com/api/components/",
    "translations":"http://example.com/api/translations/",
    "languages":"http://example.com/api/languages/"
}

Benutzer#

Neu in Version 4.0.

GET /api/users/#

Gibt eine Liste der Benutzer zurück, wenn Sie die Berechtigung haben, Benutzer zu verwalten. Wenn nicht, sehen Sie nur Ihre eigenen Details.

Siehe auch

Die Objektattribute von Benutzern sind unter GET /api/users/(str:username)/ dokumentiert.

POST /api/users/#

Erstellt einen neuen Benutzer.

Parameter:

  • username (string) – Benutzername

  • full_name (string) – Vollständiger Name des Benutzers

  • email (string) – E-Mail-Adresse des Benutzers

  • is_superuser (boolean) – Ist der Benutzer Superuser? (Optional)

  • is_active (boolean) – Ist der Benutzer aktiv? (Optional)

  • is_bot (boolean) – Ist der Benutzer ein Bot? (Optional) (wird für projektspezifische Token verwendet)

GET /api/users/(str: username)/#

Gibt Informationen über Benutzer zurück.

Parameter:

  • username (string) – Name des Benutzers

JSON-Objekt-Antwort:

  • username (string) – Benutzername eines Benutzers

  • full_name (string) – Vollständiger Name eines Benutzers

  • email (string) – E-Mail-Adresse eines Benutzers

  • is_superuser (boolean) – Ob der Benutzer ein Superuser ist

  • is_active (boolean) – Ob der Benutzer aktiv ist

  • is_bot (boolean) – Ob der Benutzer ein Bot ist (wird für projektspezifische Token verwendet)

  • date_joined (string) – Datum der Erstellung des Benutzers

  • last_login (string) – Datum der letzten Anmeldung des Benutzers

  • groups (array) – Link zu den zugeordneten Gruppen; siehe GET /api/groups/(int:id)/

JSON-Daten-Beispiel:

{
    "email": "user@example.com",
    "full_name": "Example User",
    "username": "exampleusername",
    "groups": [
        "http://example.com/api/groups/2/",
        "http://example.com/api/groups/3/"
    ],
    "is_superuser": true,
    "is_active": true,
    "is_bot": false,
    "date_joined": "2020-03-29T18:42:42.617681Z",
    "url": "http://example.com/api/users/exampleusername/",
    "statistics_url": "http://example.com/api/users/exampleusername/statistics/"
}
PUT /api/users/(str: username)/#

Ändert die Benutzerparameter.

Parameter:

  • username (string) – Name des Benutzers

JSON-Objekt-Antwort:

  • username (string) – Benutzername eines Benutzers

  • full_name (string) – Vollständiger Name eines Benutzers

  • email (string) – E-Mail-Adresse eines Benutzers

  • is_superuser (boolean) – Ob der Benutzer ein Superuser ist

  • is_active (boolean) – Ob der Benutzer aktiv ist

  • is_bot (boolean) – Ob der Benutzer ein Bot ist (wird für projektspezifische Token verwendet)

  • date_joined (string) – Datum der Erstellung des Benutzers

PATCH /api/users/(str: username)/#

Ändert die Benutzerparameter.

Parameter:

  • username (string) – Name des Benutzers

JSON-Objekt-Antwort:

  • username (string) – Benutzername eines Benutzers

  • full_name (string) – Vollständiger Name eines Benutzers

  • email (string) – E-Mail-Adresse eines Benutzers

  • is_superuser (boolean) – Ob der Benutzer ein Superuser ist

  • is_active (boolean) – Ob der Benutzer aktiv ist

  • is_bot (boolean) – Ob der Benutzer ein Bot ist (wird für projektspezifische Token verwendet)

  • date_joined (string) – Datum der Erstellung des Benutzers

DELETE /api/users/(str: username)/#

Löscht alle Benutzerinformationen und markiert den Benutzer als inaktiv.

Parameter:

  • username (string) – Name des Benutzers

POST /api/users/(str: username)/groups/#

Ordnet Gruppen einem Benutzer zu.

Parameter:

  • username (string) – Name des Benutzers

Formularparameter:

  • string group_id – Die eindeutige Gruppen-ID

DELETE /api/users/(str: username)/groups/#

Neu in Version 4.13.1.

Entfernt Benutzer aus einer Gruppe.

Parameter:

  • username (string) – Name des Benutzers

Formularparameter:

  • string group_id – Die eindeutige Gruppen-ID

GET /api/users/(str: username)/statistics/#

Listet die Statistik eines Benutzers auf.

Parameter:

  • username (string) – Name des Benutzers

JSON-Objekt-Antwort:

  • translated (int) – Anzahl der Übersetzungen des Benutzers

  • suggested (int) – Anzahl der Vorschläge des Benutzers

  • uploaded (int) – Anzahl der Uploads des Benutzers

  • commented (int) – Anzahl der Kommentare des Benutzers

  • languages (int) – Anzahl der Sprachen, die der Benutzer übersetzen kann

GET /api/users/(str: username)/notifications/#

Listet die Abonnements eines Benutzers auf.

Parameter:

  • username (string) – Name des Benutzers

POST /api/users/(str: username)/notifications/#

Ordnet Abonnements einem Benutzer zu.

Parameter:

  • username (string) – Name des Benutzers

JSON-Objekt-Anfrage:

  • notification (string) – Name der registrierten Benachrichtigung

  • scope (int) – Umfang der Benachrichtigung aus den verfügbaren Auswahlmöglichkeiten

  • frequency (int) – Auswahl der Häufigkeit von Benachrichtigungen

GET /api/users/(str: username)/notifications/(int: subscription_id)/#

Ruft das einem Benutzer zugeordnete Abonnement ab.

Parameter:

  • username (string) – Name des Benutzers

  • subscription_id (int) – ID der registrierten Benachrichtigung

PUT /api/users/(str: username)/notifications/(int: subscription_id)/#

Bearbeitet das einem Benutzer zugeordnete Abonnement.

Parameter:

  • username (string) – Name des Benutzers

  • subscription_id (int) – ID der registrierten Benachrichtigung

JSON-Objekt-Anfrage:

  • notification (string) – Name der registrierten Benachrichtigung

  • scope (int) – Umfang der Benachrichtigung aus den verfügbaren Auswahlmöglichkeiten

  • frequency (int) – Auswahl der Häufigkeit von Benachrichtigungen

PATCH /api/users/(str: username)/notifications/(int: subscription_id)/#

Bearbeitet das einem Benutzer zugeordnete Abonnement.

Parameter:

  • username (string) – Name des Benutzers

  • subscription_id (int) – ID der registrierten Benachrichtigung

JSON-Objekt-Anfrage:

  • notification (string) – Name der registrierten Benachrichtigung

  • scope (int) – Umfang der Benachrichtigung aus den verfügbaren Auswahlmöglichkeiten

  • frequency (int) – Auswahl der Häufigkeit von Benachrichtigungen

DELETE /api/users/(str: username)/notifications/(int: subscription_id)/#

Löscht das einem Benutzer zugeordnete Abonnement.

Parameter:

  • username (string) – Name des Benutzers

  • subscription_id – Name der registrierten Benachrichtigung

  • subscription_id – Int

Gruppen#

Neu in Version 4.0.

GET /api/groups/#

Gibt eine Liste der Gruppen zurück, wenn Sie die Berechtigung haben, Gruppen zu verwalten. Wenn nicht, sehen Sie nur die Gruppen, denen der Benutzer angehört.

Siehe auch

Die Objektattribute von Gruppen sind unter GET /api/groups/(int:id)/ dokumentiert.

POST /api/groups/#

Erstellt eine neue Gruppe.

Parameter:
GET /api/groups/(int: id)/#

Gibt Informationen über die Gruppe zurück.

Parameter:

  • id (int) – ID der Gruppe

JSON-Objekt-Antwort:

JSON-Daten-Beispiel:

{
    "name": "Guests",
    "defining_project": null,
    "project_selection": 3,
    "language_selection": 1,
    "url": "http://example.com/api/groups/1/",
    "roles": [
        "http://example.com/api/roles/1/",
        "http://example.com/api/roles/2/"
    ],
    "languages": [
        "http://example.com/api/languages/en/",
        "http://example.com/api/languages/cs/",
    ],
    "projects": [
        "http://example.com/api/projects/demo1/",
        "http://example.com/api/projects/demo/"
    ],
    "componentlist": "http://example.com/api/component-lists/new/",
    "components": [
        "http://example.com/api/components/demo/weblate/"
    ]
}
PUT /api/groups/(int: id)/#

Ändert die Gruppenparameter.

Parameter:

  • id (int) – ID der Gruppe

JSON-Objekt-Antwort:

  • name (string) – Name einer Gruppe

  • project_selection (int) – Ganzzahl, entsprechend einer Gruppe von Projekten

  • language_selection (int) – Ganzzahl, entsprechend einer Gruppe von Sprachen

PATCH /api/groups/(int: id)/#

Ändert die Gruppenparameter.

Parameter:

  • id (int) – ID der Gruppe

JSON-Objekt-Antwort:

  • name (string) – Name einer Gruppe

  • project_selection (int) – Ganzzahl, entsprechend einer Gruppe von Projekten

  • language_selection (int) – Ganzzahl, entsprechend einer Gruppe von Sprachen

DELETE /api/groups/(int: id)/#

Löscht die Gruppe.

Parameter:

  • id (int) – ID der Gruppe

POST /api/groups/(int: id)/roles/#

Ordnet Rollen einer Gruppe zu.

Parameter:

  • id (int) – ID der Gruppe

Formularparameter:

  • string role_id – Die eindeutige Rollen-ID

POST /api/groups/(int: id)/components/#

Ordnet Komponenten einer Gruppe zu.

Parameter:

  • id (int) – ID der Gruppe

Formularparameter:

  • string component_id – Die eindeutige Komponenten-ID

DELETE /api/groups/(int: id)/components/(int: component_id)#

Löscht die Komponente aus einer Gruppe.

Parameter:

  • id (int) – ID der Gruppe

  • component_id (int) – Die eindeutige Komponenten-ID

POST /api/groups/(int: id)/projects/#

Ordnet Projekte einer Gruppe zu.

Parameter:

  • id (int) – ID der Gruppe

Formularparameter:

  • string project_id – Die eindeutige Projekt-ID

DELETE /api/groups/(int: id)/projects/(int: project_id)#

Löscht das Projekt aus einer Gruppe.

Parameter:

  • id (int) – ID der Gruppe

  • project_id (int) – Die eindeutige Projekt-ID

POST /api/groups/(int: id)/languages/#

Ordnet Sprachen einer Gruppe zu.

Parameter:

  • id (int) – ID der Gruppe

Formularparameter:

  • string language_code – Der eindeutige Sprachcode

DELETE /api/groups/(int: id)/languages/(string: language_code)#

Löscht die Sprache aus einer Gruppe.

Parameter:

  • id (int) – ID der Gruppe

  • language_code (string) – Der eindeutige Sprachcode

POST /api/groups/(int: id)/componentlists/#

Ordnet Komponentenlisten einer Gruppe zu.

Parameter:

  • id (int) – ID der Gruppe

Formularparameter:

  • string component_list_id – Die eindeutige Komponentenlisten-ID

DELETE /api/groups/(int: id)/componentlists/(int: component_list_id)#

Löscht die Komponentenliste aus einer Gruppe.

Parameter:

  • id (int) – ID der Gruppe

  • component_list_id (int) – Die eindeutige Komponentenlisten-ID

Rollen#

GET /api/roles/#

Gibt eine Liste aller mit dem Benutzer zugeordneten Rollen zurück. Wenn der Benutzer ein Superuser ist, wird eine Liste aller vorhandenen Rollen zurückgegeben.

Siehe auch

Die Objektattribute von Rollen sind unter GET /api/roles/(int:id)/ dokumentiert.

POST /api/roles/#

Erstellt eine neue Rolle.

Parameter:

  • name (string) – Rollenname

  • permissions (array) – Liste der Codenamen der Berechtigungen

GET /api/roles/(int: id)/#

Gibt Informationen über eine Rolle zurück.

Parameter:

  • id (int) – ID der Rolle

JSON-Objekt-Antwort:

  • name (string) – Rollenname

  • permissions (array) – Liste der Codenamen der Berechtigungen

JSON-Daten-Beispiel:

{
    "name": "Access repository",
    "permissions": [
        "vcs.access",
        "vcs.view"
    ],
    "url": "http://example.com/api/roles/1/",
}
PUT /api/roles/(int: id)/#

Ändert die Rollenparameter.

Parameter:

  • id (int) – ID der Rolle

JSON-Objekt-Antwort:

  • name (string) – Rollenname

  • permissions (array) – Liste der Codenamen der Berechtigungen

PATCH /api/roles/(int: id)/#

Ändert die Rollenparameter.

Parameter:

  • id (int) – ID der Rolle

JSON-Objekt-Antwort:

  • name (string) – Rollenname

  • permissions (array) – Liste der Codenamen der Berechtigungen

DELETE /api/roles/(int: id)/#

Löscht die Rolle.

Parameter:

  • id (int) – ID der Rolle

Sprachen#

GET /api/languages/#

Gibt eine Liste aller Sprachen zurück.

Siehe auch

Die Objektattribute von Sprachen sind unter GET /api/languages/(string:language)/ dokumentiert.

POST /api/languages/#

Erstellt eine neue Sprache.

Parameter:

  • code (string) – Sprachenname

  • name (string) – Sprachenname

  • direction (string) – Leserichtung

  • population (int) – Anzahl der Sprecher

  • plural (object) – Pluralformeln und -formen der Sprache

GET /api/languages/(string: language)/#

Gibt Informationen über eine Sprache zurück.

Parameter:

  • language (string) – Sprachcode

JSON-Objekt-Antwort:

  • code (string) – Sprachcode

  • direction (string) – Leserichtung

  • plural (object) – Object der Pluralinformationen der Sprache

  • aliases (array) – Array der Sprachaliasnamen

JSON-Objekt-Anfrage:

  • population (int) – Anzahl der Sprecher

JSON-Daten-Beispiel:

{
    "code": "en",
    "direction": "ltr",
    "name": "English",
    "population": 159034349015,
    "plural": {
        "id": 75,
        "source": 0,
        "number": 2,
        "formula": "n != 1",
        "type": 1
    },
    "aliases": [
        "english",
        "en_en",
        "base",
        "source",
        "eng"
    ],
    "url": "http://example.com/api/languages/en/",
    "web_url": "http://example.com/languages/en/",
    "statistics_url": "http://example.com/api/languages/en/statistics/"
}
PUT /api/languages/(string: language)/#

Ändert die Sprachparameter.

Parameter:

  • language (string) – Sprachcode

JSON-Objekt-Anfrage:

  • name (string) – Sprachenname

  • direction (string) – Leserichtung

  • population (int) – Anzahl der Sprecher

  • plural (object) – Details zu Pluralformen der Sprache

PATCH /api/languages/(string: language)/#

Ändert die Sprachparameter.

Parameter:

  • language (string) – Sprachcode

JSON-Objekt-Anfrage:

  • name (string) – Sprachenname

  • direction (string) – Leserichtung

  • population (int) – Anzahl der Sprecher

  • plural (object) – Details zu Pluralformen der Sprache

DELETE /api/languages/(string: language)/#

Löscht die Sprache.

Parameter:

  • language (string) – Sprachcode

GET /api/languages/(string: language)/statistics/#

Gibt Statistiken für eine Sprache zurück.

Parameter:

  • language (string) – Sprachcode

Siehe auch

Die zurückgegebenen Attribute sind in Statistik beschrieben.

Projekte#

GET /api/projects/#

Gibt eine Liste aller Projekte zurück.

Siehe auch

Die Objektattribute von Projekten sind unter GET /api/projects/(string:project)/ dokumentiert.

POST /api/projects/#

Erstellt ein neues Projekt.

Parameter:

  • name (string) – Projektname

  • slug (string) – Projekt-Slug

  • web (string) – Projektseite

GET /api/projects/(string: project)/#

Gibt Informationen über ein Projekt zurück.

Parameter:

  • project (string) – Kurze Projekt-URL

JSON-Objekt-Antwort:

JSON-Daten-Beispiel:

{
    "name": "Hello",
    "slug": "hello",
    "url": "http://example.com/api/projects/hello/",
    "web": "https://weblate.org/",
    "web_url": "http://example.com/projects/hello/"
}
PATCH /api/projects/(string: project)/#

Neu in Version 4.3.

Bearbeitet ein Projekt durch eine PATCH-Anfrage.

Parameter:

  • project (string) – Kurze Projekt-URL

  • component (string) – Kurze Komponenten-URL

PUT /api/projects/(string: project)/#

Neu in Version 4.3.

Bearbeitet ein Projekt durch eine PUT-Anfrage.

Parameter:

  • project (string) – Kurze Projekt-URL

DELETE /api/projects/(string: project)/#

Löscht ein Projekt.

Parameter:

  • project (string) – Kurze Projekt-URL

GET /api/projects/(string: project)/changes/#

Gibt eine Liste der Projektänderungen zurück. Dies ist im Wesentlichen ein projektspezifisches GET /api/changes/ , das dieselben Parameter akzeptiert.

Parameter:

  • project (string) – Kurze Projekt-URL

JSON-Objekt-Antwort:
GET /api/projects/(string: project)/repository/#

Gibt Informationen über den Status des VCS-Repositorys zurück. Dieser Endpunkt enthält nur eine Gesamtzusammenfassung für alle Repositorys für das Projekt. Um einen detaillierteren Status zu erhalten, verwenden Sie GET /api/components/(string:project)/(string:component)/repository/.

Parameter:

  • project (string) – Kurze Projekt-URL

JSON-Objekt-Antwort:

  • needs_commit (boolean) – Ob es irgendwelche ausstehenden Änderungen zu committen gibt

  • needs_merge (boolean) – Ob es irgendwelche Upstream-Änderungen zum Zusammenführen gibt

  • needs_push (boolean) – Ob es irgendwelche lokale Änderungen zum Pushen gibt

JSON-Daten-Beispiel:

{
    "needs_commit": true,
    "needs_merge": false,
    "needs_push": true
}
POST /api/projects/(string: project)/repository/#

Führt eine bestimmte Operation im VCS-Repository durch.

Parameter:

  • project (string) – Kurze Projekt-URL

JSON-Objekt-Anfrage:

  • operation (string) – Auszuführende Operation: eine von push, pull, commit, reset, cleanup, file-sync, file-scan

JSON-Objekt-Antwort:

  • result (boolean) – Ergebnis der Operation

CURL-Beispiel:

curl \
    -d operation=pull \
    -H "Authorization: Token TOKEN" \
    http://example.com/api/projects/hello/repository/

JSON-Anfrage-Beispiel:

POST /api/projects/hello/repository/ HTTP/1.1
Host: example.com
Accept: application/json
Content-Type: application/json
Authorization: Token TOKEN
Content-Length: 20

{"operation":"pull"}

JSON-Antwort-Beispiel:

HTTP/1.0 200 OK
Date: Tue, 12 Apr 2016 09:32:50 GMT
Server: WSGIServer/0.1 Python/2.7.11+
Vary: Accept, Accept-Language, Cookie
X-Frame-Options: SAMEORIGIN
Content-Type: application/json
Content-Language: en
Allow: GET, POST, HEAD, OPTIONS

{"result":true}
GET /api/projects/(string: project)/components/#

Gibt eine Liste der Übersetzungskomponenten im angegebenen Projekt zurück.

Parameter:

  • project (string) – Kurze Projekt-URL

JSON-Objekt-Antwort:
POST /api/projects/(string: project)/components/#

Geändert in Version 4.3: Die Parameter zipfile und docfile werden jetzt für VCS-freie Komponenten akzeptiert, siehe Lokale Dateien.

Geändert in Version 4.6: Die geklonten Repositorys werden nun automatisch innerhalb eines Projekts mit Weblate-interne URLs geteilt. Verwenden Sie disable_autoshare um dies zu deaktivieren.

Erstellt Übersetzungskomponenten im angegebenen Projekt.

Hinweis

Verwenden Sie Weblate-interne URLs, wenn Sie mehrere Komponenten aus einem einzigen VCS-Repository erstellen.

Bemerkung

Der größte Teil der Komponentenerstellung erfolgt im Hintergrund. Prüfen Sie das Attribut task_url der erstellten Komponente und verfolgen Sie dort den Fortschritt.

Parameter:

  • project (string) – Kurze Projekt-URL

Formularparameter:

  • file zipfile – ZIP-Datei zum Hochladen in Weblate für die Initialisierung der Übersetzungen

  • file docfile – Zu übersetzendes Dokument

  • boolean disable_autoshare – Deaktiviert das automatische Teilen des Repositorys über Weblate-interne URLs.

JSON-Objekt-Anfrage:
JSON-Objekt-Antwort:

JSON kann nicht verwendet werden, wenn die Dateien mit den Parametern zipfile und docfile hochgeladen werden. Die Daten müssen als multipart/form-data hochgeladen werden.

CURL-Formular-Anfrage-Beispiel:

curl \
    --form docfile=@strings.html \
    --form name=Weblate \
    --form slug=weblate \
    --form file_format=html \
    --form new_lang=add \
    -H "Authorization: Token TOKEN" \
    http://example.com/api/projects/hello/components/

CURL-JSON-Anfrage-Beispiel:

curl \
    --data-binary '{
        "branch": "main",
        "file_format": "po",
        "filemask": "po/*.po",
        "name": "Weblate",
        "slug": "weblate",
        "repo": "https://github.com/WeblateOrg/hello.git",
        "template": "",
        "new_base": "po/hello.pot",
        "vcs": "git"
    }' \
    -H "Content-Type: application/json" \
    -H "Authorization: Token TOKEN" \
    http://example.com/api/projects/hello/components/

JSON-Anfrage zur Erstellung einer neuen Komponente von Git:

POST /api/projects/hello/components/ HTTP/1.1
Host: example.com
Accept: application/json
Content-Type: application/json
Authorization: Token TOKEN
Content-Length: 20

{
    "branch": "main",
    "file_format": "po",
    "filemask": "po/*.po",
    "name": "Weblate",
    "slug": "weblate",
    "repo": "https://github.com/WeblateOrg/hello.git",
    "template": "",
    "new_base": "po/hello.pot",
    "vcs": "git"
}

JSON-Anfrage zum Erstellen einer neuen Komponente aus einer anderen:

POST /api/projects/hello/components/ HTTP/1.1
Host: example.com
Accept: application/json
Content-Type: application/json
Authorization: Token TOKEN
Content-Length: 20

{
    "file_format": "po",
    "filemask": "po/*.po",
    "name": "Weblate",
    "slug": "weblate",
    "repo": "weblate://weblate/hello",
    "template": "",
    "new_base": "po/hello.pot",
    "vcs": "git"
}

JSON-Antwort-Beispiel:

HTTP/1.0 200 OK
Date: Tue, 12 Apr 2016 09:32:50 GMT
Server: WSGIServer/0.1 Python/2.7.11+
Vary: Accept, Accept-Language, Cookie
X-Frame-Options: SAMEORIGIN
Content-Type: application/json
Content-Language: en
Allow: GET, POST, HEAD, OPTIONS

{
    "branch": "main",
    "file_format": "po",
    "filemask": "po/*.po",
    "git_export": "",
    "license": "",
    "license_url": "",
    "name": "Weblate",
    "slug": "weblate",
    "project": {
        "name": "Hello",
        "slug": "hello",
        "source_language": {
            "code": "en",
            "direction": "ltr",
             "population": 159034349015,
            "name": "English",
            "url": "http://example.com/api/languages/en/",
            "web_url": "http://example.com/languages/en/"
        },
        "url": "http://example.com/api/projects/hello/",
        "web": "https://weblate.org/",
        "web_url": "http://example.com/projects/hello/"
    },
    "repo": "file:///home/nijel/work/weblate-hello",
    "template": "",
    "new_base": "",
    "url": "http://example.com/api/components/hello/weblate/",
    "vcs": "git",
    "web_url": "http://example.com/projects/hello/weblate/"
}
GET /api/projects/(string: project)/languages/#

Gibt paginierte Statistiken für alle Sprachen innerhalb eines Projekts zurück.

Parameter:

  • project (string) – Kurze Projekt-URL

JSON-Objekt-Antwort:

  • results (array) – Array von Übersetzungsstatistikobjekten

  • language (string) – Sprachenname

  • code (string) – Sprachcode

  • total (int) – Gesamtzahl der Zeichenketten

  • translated (int) – Anzahl übersetzter Zeichenketten

  • translated_percent (float) – Prozentsatz der übersetzten Zeichenketten

  • total_words (int) – Gesamtzahl der Wörter

  • translated_words (int) – Anzahl der übersetzten Wörter

  • words_percent (float) – Prozentsatz der übersetzten Wörter

GET /api/projects/(string: project)/statistics/#

Gibt Statistiken für ein Projekt zurück.

Parameter:

  • project (string) – Kurze Projekt-URL

Siehe auch

Die zurückgegebenen Attribute sind in Statistik beschrieben.

GET /api/projects/(string: project)/categories/#

Neu in Version 5.0: Gibt Statistiken für ein Projekt zurück. Siehe GET /api/categories/(int:id)/ für Felddefinitionen.

Projektparameter:

Kurze Projekt-URL

Projekttyp:

Zeichenkette

Komponenten#

Hinweis

Verwenden Sie POST /api/projects/(string:project)/components/ um neue Komponenten zu erstellen.

GET /api/components/#

Gibt eine Liste der Übersetzungskomponenten zurück.

Siehe auch

Die Objektattribute von Komponenten sind unter GET /api/components/(string:project)/(string:component)/ dokumentiert.

GET /api/components/(string: project)/(string: component)/#

Gibt Informationen über die Übersetzungskomponente zurück.

Parameter:

  • project (string) – Kurze Projekt-URL

  • component (string) – Kurze Komponenten-URL

JSON-Objekt-Antwort:

JSON-Daten-Beispiel:

{
    "branch": "main",
    "file_format": "po",
    "filemask": "po/*.po",
    "git_export": "",
    "license": "",
    "license_url": "",
    "name": "Weblate",
    "slug": "weblate",
    "project": {
        "name": "Hello",
        "slug": "hello",
        "source_language": {
            "code": "en",
            "direction": "ltr",
             "population": 159034349015,
            "name": "English",
            "url": "http://example.com/api/languages/en/",
            "web_url": "http://example.com/languages/en/"
        },
        "url": "http://example.com/api/projects/hello/",
        "web": "https://weblate.org/",
        "web_url": "http://example.com/projects/hello/"
    },
    "source_language": {
        "code": "en",
        "direction": "ltr",
        "population": 159034349015,
        "name": "English",
        "url": "http://example.com/api/languages/en/",
        "web_url": "http://example.com/languages/en/"
    },
    "repo": "file:///home/nijel/work/weblate-hello",
    "template": "",
    "new_base": "",
    "url": "http://example.com/api/components/hello/weblate/",
    "vcs": "git",
    "web_url": "http://example.com/projects/hello/weblate/"
}
PATCH /api/components/(string: project)/(string: component)/#

Bearbeitet eine Komponente durch eine PATCH-Anfrage.

Parameter:

  • project (string) – Kurze Projekt-URL

  • component (string) – Kurze Komponenten-URL

  • source_language (string) – Sprachcode der Projekt-Ausgangssprache (optional)

JSON-Objekt-Anfrage:

  • name (string) – Name der Komponente

  • slug (string) – Slug der Komponente

  • repo (string) – URL des VCS-Repository

CURL-Beispiel:

curl \
    --data-binary '{"name": "new name"}' \
    -H "Content-Type: application/json" \
    -H "Authorization: Token TOKEN" \
    PATCH http://example.com/api/projects/hello/components/

JSON-Anfrage-Beispiel:

PATCH /api/projects/hello/components/ HTTP/1.1
Host: example.com
Accept: application/json
Content-Type: application/json
Authorization: Token TOKEN
Content-Length: 20

{
    "name": "new name"
}

JSON-Antwort-Beispiel:

HTTP/1.0 200 OK
Date: Tue, 12 Apr 2016 09:32:50 GMT
Server: WSGIServer/0.1 Python/2.7.11+
Vary: Accept, Accept-Language, Cookie
X-Frame-Options: SAMEORIGIN
Content-Type: application/json
Content-Language: en
Allow: GET, POST, HEAD, OPTIONS

{
    "branch": "main",
    "file_format": "po",
    "filemask": "po/*.po",
    "git_export": "",
    "license": "",
    "license_url": "",
    "name": "new name",
    "slug": "weblate",
    "project": {
        "name": "Hello",
        "slug": "hello",
        "source_language": {
            "code": "en",
            "direction": "ltr",
            "population": 159034349015,
            "name": "English",
            "url": "http://example.com/api/languages/en/",
            "web_url": "http://example.com/languages/en/"
        },
        "url": "http://example.com/api/projects/hello/",
        "web": "https://weblate.org/",
        "web_url": "http://example.com/projects/hello/"
    },
    "repo": "file:///home/nijel/work/weblate-hello",
    "template": "",
    "new_base": "",
    "url": "http://example.com/api/components/hello/weblate/",
    "vcs": "git",
    "web_url": "http://example.com/projects/hello/weblate/"
}
PUT /api/components/(string: project)/(string: component)/#

Bearbeitet eine Komponente durch eine PUT-Anfrage.

Parameter:

  • project (string) – Kurze Projekt-URL

  • component (string) – Kurze Komponenten-URL

JSON-Objekt-Anfrage:

  • branch (string) – Branch des VCS-Repository

  • file_format (string) – Dateiformat der Übersetzungen

  • filemask (string) – Maske der Übersetzungsdateien im Repository

  • name (string) – Name der Komponente

  • slug (string) – Slug der Komponente

  • repo (string) – URL des VCS-Repository

  • template (string) – Basisdatei für einsprachige Übersetzungen

  • new_base (string) – Basisdatei für das Hinzufügen neuer Übersetzungen

  • vcs (string) – Versionsverwaltung

DELETE /api/components/(string: project)/(string: component)/#

Löscht eine Komponente.

Parameter:

  • project (string) – Kurze Projekt-URL

  • component (string) – Kurze Komponenten-URL

GET /api/components/(string: project)/(string: component)/changes/#

Gibt eine Liste der Komponentenänderungen zurück. Dies ist im Wesentlichen ein komponentenspezifisches GET /api/changes/, das dieselben Parameter akzeptiert.

Parameter:

  • project (string) – Kurze Projekt-URL

  • component (string) – Kurze Komponenten-URL

JSON-Objekt-Antwort:
GET /api/components/(string: project)/(string: component)/file/#

Neu in Version 4.9.

Lädt alle verfügbaren Übersetzungen, die der Komponente zugeordnet sind, als Archivdatei im gewünschten Format herunter.

Parameter:

  • project (string) – Kurze Projekt-URL

  • component (string) – Kurze Komponenten-URL

Abfrageparameter:

  • format (string) – Das zu verwendende Archivformat; wenn nicht angegeben, wird standardmäßig zip verwendet; Unterstützte Formate: zip

GET /api/components/(string: project)/(string: component)/screenshots/#

Gibt eine Liste der Komponenten-Bildschirmfotos zurück.

Parameter:

  • project (string) – Kurze Projekt-URL

  • component (string) – Kurze Komponenten-URL

JSON-Objekt-Antwort:
GET /api/components/(string: project)/(string: component)/lock/#

Gibt den Status der Komponentensperre zurück.

Parameter:

  • project (string) – Kurze Projekt-URL

  • component (string) – Kurze Komponenten-URL

JSON-Objekt-Antwort:

  • locked (boolean) – Ob die Komponente für Aktualisierungen gesperrt ist

JSON-Daten-Beispiel:

{
    "locked": false
}
POST /api/components/(string: project)/(string: component)/lock/#

Setzt den Status der Komponentensperre.

Die Antwort ist dieselbe wie bei GET /api/components/(string:project)/(string:component)/lock/.

Parameter:

  • project (string) – Kurze Projekt-URL

  • component (string) – Kurze Komponenten-URL

JSON-Objekt-Anfrage:

  • lock – Boolesche Angabe, ob gesperrt werden soll oder nicht.

CURL-Beispiel:

curl \
    -d lock=true \
    -H "Authorization: Token TOKEN" \
    http://example.com/api/components/hello/weblate/repository/

JSON-Anfrage-Beispiel:

POST /api/components/hello/weblate/repository/ HTTP/1.1
Host: example.com
Accept: application/json
Content-Type: application/json
Authorization: Token TOKEN
Content-Length: 20

{"lock": true}

JSON-Antwort-Beispiel:

HTTP/1.0 200 OK
Date: Tue, 12 Apr 2016 09:32:50 GMT
Server: WSGIServer/0.1 Python/2.7.11+
Vary: Accept, Accept-Language, Cookie
X-Frame-Options: SAMEORIGIN
Content-Type: application/json
Content-Language: en
Allow: GET, POST, HEAD, OPTIONS

{"locked":true}
GET /api/components/(string: project)/(string: component)/repository/#

Gibt Informationen über den Status des VCS-Repositorys zurück.

Die Antwort ist dieselbe wie bei GET /api/projects/(string:project)/repository/.

Parameter:

  • project (string) – Kurze Projekt-URL

  • component (string) – Kurze Komponenten-URL

JSON-Objekt-Antwort:

  • needs_commit (boolean) – Ob es irgendwelche ausstehenden Änderungen zu committen gibt

  • needs_merge (boolean) – Ob es irgendwelche Upstream-Änderungen zum Zusammenführen gibt

  • needs_push (boolean) – Ob es irgendwelche lokale Änderungen zum Pushen gibt

  • remote_commit (string) – Information des Remote-Commit

  • status (string) – Repository-Status des VCS, wie von VCS gemeldet

  • merge_failure – Text des Merge-Konflikts, oder Null, wenn es keinen gibt

POST /api/components/(string: project)/(string: component)/repository/#

Führt die angegebene Operation an einem VCS-Repository durch.

Siehe POST /api/projects/(string:project)/repository/ für die Dokumentation.

Parameter:

  • project (string) – Kurze Projekt-URL

  • component (string) – Kurze Komponenten-URL

JSON-Objekt-Anfrage:

  • operation (string) – Auszuführende Operation: eine von push, pull, commit, reset, cleanup

JSON-Objekt-Antwort:

  • result (boolean) – Ergebnis der Operation

CURL-Beispiel:

curl \
    -d operation=pull \
    -H "Authorization: Token TOKEN" \
    http://example.com/api/components/hello/weblate/repository/

JSON-Anfrage-Beispiel:

POST /api/components/hello/weblate/repository/ HTTP/1.1
Host: example.com
Accept: application/json
Content-Type: application/json
Authorization: Token TOKEN
Content-Length: 20

{"operation":"pull"}

JSON-Antwort-Beispiel:

HTTP/1.0 200 OK
Date: Tue, 12 Apr 2016 09:32:50 GMT
Server: WSGIServer/0.1 Python/2.7.11+
Vary: Accept, Accept-Language, Cookie
X-Frame-Options: SAMEORIGIN
Content-Type: application/json
Content-Language: en
Allow: GET, POST, HEAD, OPTIONS

{"result":true}
GET /api/components/(string: project)/(string: component)/monolingual_base/#

Lädt die Basisdatei für einsprachige Übersetzungen herunter.

Parameter:

  • project (string) – Kurze Projekt-URL

  • component (string) – Kurze Komponenten-URL

GET /api/components/(string: project)/(string: component)/new_template/#

Lädt die Vorlagendatei für neue Übersetzungen herunter.

Parameter:

  • project (string) – Kurze Projekt-URL

  • component (string) – Kurze Komponenten-URL

GET /api/components/(string: project)/(string: component)/translations/#

Gibt eine Liste der Übersetzungsobjekte in der angegebenen Komponente zurück.

Parameter:

  • project (string) – Kurze Projekt-URL

  • component (string) – Kurze Komponenten-URL

JSON-Objekt-Antwort:
POST /api/components/(string: project)/(string: component)/translations/#

Erstellt eine neue Übersetzung in der angegebenen Komponente.

Parameter:

  • project (string) – Kurze Projekt-URL

  • component (string) – Kurze Komponenten-URL

JSON-Objekt-Anfrage:
JSON-Objekt-Antwort:

  • result (object) – Neues Übersetzungsobjekt wurde erstellt

CURL-Beispiel:

curl \
    -d language_code=cs \
    -H "Authorization: Token TOKEN" \
    http://example.com/api/projects/hello/components/

JSON-Anfrage-Beispiel:

POST /api/projects/hello/components/ HTTP/1.1
Host: example.com
Accept: application/json
Content-Type: application/json
Authorization: Token TOKEN
Content-Length: 20

{"language_code": "cs"}

JSON-Antwort-Beispiel:

HTTP/1.0 200 OK
Date: Tue, 12 Apr 2016 09:32:50 GMT
Server: WSGIServer/0.1 Python/2.7.11+
Vary: Accept, Accept-Language, Cookie
X-Frame-Options: SAMEORIGIN
Content-Type: application/json
Content-Language: en
Allow: GET, POST, HEAD, OPTIONS

{
    "failing_checks": 0,
    "failing_checks_percent": 0,
    "failing_checks_words": 0,
    "filename": "po/cs.po",
    "fuzzy": 0,
    "fuzzy_percent": 0.0,
    "fuzzy_words": 0,
    "have_comment": 0,
    "have_suggestion": 0,
    "is_template": false,
    "is_source": false,
    "language": {
        "code": "cs",
        "direction": "ltr",
        "population": 1303174280
        "name": "Czech",
        "url": "http://example.com/api/languages/cs/",
        "web_url": "http://example.com/languages/cs/"
    },
    "language_code": "cs",
    "id": 125,
    "last_author": null,
    "last_change": null,
    "share_url": "http://example.com/engage/hello/cs/",
    "total": 4,
    "total_words": 15,
    "translate_url": "http://example.com/translate/hello/weblate/cs/",
    "translated": 0,
    "translated_percent": 0.0,
    "translated_words": 0,
    "url": "http://example.com/api/translations/hello/weblate/cs/",
    "web_url": "http://example.com/projects/hello/weblate/cs/"
}
GET /api/components/(string: project)/(string: component)/statistics/#

Gibt eine paginierte Statistik für alle Übersetzungen innerhalb der Komponente zurück.

Parameter:

  • project (string) – Kurze Projekt-URL

  • component (string) – Kurze Komponenten-URL

Siehe auch

Die zurückgegebenen Attribute sind in Statistik beschrieben.

GET /api/components/(string: project)/(string: component)/links/#

Gibt mit einer Komponente verknüpfte Projekte zurück.

Neu in Version 4.5.

Parameter:

  • project (string) – Kurze Projekt-URL

  • component (string) – Kurze Komponenten-URL

JSON-Objekt-Antwort:
POST /api/components/(string: project)/(string: component)/links/#

Ordnet Projekt einer Komponente zu.

Neu in Version 4.5.

Parameter:

  • project (string) – Kurze Projekt-URL

  • component (string) – Kurze Komponenten-URL

Formularparameter:

  • string project_slug – Projekt-Slug

DELETE /api/components/(string: project)/(string: component)/links/(string: project_slug)/#

Aufhebung der Zuordnung eines Projekts zu einer Komponente.

Neu in Version 4.5.

Parameter:

  • project (string) – Kurze Projekt-URL

  • component (string) – Kurze Komponenten-URL

  • project_slug (string) – Slug des zu entfernenden Projekts

Übersetzungen#

GET /api/translations/#

Gibt eine Liste der Übersetzungen zurück.

Siehe auch

Die Objektattribute von Übersetzungen sind unter GET /api/translations/(string:project)/(string:component)/(string:language)/ dokumentiert.

GET /api/translations/(string: project)/(string: component)/(string: language)/#

Gibt Informationen über eine Übersetzung zurück.

Parameter:

  • project (string) – Kurze Projekt-URL

  • component (string) – Kurze Komponenten-URL

  • language (string) – Sprachcode der Übersetzung

JSON-Objekt-Antwort:

  • component (object) – Komponentenobjekt; siehe GET /api/components/(string:project)/(string:component)/

  • failing_checks (int) – Anzahl der Zeichenketten mit fehlgeschlagenen Qualitätsprüfungen

  • failing_checks_percent (float) – Prozentsatz der Zeichenketten mit fehlgeschlagenen Qualitätsprüfungen

  • failing_checks_words (int) – Anzahl der Wörter mit fehlgeschlagenen Qualitätsprüfungen

  • filename (string) – Dateiname der Übersetzung

  • fuzzy (int) – Anzahl der ungenauen (zur Bearbeitung markierten) Zeichenketten

  • fuzzy_percent (float) – Prozentsatz der ungenauen (zur Bearbeitung markierten) Zeichenketten

  • fuzzy_words (int) – Anzahl der Wörter in ungenauen (zur Bearbeitung markierten) Zeichenketten

  • have_comment (int) – Anzahl der Zeichenketten mit Kommentar

  • have_suggestion (int) – Anzahl der Zeichenketten mit Übersetzungsvorschlag

  • is_template (boolean) – Ob die Übersetzung eine einsprachige Basis hat

  • language (object) – Ausgangsspracheobjekt; siehe GET /api/languages/(string:language)/

  • language_code (string) – Im Repository verwendeter Sprachcode; dieser kann sich vom Sprachcode im Sprachobjekt unterscheiden

  • last_author (string) – Name des zuletzt aktiven Übersetzers

  • last_change (timestamp) – Zeitstempel der letzten Änderung

  • revision (string) – Revisions-Hash der Datei

  • share_url (string) – URL zum Teilen, die zur Beteiligungsseite führt

  • total (int) – Gesamtzahl der Zeichenketten

  • total_words (int) – Gesamtzahl der Wörter

  • translate_url (string) – URL der Übersetzung

  • translated (int) – Anzahl übersetzter Zeichenketten

  • translated_percent (float) – Prozentsatz der übersetzten Zeichenketten

  • translated_words (int) – Anzahl der übersetzten Wörter

  • repository_url (string) – URL zum Repository-Status; siehe GET /api/translations/(string:project)/(string:component)/(string:language)/repository/

  • file_url (string) – URL zum Dateiobjekt; siehe GET /api/translations/(string:project)/(string:component)/(string:language)/file/

  • changes_list_url (string) – URL zur Änderungsliste; siehe GET /api/translations/(string:project)/(string:component)/(string:language)/changes/

  • units_list_url (string) – URL zur Zeichenkettenliste; siehe GET /api/translations/(string:project)/(string:component)/(string:language)/units/

JSON-Daten-Beispiel:

{
    "component": {
        "branch": "main",
        "file_format": "po",
        "filemask": "po/*.po",
        "git_export": "",
        "license": "",
        "license_url": "",
        "name": "Weblate",
        "new_base": "",
        "project": {
            "name": "Hello",
            "slug": "hello",
            "source_language": {
                "code": "en",
                "direction": "ltr",
                "population": 159034349015,
                "name": "English",
                "url": "http://example.com/api/languages/en/",
                "web_url": "http://example.com/languages/en/"
            },
            "url": "http://example.com/api/projects/hello/",
            "web": "https://weblate.org/",
            "web_url": "http://example.com/projects/hello/"
        },
        "repo": "file:///home/nijel/work/weblate-hello",
        "slug": "weblate",
        "template": "",
        "url": "http://example.com/api/components/hello/weblate/",
        "vcs": "git",
        "web_url": "http://example.com/projects/hello/weblate/"
    },
    "failing_checks": 3,
    "failing_checks_percent": 75.0,
    "failing_checks_words": 11,
    "filename": "po/cs.po",
    "fuzzy": 0,
    "fuzzy_percent": 0.0,
    "fuzzy_words": 0,
    "have_comment": 0,
    "have_suggestion": 0,
    "is_template": false,
    "language": {
        "code": "cs",
        "direction": "ltr",
        "population": 1303174280
        "name": "Czech",
        "url": "http://example.com/api/languages/cs/",
        "web_url": "http://example.com/languages/cs/"
    },
    "language_code": "cs",
    "last_author": "Weblate Admin",
    "last_change": "2016-03-07T10:20:05.499",
    "revision": "7ddfafe6daaf57fc8654cc852ea6be212b015792",
    "share_url": "http://example.com/engage/hello/cs/",
    "total": 4,
    "total_words": 15,
    "translate_url": "http://example.com/translate/hello/weblate/cs/",
    "translated": 4,
    "translated_percent": 100.0,
    "translated_words": 15,
    "url": "http://example.com/api/translations/hello/weblate/cs/",
    "web_url": "http://example.com/projects/hello/weblate/cs/"
}
DELETE /api/translations/(string: project)/(string: component)/(string: language)/#

Löscht eine Übersetzung.

Parameter:

  • project (string) – Kurze Projekt-URL

  • component (string) – Kurze Komponenten-URL

  • language (string) – Sprachcode der Übersetzung

GET /api/translations/(string: project)/(string: component)/(string: language)/changes/#

Gibt eine Liste der Übersetzungsänderungen zurück. Dies ist im Wesentlichen ein übersetzungsspezifisches GET /api/changes/, das dieselben Parameter akzeptiert.

Parameter:

  • project (string) – Kurze Projekt-URL

  • component (string) – Kurze Komponenten-URL

  • language (string) – Sprachcode der Übersetzung

JSON-Objekt-Antwort:
GET /api/translations/(string: project)/(string: component)/(string: language)/units/#

Gibt eine Liste der Übersetzungseinheiten zurück.

Parameter:

  • project (string) – Kurze Projekt-URL

  • component (string) – Kurze Komponenten-URL

  • language (string) – Sprachcode der Übersetzung

  • q (string) – Suchanfrage-Zeichenkette Suche (optional)

JSON-Objekt-Antwort:
POST /api/translations/(string: project)/(string: component)/(string: language)/units/#

Fügt eine neue Einheit hinzu.

Parameter:

  • project (string) – Kurze Projekt-URL

  • component (string) – Kurze Komponenten-URL

  • language (string) – Sprachcode der Übersetzung

JSON-Objekt-Anfrage:

  • key (string) – Name der Übersetzungseinheit (verwendet als Schlüssel oder Kontext)

  • value (array) – Ausgangszeichenketten (einzelne Zeichenkette verwenden, wenn kein Plural erstellt wird)

  • state (int) – Zeichenkettenstatus; siehe GET /api/units/(int:id)/

JSON-Objekt-Antwort:

Siehe auch

Zeichenketten verwalten, Neue Zeichenketten hinzufügen

POST /api/translations/(string: project)/(string: component)/(string: language)/autotranslate/#

Löst die automatische Übersetzung aus.

Parameter:

  • project (string) – Kurze Projekt-URL

  • component (string) – Kurze Komponenten-URL

  • language (string) – Sprachcode der Übersetzung

JSON-Objekt-Anfrage:

  • mode (string) – Automatischer Übersetzungsmodus

  • filter_type (string) – Filtertyp der automatischen Übersetzung

  • auto_source (string) – Automatische Übersetzung – mt oder others

  • component (string) – Aktivieren Sie den Beitrag zum gemeinsamen Übersetzungsspeicher für das Projekt, um Zugriff auf zusätzliche Komponenten zu erhalten.

  • engines (array) – Maschinelle Übersetzungssysteme

  • threshold (string) – Schwellenwert

GET /api/translations/(string: project)/(string: component)/(string: language)/file/#

Lädt die aktuelle Übersetzungsdatei, wie sie im VCS gespeichert ist (ohne den Parameter format) oder in ein anderes Format konvertiert wurde (siehe Übersetzungen herunterladen) herunter.

Bemerkung

Dieser API-Endpunkt verwendet eine andere Logik für die Ausgabe als der Rest der API, da er mit der gesamten Datei und nicht mit den Daten arbeitet. Die Menge der akzeptierten format-Parameter unterscheidet sich und ohne einen solchen Parameter erhalten Sie die Übersetzungsdatei, wie sie im VCS gespeichert ist.

Abfrageparameter:

  • format – Zu verwendendes Dateiformat; wenn nicht angegeben, erfolgt keine Formatkonvertierung; siehe Übersetzungen herunterladen für unterstützte Formate

  • q (string) – Filter für heruntergeladene Zeichenketten, siehe Suche, nur anwendbar, wenn eine Konvertierung stattfindet (format ist angegeben).

Parameter:

  • project (string) – Kurze Projekt-URL

  • component (string) – Kurze Komponenten-URL

  • language (string) – Sprachcode der Übersetzung

POST /api/translations/(string: project)/(string: component)/(string: language)/file/#

Lädt eine neue Datei mit Übersetzungen hoch.

Parameter:

  • project (string) – Kurze Projekt-URL

  • component (string) – Kurze Komponenten-URL

  • language (string) – Sprachcode der Übersetzung

Formularparameter:

  • string conflicts – Wie mit Konflikten umgegangen wird (ignore, replace-translated oder replace-approved)

  • file file – Hochgeladene Datei

  • string email – Autor-E-Mail

  • string author – Autor-Name

  • string method – Upload-Methode (translate, approve, suggest, fuzzy, replace, source, add), siehe Importmethoden

  • string fuzzy – Verarbeitung von ungenauen (zur Bearbeitung markierte) Zeichenketten (leer, process, approve)

CURL-Beispiel:

curl -X POST \
    -F file=@strings.xml \
    -H "Authorization: Token TOKEN" \
    http://example.com/api/translations/hello/android/cs/file/
GET /api/translations/(string: project)/(string: component)/(string: language)/repository/#

Gibt Informationen über den Status des VCS-Repositorys zurück.

Die Antwort ist dieselbe wie bei GET /api/components/(string:project)/(string:component)/repository/.

Parameter:

  • project (string) – Kurze Projekt-URL

  • component (string) – Kurze Komponenten-URL

  • language (string) – Sprachcode der Übersetzung

POST /api/translations/(string: project)/(string: component)/(string: language)/repository/#

Führt eine bestimmte Operation im VCS-Repository durch.

Siehe POST /api/projects/(string:project)/repository/ für die Dokumentation.

Parameter:

  • project (string) – Kurze Projekt-URL

  • component (string) – Kurze Komponenten-URL

  • language (string) – Sprachcode der Übersetzung

JSON-Objekt-Anfrage:

  • operation (string) – Auszuführende Operation: eine von push, pull, commit, reset, cleanup

JSON-Objekt-Antwort:

  • result (boolean) – Ergebnis der Operation

GET /api/translations/(string: project)/(string: component)/(string: language)/statistics/#

Gibt detaillierte Übersetzungsstatistiken zurück.

Parameter:

  • project (string) – Kurze Projekt-URL

  • component (string) – Kurze Komponenten-URL

  • language (string) – Sprachcode der Übersetzung

Siehe auch

Die zurückgegebenen Attribute sind in Statistik beschrieben.

Speicher#

Neu in Version 4.14.

GET /api/memory/#

Gibt eine Liste der Speicherergebnisse zurück.

DELETE /api/memory/(int: memory_object_id)/#

Löscht ein Speicherobjekt

Parameter:

  • memory_object_id – Speicherobjekt-ID

Einheiten#

Eine Einheit ist ein einzelner Teil einer Übersetzung, der eine Ausgangszeichenkette mit einer entsprechenden übersetzten Zeichenkette verbindet und auch einige zugehörige Metadaten enthält. Der Begriff stammt aus dem Translate-Toolkit und XLIFF.

GET /api/units/#

Gibt eine Liste der Übersetzungseinheiten zurück.

Parameter:

  • q (string) – Suchanfrage-Zeichenkette Suche (optional)

Siehe auch

Die Objektattribute von Einheiten sind unter GET /api/units/(int:id)/ dokumentiert.

GET /api/units/(int: id)/#

Geändert in Version 4.3: target und source sind jetzt Arrays, um Zeichenketten mit Pluralformen richtig zu behandeln.

Gibt Informationen über die Übersetzungseinheit zurück.

Parameter:

  • id (int) – Einheitenkennung

JSON-Objekt-Antwort:

  • translation (string) – URL eines zugehörigen Übersetzungsobjekts

  • source (array) – Ausgangszeichenkette

  • previous_source (string) – Vorherige Ausgangszeichenkette, die für Fuzzy-Matching verwendet wurde

  • target (array) – Zielzeichenkette

  • id_hash (string) – Eindeutige Kennung der Einheit

  • content_hash (string) – Eindeutige Kennung der Ausgangszeichenkette

  • location (string) – Position der Einheit im Quellcode

  • context (string) – Kontext der Übersetzungseinheit

  • note (string) – Anmerkung zur Übersetzungseinheit

  • flags (string) – Markierung der Übersetzungseinheit

  • labels (array) – Labels der Übersetzungseinheit, verfügbar in der Ausgangseinheit

  • state (int) – Status der Einheit, 0 – nicht übersetzt, 10 – bearbeitungsbedürftig, 20 – übersetzt, 30 – genehmigt, 100 – schreibgeschützt

  • fuzzy (boolean) – Ob die Einheit ungenau oder zur Überprüfung markiert ist

  • translated (boolean) – Ob die Einheit übersetzt wird

  • approved (boolean) – Ob die Übersetzung genehmigt wird

  • position (int) – Position der Einheit in der Übersetzungsdatei

  • has_suggestion (boolean) – Ob die Einheit Vorschläge hat

  • has_comment (boolean) – Ob die Einheit Kommentare hat

  • has_failing_check (boolean) – Ob die Einheit fehlerhafte Prüfungen aufweist

  • num_words (int) – Anzahl der Ausgangswörter

  • priority (int) – Übersetzungspriorität; 100 ist Standard

  • id (int) – Einheitenkennung

  • explanation (string) – Erklärung der Zeichenkette, verfügbar in den Ausgangseinheiten, siehe Zusätzliche Informationen über Ausgangszeichenketten

  • extra_flags (string) – Zusätzliche Markierungen der Zeichenkette, verfügbar in den Ausgangseinheiten, siehe Anpassen des Verhaltens mit Markierungen

  • web_url (string) – URL, unter der die Einheit bearbeitet werden kann

  • source_unit (string) – Link zur Ausgangseinheit; siehe GET /api/units/(int:id)/

  • pending (boolean) – Ob die Einheit zum Schreiben aussteht

  • timestamp (timestamp) – Alter der Zeichenkette

PATCH /api/units/(int: id)/#

Neu in Version 4.3.

Führt eine teilweise Aktualisierung der Übersetzungseinheit durch.

Parameter:

  • id (int) – Einheitenkennung

JSON-Objekt-Anfrage:
JSON-Objekt-Antwort:

  • labels (array) – Labels, verfügbar in den Ausgangseinheiten

PUT /api/units/(int: id)/#

Neu in Version 4.3.

Führt ein vollständiges Update der Übersetzungseinheit durch.

Parameter:

  • id (int) – Einheitenkennung

JSON-Objekt-Anfrage:
JSON-Objekt-Antwort:

  • labels (array) – Labels, verfügbar in den Ausgangseinheiten

DELETE /api/units/(int: id)/#

Neu in Version 4.3.

Löscht eine Übersetzungseinheit.

Parameter:

  • id (int) – Einheitenkennung

Änderungen#

GET /api/changes/#

Geändert in Version 4.1: Die Filterung von Änderungen wurde mit der Version 4.1 eingeführt.

Gibt eine Liste der Übersetzungsänderungen zurück.

Siehe auch

Die Objektattribute von Änderungen sind unter GET /api/changes/(int:id)/ dokumentiert.

Abfrageparameter:

  • user (string) – Benutzername des zu filternden Benutzers

  • action (int) – Aktion zum Filtern, kann mehrfach verwendet werden

  • timestamp_after (timestamp) – ISO 8601-formatierter Zeitstempel zur Auflistung von Änderungen nach

  • timestamp_before (timestamp) – ISO 8601-formatierter Zeitstempel zur Auflistung von Änderungen vor

GET /api/changes/(int: id)/#

Gibt Informationen über Übersetzungsänderungen zurück.

Parameter:

  • id (int) – Änderungs-ID

JSON-Objekt-Antwort:

  • unit (string) – URL eines zugehörigen Einheitenobjekts

  • translation (string) – URL eines zugehörigen Übersetzungsobjekts

  • component (string) – URL eines zugehörigen Komponentenobjekts

  • user (string) – URL eines zugehörigen Benutzerobjekts

  • author (string) – URL eines zugehörigen Autorenobjekts

  • timestamp (timestamp) – Zeitstempel des Ereignisses

  • action (int) – Numerische Kennzeichnung der Aktion

  • action_name (string) – Textbeschreibung der Aktion

  • target (string) – Änderungstext oder -detail des Ereignisses

  • id (int) – Änderungskennung

Bildschirmfotos#

GET /api/screenshots/#

Gibt eine Liste der Zeichenketteninformationen-Bildschirmfotos zurück.

Siehe auch

Die Objektattribute von Bildschirmfotos sind unter GET /api/screenshots/(int:id)/ dokumentiert.

GET /api/screenshots/(int: id)/#

Gibt Informationen über Bildschirmfotos zurück.

Parameter:

  • id (int) – Bildschirmfoto-ID

JSON-Objekt-Antwort:

  • name (string) – Name des Bildschirmfotos

  • component (string) – URL eines zugehörigen Komponentenobjekts

  • file_url (string) – URL zum Herunterladen einer Datei; siehe GET /api/screenshots/(int:id)/file/

  • units (array) – Link zur zugehörigen Information der Ausgangszeichenkette; siehe GET /api/units/(int:id)/

GET /api/screenshots/(int: id)/file/#

Lädt das Bildschirmfoto herunter.

Parameter:

  • id (int) – Bildschirmfoto-ID

POST /api/screenshots/(int: id)/file/#

Ersetzt das Bildschirmfoto.

Parameter:

  • id (int) – Bildschirmfoto-ID

Formularparameter:

  • file image – Hochgeladene Datei

CURL-Beispiel:

curl -X POST \
    -F image=@image.png \
    -H "Authorization: Token TOKEN" \
    http://example.com/api/screenshots/1/file/
POST /api/screenshots/(int: id)/units/#

Ordnet Ausgangszeichenkette einem Bildschirmfoto zu.

Parameter:

  • id (int) – Bildschirmfoto-ID

Formularparameter:

  • string unit_id – Einheitenkennung

JSON-Objekt-Antwort:

  • name (string) – Name des Bildschirmfotos

  • translation (string) – URL eines zugehörigen Übersetzungsobjekts

  • file_url (string) – URL zum Herunterladen einer Datei; siehe GET /api/screenshots/(int:id)/file/

  • units (array) – Link zur zugehörigen Information der Ausgangszeichenkette; siehe GET /api/units/(int:id)/

DELETE /api/screenshots/(int: id)/units/(int: unit_id)#

Entfernt die Zuordnung der Ausgangszeichenkette mit dem Bildschirmfoto.

Parameter:

  • id (int) – Bildschirmfoto-ID

  • unit_id – Ausgangszeichenkette-Einheitenkennung

POST /api/screenshots/#

Erstellt ein neues Bildschirmfoto.

Formularparameter:

  • file image – Hochgeladene Datei

  • string name – Name des Bildschirmfotos

  • string project_slug – Projekt-Slug

  • string component_slug – Komponenten-Slug

  • string language_code – Sprachcode

JSON-Objekt-Antwort:

  • name (string) – Name des Bildschirmfotos

  • component (string) – URL eines zugehörigen Komponentenobjekts

  • file_url (string) – URL zum Herunterladen einer Datei; siehe GET /api/screenshots/(int:id)/file/

  • units (array) – Link zur zugehörigen Information der Ausgangszeichenkette; siehe GET /api/units/(int:id)/

PATCH /api/screenshots/(int: id)/#

Bearbeitet Teilinformationen zum Bildschirmfoto.

Parameter:

  • id (int) – Bildschirmfoto-ID

JSON-Objekt-Antwort:

  • name (string) – Name des Bildschirmfotos

  • component (string) – URL eines zugehörigen Komponentenobjekts

  • file_url (string) – URL zum Herunterladen einer Datei; siehe GET /api/screenshots/(int:id)/file/

  • units (array) – Link zur zugehörigen Information der Ausgangszeichenkette; siehe GET /api/units/(int:id)/

PUT /api/screenshots/(int: id)/#

Bearbeitet alle Informationen zum Bildschirmfoto.

Parameter:

  • id (int) – Bildschirmfoto-ID

JSON-Objekt-Antwort:

  • name (string) – Name des Bildschirmfotos

  • component (string) – URL eines zugehörigen Komponentenobjekts

  • file_url (string) – URL zum Herunterladen einer Datei; siehe GET /api/screenshots/(int:id)/file/

  • units (array) – Link zur zugehörigen Information der Ausgangszeichenkette; siehe GET /api/units/(int:id)/

DELETE /api/screenshots/(int: id)/#

Löscht das Bildschirmfoto.

Parameter:

  • id (int) – Bildschirmfoto-ID

Erweiterungen#

Neu in Version 4.4.1.

GET /api/addons/#

Gibt eine Liste der Erweiterungen zurück.

Siehe auch

Die Objektattribute von Erweiterungen sind unter GET /api/addons/(int:id)/ dokumentiert.

GET /api/addons/(int: id)/#

Gibt Informationen über Erweiterungen zurück.

Parameter:

  • id (int) – Erweiterungs-ID

JSON-Objekt-Antwort:

  • name (string) – Name der Erweiterung

  • component (string) – URL eines zugehörigen Komponentenobjekts

  • configuration (object) – Optionale Konfiguration der Erweiterung

Siehe auch

Erweiterungen

POST /api/components/(string: project)/(string: component)/addons/#

Erstellt eine neue Erweiterung.

Parameter:

  • project_slug (string) – Projekt-Slug

  • component_slug (string) – Komponenten-Slug

JSON-Objekt-Anfrage:

  • name (string) – Name der Erweiterung

  • configuration (object) – Optionale Konfiguration der Erweiterung

PATCH /api/addons/(int: id)/#

Bearbeitet Teilinformationen zur Erweiterung.

Parameter:

  • id (int) – Erweiterungs-ID

JSON-Objekt-Antwort:

  • configuration (object) – Optionale Konfiguration der Erweiterung

PUT /api/addons/(int: id)/#

Bearbeitet alle Informationen zur Erweiterung.

Parameter:

  • id (int) – Erweiterungs-ID

JSON-Objekt-Antwort:

  • configuration (object) – Optionale Konfiguration der Erweiterung

DELETE /api/addons/(int: id)/#

Löscht die Erweiterung.

Parameter:

  • id (int) – Erweiterungs-ID

Komponentenlisten#

Neu in Version 4.0.

GET /api/component-lists/#

Gibt eine Liste der Komponentenlisten zurück.

Siehe auch

Die Objektattribute von Komponentenlisten sind unter GET /api/component-lists/(str:slug)/ dokumentiert.

GET /api/component-lists/(str: slug)/#

Gibt Informationen über die Komponentenliste zurück.

Parameter:

  • slug (string) – Komponentenliste-Slug

JSON-Objekt-Antwort:

  • name (string) – Name einer Komponentenliste

  • slug (string) – Slug einer Komponentenliste

  • show_dashboard (boolean) – Ob es auf einer Übersichtsseite angezeigt werden soll

  • components (array) – Link zu den zugeordneten Komponenten; siehe GET /api/components/(string:project)/(string:component)/

  • auto_assign (array) – Automatische Zuweisungsregeln

PUT /api/component-lists/(str: slug)/#

Ändert die Parameter der Komponentenliste.

Parameter:

  • slug (string) – Komponentenliste-Slug

JSON-Objekt-Anfrage:

  • name (string) – Name einer Komponentenliste

  • slug (string) – Slug einer Komponentenliste

  • show_dashboard (boolean) – Ob es auf einer Übersichtsseite angezeigt werden soll

PATCH /api/component-lists/(str: slug)/#

Ändert die Parameter der Komponentenliste.

Parameter:

  • slug (string) – Komponentenliste-Slug

JSON-Objekt-Anfrage:

  • name (string) – Name einer Komponentenliste

  • slug (string) – Slug einer Komponentenliste

  • show_dashboard (boolean) – Ob es auf einer Übersichtsseite angezeigt werden soll

DELETE /api/component-lists/(str: slug)/#

Löscht die Komponentenliste.

Parameter:

  • slug (string) – Komponentenliste-Slug

GET /api/component-lists/(str: slug)/components/#

Neu in Version 5.0.1: List components in a component list.

Parameter-Slug:

Komponentenliste-Slug

Typ-Slug:

Zeichenkette

Formatzeichenkette-Komponenten-ID:

Komponenten-ID

>JSON-Array-Ergebnisse:

Array von Komponentenobjekten; siehe GET /api/components/(string:project)/(string:component)/

POST /api/component-lists/(str: slug)/components/#

Ordnet Komponente einer Komponentenliste zu.

Parameter:

  • slug (string) – Komponentenliste-Slug

Formularparameter:

  • string component_id – Komponenten-ID

DELETE /api/component-lists/(str: slug)/components/(str: component_slug)#

Hebt die Zuordnung einer Komponente zur Komponentenliste auf.

Parameter:

  • slug (string) – Komponentenliste-Slug

  • component_slug (string) – Komponenten-Slug

Glossar#

Geändert in Version 4.5: Glossare werden nun als reguläre Komponenten, Übersetzungen und Zeichenketten gespeichert, bitte verwenden Sie stattdessen die entsprechende API.

Aufgaben#

Neu in Version 4.4.

GET /api/tasks/#

Eine Auflistung der Aufgaben ist derzeit nicht verfügbar.

GET /api/tasks/(str: uuid)/#

Gibt Informationen über eine Aufgabe zurück.

Parameter:

  • uuid (string) – Aufgaben-UUID

JSON-Objekt-Antwort:

  • completed (boolean) – Ob die Aufgabe abgeschlossen wurde

  • progress (int) – Aufgabenfortschritt in Prozent

  • result (object) – Details zum Aufgabenergebnis oder -fortschritt

  • log (string) – Aufgabenprotokoll

Statistik#

GET /api/(str: object)/statistics/#

Es gibt mehrere Statistikendpunkte für Objekte, die alle dieselbe Struktur aufweisen.

Parameter:

  • object (string) – URL-Pfad

JSON-Objekt-Antwort:

  • total (int) – Gesamtzahl der Zeichenketten

  • total_words (int) – Gesamtzahl der Wörter

  • total_chars (int) – Gesamtzahl der Zeichen

  • last_change (timestamp) – Datum der letzten Änderung

  • translated (int) – Anzahl übersetzter Zeichenketten

  • translated_percent (float) – Prozentsatz der übersetzten Zeichenketten

  • translated_words (int) – Anzahl der übersetzten Wörter

  • translated_words_percent (float) – Prozentsatz der übersetzten Wörter

  • translated_chars (int) – Anzahl der übersetzten Zeichen

  • translated_chars_percent (float) – Prozentsatz der übersetzten Zeichen

  • fuzzy (int) – Anzahl der ungenauen (zur Bearbeitung markierten) Zeichenketten

  • fuzzy_percent (float) – Prozentsatz der ungenauen (zur Bearbeitung markierten) Zeichenketten

  • failing (int) – Anzahl der fehlgeschlagenen Qualitätsprüfungen

  • failing_percent (float) – Prozentsatz der fehlgeschlagenen Qualitätsprüfungen

  • approved (int) – Anzahl der genehmigten Qualitätsprüfungen

  • approved_percent (float) – Prozentsatz der genehmigten Zeichenketten

  • readonly (int) – Anzahl der schreibgeschützten Zeichenketten

  • readonly_percent (float) – Prozentsatz der schreibgeschützten Zeichenketten

  • suggestions (int) – Anzahl der Zeichenketten mit Übersetzungsvorschlägen

  • comments (int) – Anzahl der Zeichenketten mit Kommentaren

  • name (string) – Objektname

  • url (string) – URL für den Zugriff auf das Objekt (falls zutreffend)

  • url_translate (string) – URL für den Zugriff auf die Übersetzung (falls zutreffend)

  • code (string) – Sprachcode (falls zutreffend)

Siehe auch

GET /api/languages/(string:language)/statistics/, GET /api/projects/(string:project)/statistics/, GET /api/components/(string:project)/(string:component)/statistics/, GET /api/translations/(string:project)/(string:component)/(string:language)/statistics/

Metriken#

GET /api/metrics/#

Gibt Server-Metriken zurück.

JSON-Objekt-Antwort:

  • units (int) – Anzahl der Einheiten

  • units_translated (int) – Anzahl der übersetzten Einheiten

  • users (int) – Anzahl der Benutzer

  • changes (int) – Anzahl der Änderungen

  • projects (int) – Anzahl der Projekte

  • components (int) – Anzahl der Komponenten

  • translations (int) – Anzahl der Übersetzungen

  • languages (int) – Anzahl der verwendeten Sprachen

  • checks (int) – Anzahl der ausgelösten Qualitätsprüfungen

  • configuration_errors (int) – Anzahl der Konfigurationsfehler

  • suggestions (int) – Anzahl der ausstehenden Übersetzungsvorschläge

  • celery_queues (object) – Längen der Celery-Warteschlangen, siehe Hintergrundaufgaben mit Celery

  • name (string) – Konfigurierter Servername

Kategorien#

GET /api/categories/#

Neu in Version 5.0.

Listet die verfügbaren Kategorien auf. Siehe GET /api/categories/(int:id)/ für Felddefinitionen.

POST /api/categories/#

Neu in Version 5.0.

Erzeugt eine neue Kategorie. Siehe GET /api/categories/(int:id)/ für Felddefinitionen.

GET /api/categories/(int: id)/#

Neu in Version 5.0.

Parameter:

  • id (int) – Kategorie-ID

JSON-Objekt-Antwort:

  • name (str) – Name der Kategorie.

  • slug (str) – Slug der Kategorie.

  • project (str) – Link zu einem Projekt.

  • category (str) – Link zu einer übergeordneten Kategorie.

PATCH /api/categories/(int: id)/#

Neu in Version 5.0: Bearbeitet Teilinformationen zur Kategorie.

Parameter-ID:

Kategorie-ID

Typ-ID:

Int

>JSON-Objekt-Konfiguration:

Optionale Konfiguration der Kategorie

PUT /api/categories/(int: id)/#

Neu in Version 5.0: Bearbeitet alle Informationen zur Kategorie.

Parameter-ID:

Kategorie-ID

Typ-ID:

Int

>JSON-Objekt-Konfiguration:

Optionale Konfiguration der Kategorie

DELETE /api/categories/(int: id)/#

Neu in Version 5.0: Löscht die Kategorie.

Parameter-ID:

Kategorie-ID

Typ-ID:

Int

Benachrichtigungs-Hooks#

Benachrichtigungs-Hooks ermöglichen es externen Anwendungen, Weblate zu benachrichtigen, dass das VCS-Repository aktualisiert wurde.

Sie können Repository-Endpunkte für Projekte, Komponenten und Übersetzungen verwenden, um einzelne Repositorys zu aktualisieren; siehe POST /api/projects/(string:project)/repository/ für die Dokumentation.

GET /hooks/update/(string: project)/(string: component)/#

Veraltet ab Version 2.6: Bitte verwenden Sie stattdessen POST /api/components/(string:project)/(string:component)/repository/, das mit der Authentifizierung für ACL-begrenzte Projekte korrekt funktioniert.

Löst die Aktualisierung einer Komponente aus (Abruf aus dem VCS und Scannen nach Übersetzungsänderungen).

GET /hooks/update/(string: project)/#

Veraltet ab Version 2.6: Bitte verwenden Sie stattdessen POST /api/projects/(string:project)/repository/, das mit der Authentifizierung für ACL-begrenzte Projekte korrekt funktioniert.

Löst die Aktualisierung aller Komponenten in einem Projekt aus (Abruf aus dem VCS und Scannen nach Übersetzungsänderungen).

POST /hooks/github/#

Spezieller Hook für die Behandlung von GitHub-Benachrichtigungen und die automatische Aktualisierung passender Komponenten.

Bemerkung

GitHub bietet direkte Unterstützung für die Benachrichtigung von Weblate: Aktivieren Sie den Weblate-Service-Hook in den Repository-Einstellungen und setzen Sie die URL auf die URL Ihrer Weblate-Installation.

Siehe auch

Automatisches Empfangen von Änderungen von GitHub

Für Anweisungen zur Einrichtung der GitHub-Integration

https://docs.github.com/en/get-started/customizing-your-github-workflow/exploring-integrations/about-webhooks

Allgemeine Informationen zu GitHub-Webhooks

ENABLE_HOOKS

Zum Aktivieren von Hooks für das gesamte Weblate

POST /hooks/gitlab/#

Spezieller Hook für die Behandlung von GitLab-Benachrichtigungen und die automatische Aktualisierung passender Komponenten.

Siehe auch

Automatischer Empfang von Änderungen von GitLab

Für Anweisungen zur Einrichtung der GitLab-Integration

https://docs.gitlab.com/ee/user/project/integrations/webhooks.html

Allgemeine Informationen zu GitLab-Webhooks

ENABLE_HOOKS

Zum Aktivieren von Hooks für das gesamte Weblate

POST /hooks/bitbucket/#

Spezieller Hook für die Behandlung von Bitbucket-Benachrichtigungen und die automatische Aktualisierung passender Komponenten.

Siehe auch

Automatischer Empfang von Änderungen von Bitbucket

Für Anweisungen zur Einrichtung der Bitbucket-Integration

https://support.atlassian.com/bitbucket-cloud/docs/manage-webhooks/

Allgemeine Informationen zu Bitbucket-Webhooks

ENABLE_HOOKS

Zum Aktivieren von Hooks für das gesamte Weblate

POST /hooks/pagure/#

Spezieller Hook für die Behandlung von Pagure-Benachrichtigungen und die automatische Aktualisierung passender Komponenten.

Siehe auch

Automatischer Empfang von Änderungen von Pagure

Für Anweisungen zur Einrichtung der Pagure-Integration

https://docs.pagure.org/pagure/usage/using_webhooks.html

Allgemeine Informationen zu Pagure-Webhooks

ENABLE_HOOKS

Zum Aktivieren von Hooks für das gesamte Weblate

POST /hooks/azure/#

Spezieller Hook für die Behandlung von Azure-DevOps-Benachrichtigungen und die automatische Aktualisierung passender Komponenten.

Bemerkung

Bitte stellen Sie sicher, dass Resource details to send auf Alle gesetzt ist, da Weblate sonst nicht in der Lage ist, Ihr Azure-Repository zu finden.

Siehe auch

Automatischer Empfang von Änderungen von Azure Repos

Für Anweisungen zur Einrichtung der Azure-Integration

https://learn.microsoft.com/en-us/azure/devops/service-hooks/services/webhooks?view=azure-devops

Allgemeine Informationen zu Azure-DevOps-Webhooks

ENABLE_HOOKS

Zum Aktivieren von Hooks für das gesamte Weblate

POST /hooks/gitea/#

Spezieller Hook für die Behandlung von Gitea-Webhook-Benachrichtigungen und die automatische Aktualisierung passender Komponenten.

Siehe auch

Automatischer Empfang von Änderungen von Gitea Repos

Für Anweisungen zur Einrichtung der Gitea-Integration

https://docs.gitea.io/en-us/webhooks/

Allgemeine Informationen zu Gitea-Webhooks

ENABLE_HOOKS

Zum Aktivieren von Hooks für das gesamte Weblate

POST /hooks/gitee/#

Spezieller Hook für die Behandlung von Gitee-Webhook-Benachrichtigungen und die automatische Aktualisierung passender Komponenten.

Siehe auch

Automatischer Empfang von Änderungen von Gitee Repos

Für Anweisungen zur Einrichtung der Gitee-Integration

https://gitee.com/help/categories/40

Allgemeine Informationen zu Gitee-Webhooks

ENABLE_HOOKS

Zum Aktivieren von Hooks für das gesamte Weblate

Exporte#

Weblate bietet verschiedene Exportmöglichkeiten, mit denen Sie die Daten weiterverarbeiten können.

GET /exports/stats/(string: project)/(string: component)/#
Abfrageparameter:

  • format (string) – Ausgabeformat: entweder json oder csv

Veraltet ab Version 2.6: Bitte verwenden Sie stattdessen GET /api/components/(string:project)/(string:component)/statistics/ und GET /api/translations/(string:project)/(string:component)/(string:language)/statistics/; dies ermöglicht auch den Zugriff auf ACL-gesteuerte Projekte.

Ruft Statistiken für die angegebene Komponente im angegebenen Format ab.

Beispielanfrage:

GET /exports/stats/weblate/main/ HTTP/1.1
Host: example.com
Accept: application/json, text/javascript

Beispielantwort:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

[
    {
        "code": "cs",
        "failing": 0,
        "failing_percent": 0.0,
        "fuzzy": 0,
        "fuzzy_percent": 0.0,
        "last_author": "Michal Čihař",
        "last_change": "2012-03-28T15:07:38+00:00",
        "name": "Czech",
        "total": 436,
        "total_words": 15271,
        "translated": 436,
        "translated_percent": 100.0,
        "translated_words": 3201,
        "url": "http://hosted.weblate.org/engage/weblate/cs/",
        "url_translate": "http://hosted.weblate.org/projects/weblate/main/cs/"
    },
    {
        "code": "nl",
        "failing": 21,
        "failing_percent": 4.8,
        "fuzzy": 11,
        "fuzzy_percent": 2.5,
        "last_author": null,
        "last_change": null,
        "name": "Dutch",
        "total": 436,
        "total_words": 15271,
        "translated": 319,
        "translated_percent": 73.2,
        "translated_words": 3201,
        "url": "http://hosted.weblate.org/engage/weblate/nl/",
        "url_translate": "http://hosted.weblate.org/projects/weblate/main/nl/"
    },
    {
        "code": "el",
        "failing": 11,
        "failing_percent": 2.5,
        "fuzzy": 21,
        "fuzzy_percent": 4.8,
        "last_author": null,
        "last_change": null,
        "name": "Greek",
        "total": 436,
        "total_words": 15271,
        "translated": 312,
        "translated_percent": 71.6,
        "translated_words": 3201,
        "url": "http://hosted.weblate.org/engage/weblate/el/",
        "url_translate": "http://hosted.weblate.org/projects/weblate/main/el/"
    }
]

RSS-Feeds#

Änderungen an Übersetzungen werden in RSS-Feeds exportiert.

GET /exports/rss/(string: project)/(string: component)/(string: language)/#

Ruft den RSS-Feed mit den letzten Änderungen für eine Übersetzung ab.

GET /exports/rss/(string: project)/(string: component)/#

Ruft den RSS-Feed mit den letzten Änderungen für eine Komponente ab.

GET /exports/rss/(string: project)/#

Ruft den RSS-Feed mit den letzten Änderungen für ein Projekt ab.

GET /exports/rss/language/(string: language)/#

Ruft den RSS-Feed mit den letzten Änderungen für eine Sprache ab.

GET /exports/rss/#

Ruft den RSS-Feed mit den letzten Änderungen für die Weblate-Instanz ab.

Siehe auch

RSS auf Wikipedia