Weblate REST API

De API is toegankelijk via de URL /api/ en is gebaseerd op het Django REST framewerk. U kunt het direct gebruiken of met Weblate Client.

The API is also documented using OpenAPI 3.1 on the /api/schema/ URL, you can browse at /api/docs/.

Notitie

OpenAPI is beschikbaar als voorbeeld voor een mogelijkheid. De documentatie is zeer waarschijnlijk op dit moment nog niet compleet en onderworpen aan wijzigingen. Raadpleeg de documentatie hieronder voor meer gedetailleerde informatie over de API.

Authenticatie en algemene parameters

De publieke project-API is beschikbaar zonder authenticatie, hoewel niet geauthenticeerde verzoeken enorm beperkt zijn (standaard tot 100 verzoeken per dag), daarom wordt aanbevolen om authenticatie te gebruiken. De authenticatie gebruikt een token, dat u in uw profiel kunt ophalen. Gebruik het in de kop Authorization:

ANY /

Algemeen gedrag voor verzoeken voor de API, de koppen, statuscodes en parameters hier, is ook van toepassing op alle eindpunten.

Parameters voor query’s:

  • format – Indeling antwoord (overschrijft Accept). Mogelijke waarden zijn afhankelijk van de opstelling van het framewerk voor REST, standaard worden json, csv en api ondersteund. De laatste verschaft een interface voor een webbrowser voor de API.

  • page – Geeft de opgegeven pagina van gepagineerde resultaten terug (gebruik de velden next en previous in het antwoord om de navigatie te automatiseren).

  • page_size – Geeft het opgegeven aantal items per verzoek terug. De standaard is 50 en het maximum is 1000. Voor het eindpunt units is de standaard 100 met een maximum van 10.000. De standaard waarde is ook te configureren met de instelling PAGE_SIZE.

Koppen voor verzoeken:

  • Accept – het type inhoud van het antwoord is afhankelijk van de kop Accept

  • Authorization – optioneel token om te authenticeren als Authorization: Token UW-TOKEN

Koppen voor antwoord:

  • Content-Type – dit is afhankelijk van de kop Accept van het verzoek

  • Allow – lijst met toegestane methoden van HTTP voor het object

JSON-object van antwoord:

  • detail (string) – uitgebreide beschrijving van het resultaat (voor HTTP-statuscodes anders dan 200 OK)

  • count (int) – totaal aantal items voor objectlijsten

  • next (string) – URL voor volgende pagina voor objectlijsten

  • previous (string) – URL voor vorige pagina voor objectlijsten

  • results (array) – resultaten voor objectlijsten

  • url (string) – URL voor toegang tot deze bron met de API

  • web_url (string) – URL voor toegang tot deze bron met de webbrowser

Statuscodes:

Tokens voor authenticatie

Veranderd in versie 4.10: Tokens voor het bereik van het project werden geïntroduceerd in de uitgave 4.10.

Elke gebruiker heeft een persoonlijk toegangstoken dat kan worden verkregen in het gebruikersprofiel. Nieuw gegenereerde gebruikerstokens hebben het voorvoegsel wlu_.

Het is mogelijk tokens voor het bereik van het project voor toegang tot de API te maken voor alleen het opgegeven project. Deze tokens kunnen worden geïdentificeerd door het voorvoegsel wlp_.

Zie ook

Registreren en gebruikersprofiel, Per-project toegangstokens, Project toegangsbeheer

Voorbeelden authenticatie

Voorbeeld verzoek:

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

Voorbeeld antwoord:

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/"
}

Voorbeeld met CURL:

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

Voorbeelden voor doorgeven parameters

Voor de methode POST mogen de parameters worden gespecificeerd, ofwel als indiening als formulier (application/x-www-form-urlencoded) of als JSON (application/json).

Voorbeeld verzoek als formulier:

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

Voorbeeld verzoek als JSON:

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"}

Voorbeeld met CURL:

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

Voorbeeld CURL JSON:

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

Onderdelen en categorieën

Voor toegang tot een onderdeel dat is genest binnen een Categorie moet u de naam van de categorie in de URL coderen in een naam voor het onderdeel, gescheiden door een slash. Bijvoorbeeld usage, geplaatst in een categorie docs, moet worden gebruikt als docs%252Fusage. In dit geval zou de volledige URL bijvoorbeeld zijn https://example.com/api/components/hello/docs%252Fusage/repository/.

API opvraaglimieten

De verzoeken voor de API hebben een opvraaglimiet; de standaard configuratie beperkt het tot 100 verzoeken per dag voor anonieme gebruikers en tot 5000 verzoeken per uur voor geauthenticeerde gebruikers.

Opvraaglimieten kunnen worden aangepast in settings.py; bekijk Throttling in Django REST framework documentation voor meer details over hoe het te configureren.

In de Docker container kan dit worden geconfigureerd met WEBLATE_API_RATELIMIT_ANON en WEBLATE_API_RATELIMIT_USER.

De status van de opvraaglimiet wordt gerapporteerd in de volgende koppen:

X-RateLimit-Limit

Toegestane aantal uit te voeren verzoeken

X-RateLimit-Remaining

Resterende aantal uit te voeren verzoeken

X-RateLimit-Reset

Aantal seconden waarna het venster voor de limiet wordt vernieuwd

Veranderd in versie 4.1: Toegevoegde statuskoppen voor opvraaglimieten.

Zie ook

Opvraaglimiet gebruiken, Opvraaglimiet gebruiken, WEBLATE_API_RATELIMIT_ANON, WEBLATE_API_RATELIMIT_USER

Fouten antwoorden

Veranderd in versie 5.10: Antwoorden van fouten waren specifiek voor eindpunten voor deze uitgave.

Weblate antwoorden voor fouten zijn opgemaakt, gebaseerd op Error Response Format.

API beginpunt

GET /api/

Het beginpunt voor de bron van de API.

Voorbeeld verzoek:

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

Voorbeeld antwoord:

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/"
}

Gebruikers

Added in version 4.0.

GET /api/users/

Geeft een lijst met gebruikers terug als u rechten heeft om gebruikers te beheren. Indien niet, krijgt u alleen uw eigen details te zien.

Parameters voor query’s:

  • username (string) – Op te zoeken gebruikersnaam

  • id (int) – Op te zoeken ID van gebruiker

Zie ook

Objectattributen voor gebruikers zijn gedocumenteerd op GET /api/users/(str:username)/.

POST /api/users/

Maakt een nieuwe gebruiker.

Parameters:

  • username (string) – Gebruikersnaam

  • full_name (string) – Volledige naam gebruiker

  • email (string) – E-mail van gebruiker

  • is_superuser (boolean) – Is gebruiker een superuser? (optioneel)

  • is_active (boolean) – Is de gebruiker actief? (optioneel)

  • is_bot (boolean) – Is de gebruiker een bot? (optioneel) (gebruikt voor tokens in het bereik van het project)

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

Geeft informatie terug over gebruikers.

Parameters:

  • username (string) – Gebruikersnaam van gebruiker

JSON-object van antwoord:

  • username (string) – gebruikersnaam van een gebruiker

  • full_name (string) – volledige naam van een gebruiker

  • email (string) – e-mail van een gebruiker

  • is_superuser (boolean) – of de gebruiker een superuser is

  • is_active (boolean) – of de gebruiker actief is

  • is_bot (boolean) – of de gebruiker een bot is (gebruikt voor tokens in het bereik van het project)

  • date_joined (string) – datum waarop de gebruiker werd gemaakt

  • last_login (string) – datum waarop de gebruiker voor het laatst inlogde

  • groups (array) – koppeling naar gekoppelde groepen; bekijk GET /api/groups/(int:id)/

Voorbeeld JSON-gegevens:

{
    "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)/

Wijzigen van de parameters voor de gebruiker.

Parameters:

  • username (string) – Gebruikersnaam van gebruiker

JSON-object van antwoord:

  • username (string) – gebruikersnaam van een gebruiker

  • full_name (string) – volledige naam van een gebruiker

  • email (string) – e-mail van een gebruiker

  • is_superuser (boolean) – of de gebruiker een superuser is

  • is_active (boolean) – of de gebruiker actief is

  • is_bot (boolean) – of de gebruiker een bot is (gebruikt voor tokens in het bereik van het project)

  • date_joined (string) – datum waarop de gebruiker werd gemaakt

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

Wijzigen van de parameters voor de gebruiker.

Parameters:

  • username (string) – Gebruikersnaam van gebruiker

JSON-object van antwoord:

  • username (string) – gebruikersnaam van een gebruiker

  • full_name (string) – volledige naam van een gebruiker

  • email (string) – e-mail van een gebruiker

  • is_superuser (boolean) – of de gebruiker een superuser is

  • is_active (boolean) – of de gebruiker actief is

  • is_bot (boolean) – of de gebruiker een bot is (gebruikt voor tokens in het bereik van het project)

  • date_joined (string) – datum waarop de gebruiker werd gemaakt

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

Verwijdert alle informatie over de gebruiker en markeert de gebruiker als niet actief.

Parameters:

  • username (string) – Gebruikersnaam van gebruiker

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

Koppel groepen aan een gebruiker.

Parameters:

  • username (string) – Gebruikersnaam van gebruiker

Parameters voor formulieren:

  • string group_id – De unieke ID voor de groep

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

Added in version 4.13.1.

Verwijder gebruiker uit een groep.

Parameters:

  • username (string) – Gebruikersnaam van gebruiker

Parameters voor formulieren:

  • string group_id – De unieke ID voor de groep

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

Vermeld statistieken van een gebruiker.

Parameters:

  • username (string) – Gebruikersnaam van gebruiker

JSON-object van antwoord:

  • translated (int) – Aantal vertalingen door gebruiker

  • suggested (int) – Aantal suggesties door gebruiker

  • uploaded (int) – Aantal uploads door gebruiker

  • commented (int) – Aantal opmerkingen door gebruiker

  • languages (int) – Aantal talen die een gebruiker mag vertalen

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

Vermeld abonnementen van een gebruiker.

Parameters:

  • username (string) – Gebruikersnaam van gebruiker

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

Koppel abonnementen aan een gebruiker.

Parameters:

  • username (string) – Gebruikersnaam van gebruiker

Verzoek JSON-object:

  • notification (string) – Naam van de geregistreerde notificatie

  • scope (int) – Bereik van de notificatie uit de beschikbare keuzes

  • frequency (int) – Frequentie van de keuzes voor notificaties

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

Haal een abonnement op dat is gekoppeld aan een gebruiker.

Parameters:

  • username (string) – Gebruikersnaam van gebruiker

  • subscription_id (int) – ID van geregistreerde notificatie

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

Bewerk een aan een gebruiker gekoppeld abonnement.

Parameters:

  • username (string) – Gebruikersnaam van gebruiker

  • subscription_id (int) – ID van geregistreerde notificatie

Verzoek JSON-object:

  • notification (string) – Naam van de geregistreerde notificatie

  • scope (int) – Bereik van de notificatie uit de beschikbare keuzes

  • frequency (int) – Frequentie van de keuzes voor notificaties

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

Bewerk een aan een gebruiker gekoppeld abonnement.

Parameters:

  • username (string) – Gebruikersnaam van gebruiker

  • subscription_id (int) – ID van geregistreerde notificatie

Verzoek JSON-object:

  • notification (string) – Naam van de geregistreerde notificatie

  • scope (int) – Bereik van de notificatie uit de beschikbare keuzes

  • frequency (int) – Frequentie van de keuzes voor notificaties

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

Verwijder een aan een gebruiker gekoppeld abonnement.

Parameters:

  • username (string) – Gebruikersnaam van gebruiker

  • subscription_id – Naam van de geregistreerde notificatie

  • subscription_id – integer (geheel getal)

Groepen

Added in version 4.0.

GET /api/groups/

Geeft ene lijst met groepen terug als u rechten heeft om groepen te beheren. Indien niet, dan kunt u alleen de groepen zien waar de gebruiker deel van uitmaakt.

Zie ook

Objectattributen voor groepen zijn gedocumenteerd op GET /api/groups/(int:id)/.

POST /api/groups/

Maakt een nieuwe groep.

Parameters:

  • name (string) – Groepsnaam

  • project_selection (int) – Groep uit selectie van project uit opgegeven opties

  • language_selection (int) – Groep van geselecteerde talen uit opgegeven opties

  • defining_project (str) – koppeling om het project te definiëren, gebruikt voor Toegangsbeheer per project; bekijk GET /api/projects/(string:project)/

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

Geeft informatie over de groep terug.

Parameters:

  • id (int) – ID van de groep

JSON-object van antwoord:

Voorbeeld JSON-gegevens:

{
    "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)/

Wijzigt de parameters van de groep.

Parameters:

  • id (int) – ID van de groep

JSON-object van antwoord:

  • name (string) – naam van de groep

  • project_selection (int) – integer die correspondeert met de groep projecten

  • language_selection (int) – integer die correspondeert met de groep talen

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

Wijzigt de parameters van de groep.

Parameters:

  • id (int) – ID van de groep

JSON-object van antwoord:

  • name (string) – naam van de groep

  • project_selection (int) – integer die correspondeert met de groep projecten

  • language_selection (int) – integer die correspondeert met de groep talen

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

Verwijdert de groep.

Parameters:

  • id (int) – ID van de groep

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

Associeer rollen aan een groep.

Parameters:

  • id (int) – ID van de groep

Parameters voor formulieren:

  • string role_id – De unieke ID van de rol

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

Associeer onderdelen met een groep.

Parameters:

  • id (int) – ID van de groep

Parameters voor formulieren:

  • string component_id – De unieke ID van het onderdeel

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

Verwijder het onderdeel uit een groep.

Parameters:

  • id (int) – ID van de groep

  • component_id (int) – De unieke ID van het onderdeel

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

Associeer projecten met een groep.

Parameters:

  • id (int) – ID van de groep

Parameters voor formulieren:

  • string project_id – De unieke ID van het project

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

Verwijder het project uit een groep.

Parameters:

  • id (int) – ID van de groep

  • project_id (int) – De unieke ID van het project

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

Associeer talen met een groep.

Parameters:

  • id (int) – ID van de groep

Parameters voor formulieren:

  • string language_code – De unieke taalcode

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

Verwijder de taal uit een groep.

Parameters:

  • id (int) – ID van de groep

  • language_code (string) – De unieke taalcode

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

Associeer onderdelenlijsten met een groep.

Parameters:

  • id (int) – ID van de groep

Parameters voor formulieren:

  • string component_list_id – De unieke ID van de onderdelenlijst

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

Verwijder de onderdelenlijst uit een groep.

Parameters:

  • id (int) – ID van de groep

  • component_list_id (int) – De unieke ID van de onderdelenlijst

POST /api/groups/(int: id)/admins/

Added in version 5.5.

Gebruiker aan team Beheerders toevoegen.

Parameters:

  • id (int) – ID van de groep

Parameters voor formulieren:

  • string user_id – De ID van de gebruiker

DELETE /api/groups/(int: id)/admins/(int: user_id)

Added in version 5.5.

Gebruiker uit team Beheerders verwijderen.

Parameters:

  • id (int) – ID van de groep

  • user_id (integer) – De ID van de gebruiker

Rollen

GET /api/roles/

Geeft een lijst terug met alle rollen die zijn geassocieerd met een gebruiker. Als de gebruiker een superuser is, dan wordt een lijst met alle bestaande rollen teruggegeven.

Zie ook

Objectattributen voor rollen zijn gedocumenteerd op GET /api/roles/(int:id)/.

POST /api/roles/

Maakt een nieuwe rol.

Parameters:

  • name (string) – Naam rol

  • permissions (array) – Lijst met codenamen voor rechten

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

Geeft informatie terug over de rol.

Parameters:

  • id (int) – ID rol

JSON-object van antwoord:

  • name (string) – Naam rol

  • permissions (array) – lijst met codenamen voor rechten

Voorbeeld JSON-gegevens:

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

Wijzigt de parameters voor de rol.

Parameters:

  • id (int) – ID rol

JSON-object van antwoord:

  • name (string) – Naam rol

  • permissions (array) – lijst met codenamen voor rechten

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

Wijzigt de parameters voor de rol.

Parameters:

  • id (int) – ID rol

JSON-object van antwoord:

  • name (string) – Naam rol

  • permissions (array) – lijst met codenamen voor rechten

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

Verwijdert de rol.

Parameters:

  • id (int) – ID rol

Talen

GET /api/languages/

Geeft een lijst met alle talen terug.

Zie ook

Objectattributen voor talen zijn gedocumenteerd op GET /api/languages/(string:language)/.

POST /api/languages/

Maakt een nieuwe taal.

Parameters:

  • code (string) – Taalnaam

  • name (string) – Taalnaam

  • direction (string) – Leesrichting

  • population (int) – Aantal sprekers

  • plural (object) – Formule voor meervoud en aantal taal

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

Geeft informatie terug over de taal.

Parameters:

  • language (string) – Taalcode

JSON-object van antwoord:

  • code (string) – Taalcode

  • direction (string) – Leesrichting

  • plural (object) – Object van informatie over meervoud taal

  • aliases (array) – Array met aliassen voor taal

Verzoek JSON-object:

  • population (int) – Aantal sprekers

Voorbeeld JSON-gegevens:

{
    "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)/

Wijzigt de parameters van de taal.

Parameters:

  • language (string) – Taalcode

Verzoek JSON-object:

  • name (string) – Taalnaam

  • direction (string) – Leesrichting

  • population (int) – Aantal sprekers

  • plural (object) – Details meervoud voor taal

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

Wijzigt de parameters van de taal.

Parameters:

  • language (string) – Taalcode

Verzoek JSON-object:

  • name (string) – Taalnaam

  • direction (string) – Leesrichting

  • population (int) – Aantal sprekers

  • plural (object) – Details meervoud voor taal

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

Verwijdert de taal.

Parameters:

  • language (string) – Taalcode

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

Geeft statistieken terug voor een taal.

Parameters:

  • language (string) – Taalcode

Zie ook

De teruggegeven attributen worden beschreven in Statistieken.

Projecten

GET /api/projects/

Geeft een lijst met alle projecten terug.

Zie ook

Objectattributen voor projecten zijn gedocumenteerd in GET /api/projects/(string:project)/.

POST /api/projects/

Maakt een nieuw project.

Parameters:

  • name (string) – Projectnaam

  • slug (string) – Slug voor project

  • web (string) – Projectwebsite

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

Geeft informatie terug over het project.

Parameters:

  • project (string) – Project-url-slug

JSON-object van antwoord:

Voorbeeld JSON-gegevens:

{
    "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)/

Added in version 4.3.

Bewerk een project met een verzoek PATCH.

Parameters:

  • project (string) – Project-url-slug

  • component (string) – Onderdeel-url-slug

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

Added in version 4.3.

Bewerk een project met een verzoek PUT.

Parameters:

  • project (string) – Project-url-slug

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

Verwijdert een project.

Parameters:

  • project (string) – Project-url-slug

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

Geeft een lijst terug met wijzigingen in een project. Dit is in essentie een voor het bereik van het project gemaakte GET /api/changes/, die dezelfde parameters accepteert.

Parameters:

  • project (string) – Project-url-slug

JSON-object van antwoord:
GET /api/projects/(string: project)/file/

Added in version 5.5.

Downloadt alle beschikbare vertalingen, geassocieerd met het project, als een archiefbestand in de verzochte indeling en taal.

Parameters:

  • project (string) – Project-url-slug

Parameters voor query’s:

  • format (string) – De indeling voor het te gebruiken archief; Indien niet gespecificeerd is de standaard zip; Ondersteunde indelingen: zip en zip:CONVERSION waar CONVERSION een van de converteerders is die zijn vermeld in Vertalingen downloaden.

  • language_code (string) – De te downloaden taalcode; Indien niet gespecificeerd worden alle talen opgenomen.

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

Geeft informatie terug over de status van de opslagruimte van het VCS. Dit eindpunt bevat alleen een algeheel overzicht voor alle opslagruimten van het project. Gebruik voor een meer gedetailleerde status GET /api/components/(string:project)/(string:component)/repository/.

Parameters:

  • project (string) – Project-url-slug

JSON-object van antwoord:

  • needs_commit (boolean) – of er nog openstaande wijzigingen zijn die moeten worden ingediend

  • needs_merge (boolean) – of er nog wijzigingen upstream zijn die moeten worden samengevoegd

  • needs_push (boolean) – of er nog lokale wijzigingen zijn die moeten worden gepusht

Voorbeeld JSON-gegevens:

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

Voert een opgegeven bewerking uit op de opslagruimte van het VCS.

Parameters:

  • project (string) – Project-url-slug

Verzoek JSON-object:

  • operation (string) – De uit te voeren bewerking: een van push, pull, commit, reset, cleanup, file-sync, file-scan

JSON-object van antwoord:

  • result (boolean) – resultaat van de bewerking

Voorbeeld met CURL:

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

Voorbeeld verzoek als JSON:

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"}

Voorbeeld JSON antwoord:

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/

Geeft een lijst terug van vertaalonderdelen in het opgegeven project.

Parameters:

  • project (string) – Project-url-slug

JSON-object van antwoord:
POST /api/projects/(string: project)/components/

Veranderd in versie 4.3: De parameters zipfile en docfile worden nu geaccepteerd voor onderdelen zonder VCS, bekijk Lokale bestanden.

Veranderd in versie 4.6: De gekloonde opslagruimten worden nu automatisch gedeeld binnen een project met Weblate interne URL’s. Gebruik disable_autoshare om dit uit te schakelen.

Maakt vertaalonderdelen in het opgegeven project.

Hint

Gebruik Weblate interne URL’s bij het maken van meerdere onderdelen uit een enkele opslagruimte voor het VCS.

Notitie

Het meeste maken van onderdelen gebeurt op de achtergrond. Controleer het attribuut task_url van het gemaakte onderdeel en volg daar de voortgang.

Parameters:

  • project (string) – Project-url-slug

Parameters voor formulieren:

  • file zipfile – ZIP-bestand om naar Weblate te uploaden voor initialiseren van vertalingen

  • file docfile – Te vertalen document

  • boolean disable_autoshare – Schakelt automatisch delen van opslagruimte via Weblate interne URL’s uit.

Verzoek JSON-object:
JSON-object van antwoord:

JSON kan niet worden gebruikt bij het uploaden van de bestanden met de parameters zipfile en docfile. De gegevens moeten worden geüpload als multipart/form-data.

Voorbeeld CURL formulier verzoek:

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/

Voorbeeld CURL JSON verzoek:

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 verzoek om een nieuw onderdeel uit Git te maken:

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 verzoek om een nieuw onderdeel ergens anders uit te maken:

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"
}

Voorbeeld JSON antwoord:

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/

Geeft gepagineerde statistieken terug voor alle talen binnen een project.

Parameters:

  • project (string) – Project-url-slug

JSON-object van antwoord:

  • results (array) – array met objecten voor statistieken van vertalingen

  • language (string) – naam taal

  • code (string) – taalcode

  • total (int) – totaal aantal tekenreeksen

  • translated (int) – aantal vertaalde tekenreeksen

  • translated_percent (float) – percentage vertaalde tekenreeksen

  • total_words (int) – totaal aantal woorden

  • translated_words (int) – aantal vertaalde woorden

  • words_percent (float) – percentage vertaalde woorden

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

Geeft statistieken voor een project terug.

Parameters:

  • project (string) – Project-url-slug

Zie ook

De teruggegeven attributen worden beschreven in Statistieken.

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

Added in version 5.0: Geeft categorieën voor een project terug. Bekijk GET /api/categories/(int:id)/ voor velddefinities.

param project:

Project-url-slug

type project:

tekenreeks

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

Added in version 5.3: Geeft labels terug voor een project.

param project:

Project-url-slug

type project:

tekenreeks

>json int id:

ID van het label

>json string name:

Naam van het label

>json string color:

kleur van het label

POST /api/projects/(string: project)/labels/

Added in version 5.3: Maakt een label voor een project.

param project:

Project-url-slug

type project:

tekenreeks

<json string name:

Naam van het label

<json string color:

kleur van het label

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

Geeft gegevens van deelnemer voor een project terug.

Added in version 5.7.

Parameters:

  • project (string) – Project-url-slug

  • start (date) – Ondergrens ISO 8601 tijdstempel (verplicht)

  • end (date) – Bovengrens ISO 8601 tijdstempel (verplicht)

  • lang (source_language) – Op te zoeken taalcode

JSON-object van antwoord:

  • email (string) – E-mail van de nieuwe deelnemer

  • full_name (string) – Volledige naam van de deelnemer

  • change_count (string) – Aantal wijzigingen in de tijdsperiode

GET /api/projects/{string:project}/machinery_settings/

Added in version 5.9.

Geeft instellingen voor automatische suggesties voor een project terug, bestaande uit de configuraties die zijn gedefinieerd voor elke geïnstalleerde vertaalservice.

Parameters:

  • project (string) – Project-url-slug

JSON-object van antwoord:

  • suggestion_settings (object) – Configuratie voor alle geïnstalleerde services.

POST /api/projects/{string:project}/machinery_settings/

Added in version 5.9.

De configuratie voor een service voor een project maken of bijwerken.

Parameters:

  • project (string) – Project-url-slug

Parameters voor formulieren:

  • string service – Naam service

  • string configuration – Configuratie service in JSON

Onderdelen

Hint

Gebruik POST /api/projects/(string:project)/components/ om nieuwe onderdelen te maken.

GET /api/components/

Geeft een lijst met vertaalonderdelen terug.

Zie ook

Objectattributen voor onderdelen zijn gedocumenteerd in GET /api/components/(string:project)/(string:component)/.

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

Geeft informatie terug over het vertaalonderdeel.

Parameters:

  • project (string) – Project-url-slug

  • component (string) – Onderdeel-url-slug

JSON-object van antwoord:

Voorbeeld JSON-gegevens:

{
    "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)/

Bewerk een onderdeel met een verzoek PATCH.

Parameters:

  • project (string) – Project-url-slug

  • component (string) – Onderdeel-url-slug

  • source_language (string) – Project brontaalcode (optioneel)

Verzoek JSON-object:

  • name (string) – naam van het onderdeel

  • slug (string) – slug van het onderdeel

  • repo (string) – URL opslagruimte van het VCS

Voorbeeld met CURL:

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

Voorbeeld verzoek als JSON:

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"
}

Voorbeeld JSON antwoord:

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)/

Bewerk een onderdeel met een verzoek PUT.

Parameters:

  • project (string) – Project-url-slug

  • component (string) – Onderdeel-url-slug

Verzoek JSON-object:

  • branch (string) – Tak opslagruimte van het VCS

  • file_format (string) – bestandsindeling van vertalingen

  • filemask (string) – masker voor vertaalbestanden in de opslagruimte

  • name (string) – naam van het onderdeel

  • slug (string) – slug van het onderdeel

  • repo (string) – URL opslagruimte van het VCS

  • template (string) – basisbestand voor eentalige vertalingen

  • new_base (string) – basisbestand voor het toevoegen van nieuwe vertalingen

  • vcs (string) – versiebeheersysteem (VCS)

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

Verwijdert een onderdeel.

Parameters:

  • project (string) – Project-url-slug

  • component (string) – Onderdeel-url-slug

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

Geeft een lijst met wijzigingen in het onderdeel terug. Dit is in essentie een voor het bereik van het onderdeel gemaakte GET /api/changes/ die dezelfde parameters accepteert.

Parameters:

  • project (string) – Project-url-slug

  • component (string) – Onderdeel-url-slug

JSON-object van antwoord:
GET /api/components/(string: project)/(string: component)/file/

Added in version 4.9.

Downloadt alle beschikbare vertalingen, geassocieerd met het onderdeel, als een archiefbestand in de verzochte indeling.

Parameters:

  • project (string) – Project-url-slug

  • component (string) – Onderdeel-url-slug

Parameters voor query’s:

  • format (string) – De indeling voor het te gebruiken archief; Indien niet gespecificeerd is de standaard zip; Ondersteunde indelingen: zip en zip:CONVERSION waar CONVERSION een van de converteerders is die zijn vermeld in Vertalingen downloaden.

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

Geeft een lijst met schermafdrukken voor het onderdeel terug.

Parameters:

  • project (string) – Project-url-slug

  • component (string) – Onderdeel-url-slug

JSON-object van antwoord:
GET /api/components/(string: project)/(string: component)/lock/

Geeft de status van de vergrendeling van het onderdeel terug.

Parameters:

  • project (string) – Project-url-slug

  • component (string) – Onderdeel-url-slug

JSON-object van antwoord:

  • locked (boolean) – of het onderdeel is vergrendeld voor bijwerken

Voorbeeld JSON-gegevens:

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

Stelt de status voor vergrendelen van het onderdeel in.

Antwoord is hetzelfde als GET /api/components/(string:project)/(string:component)/lock/.

Parameters:

  • project (string) – Project-url-slug

  • component (string) – Onderdeel-url-slug

Verzoek JSON-object:

  • lock – Booleaanse waarde om te vergrendelen of niet.

Voorbeeld met CURL:

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

Voorbeeld verzoek als JSON:

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}

Voorbeeld JSON antwoord:

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/

Geeft informatie terug over de status van de opslagruimte van het VCS.

Het antwoord is hetzelfde als voor GET /api/projects/(string:project)/repository/.

Parameters:

  • project (string) – Project-url-slug

  • component (string) – Onderdeel-url-slug

JSON-object van antwoord:

  • needs_commit (boolean) – of er nog openstaande wijzigingen zijn die moeten worden ingediend

  • needs_merge (boolean) – of er nog wijzigingen upstream zijn die moeten worden samengevoegd

  • needs_push (boolean) – of er nog lokale wijzigingen zijn die moeten worden gepusht

  • remote_commit (string) – Informatie over indiening op afstand

  • status (string) – Status opslagruimte VCS, zoals gerapporteerd door het VCS

  • merge_failure – Tekst die mislukkingen bij samenvoegen beschrijft of null als er geen is

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

Voert de opgegeven bewerking uit op een opslagruimte van het VCS.

Bekijk POST /api/projects/(string:project)/repository/ voor documentatie.

Parameters:

  • project (string) – Project-url-slug

  • component (string) – Onderdeel-url-slug

Verzoek JSON-object:

  • operation (string) – Uit te voeren bewerking: een van push, pull, commit, reset, cleanup

JSON-object van antwoord:

  • result (boolean) – resultaat van de bewerking

Voorbeeld met CURL:

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

Voorbeeld verzoek als JSON:

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"}

Voorbeeld JSON antwoord:

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/

Downloadt basisbestand voor eentalige vertalingen.

Parameters:

  • project (string) – Project-url-slug

  • component (string) – Onderdeel-url-slug

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

Downloadt sjabloonbestand voor nieuwe vertalingen.

Parameters:

  • project (string) – Project-url-slug

  • component (string) – Onderdeel-url-slug

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

Geeft een lijst met vertaalobjecten in het opgegeven onderdeel terug.

Parameters:

  • project (string) – Project-url-slug

  • component (string) – Onderdeel-url-slug

JSON-object van antwoord:
POST /api/components/(string: project)/(string: component)/translations/

Maakt een nieuwe vertaling in het opgegeven onderdeel.

Parameters:

  • project (string) – Project-url-slug

  • component (string) – Onderdeel-url-slug

Verzoek JSON-object:
JSON-object van antwoord:

  • result (object) – nieuw gemaakte vertaalobject

Voorbeeld met CURL:

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

Voorbeeld verzoek als JSON:

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"}

Voorbeeld JSON antwoord:

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/

Geeft gepagineerde statistieken terug voor alle vertalingen in het onderdeel.

Parameters:

  • project (string) – Project-url-slug

  • component (string) – Onderdeel-url-slug

Zie ook

De teruggegeven attributen worden beschreven in Statistieken.

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

Geeft projecten terug die zijn gekoppeld aan een onderdeel.

Added in version 4.5.

Parameters:

  • project (string) – Project-url-slug

  • component (string) – Onderdeel-url-slug

JSON-object van antwoord:
POST /api/components/(string: project)/(string: component)/links/

Koppel een project aan een onderdeel.

Added in version 4.5.

Parameters:

  • project (string) – Project-url-slug

  • component (string) – Onderdeel-url-slug

Parameters voor formulieren:

  • string project_slug – Slug voor project

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

Verwijder de koppeling van een project met een onderdeel.

Added in version 4.5.

Parameters:

  • project (string) – Project-url-slug

  • component (string) – Onderdeel-url-slug

  • project_slug (string) – Slug van het project die verwijderd moet worden

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

Geeft gegevens van deelnemer voor een project terug.

Added in version 5.7.

Parameters:

  • project (string) – Project-url-slug

  • start (date) – Ondergrens ISO 8601 tijdstempel (verplicht)

  • end (date) – Bovengrens ISO 8601 tijdstempel (verplicht)

  • lang (source_language) – Op te zoeken taalcode

JSON-object van antwoord:

  • email (string) – E-mail van de nieuwe deelnemer

  • full_name (string) – Volledige naam van de deelnemer

  • change_count (string) – Aantal wijzigingen in de tijdsperiode

Vertalingen

GET /api/translations/

Geeft een lijst met vertalingen terug.

Zie ook

Objectattributen voor vertalingen zijn gedocumenteerd in GET /api/translations/(string:project)/(string:component)/(string:language)/.

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

Geeft informatie terug over de vertaling.

Parameters:

  • project (string) – Project-url-slug

  • component (string) – Onderdeel-url-slug

  • language (string) – Taalcode vertaling

JSON-object van antwoord:

Voorbeeld JSON-gegevens:

{
    "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)/

Verwijdert een vertaling.

Parameters:

  • project (string) – Project-url-slug

  • component (string) – Onderdeel-url-slug

  • language (string) – Taalcode vertaling

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

Geeft een lijst met wijzigingen in de vertaling terug. Dit is in essentie een voor het bereik van de vertaling gemaakte GET /api/changes/ die dezelfde parameters accepteert.

Parameters:

  • project (string) – Project-url-slug

  • component (string) – Onderdeel-url-slug

  • language (string) – Taalcode vertaling

JSON-object van antwoord:
GET /api/translations/(string: project)/(string: component)/(string: language)/units/

Geeft een lijst met vertaaleenheden terug.

Parameters:

  • project (string) – Project-url-slug

  • component (string) – Onderdeel-url-slug

  • language (string) – Taalcode vertaling

  • q (string) – Tekenreeks zoekquery Zoeken (optioneel)

JSON-object van antwoord:
POST /api/translations/(string: project)/(string: component)/(string: language)/units/

Nieuwe eenheid toevoegen.

Parameters:

  • project (string) – Project-url-slug

  • component (string) – Onderdeel-url-slug

  • language (string) – Taalcode vertaling

Verzoek JSON-object:

  • key (string) – Eentalige vertalingen: Sleutel van vertaaleenheid

  • value (array) – Eentalige vertalingen: Brontekenreeksen (gebruik een enkele tekenreeks bij het niet maken van meervouden)

  • context (string) – Tweetalige vertalingen: Context van een vertaaleenheid

  • source (array) – Tweetalige vertalingen: Brontekenreeksen (gebruik enkele tekenreeks bij niet maken van meervouden)

  • target (array) – Tweetalige vertalingen: Doeltekenreeksen (gebruik enkele tekenreeks bij niet maken van meervouden)

  • state (int) – Status tekenreeks; bekijk GET /api/units/(int:id)/

JSON-object van antwoord:

Zie ook

Tekenreeksen beheren, Nieuwe tekenreeksen toevoegen

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

Automatisch vertalen activeren.

Parameters:

  • project (string) – Project-url-slug

  • component (string) – Onderdeel-url-slug

  • language (string) – Taalcode vertaling

Verzoek JSON-object:

  • mode (string) – Automatische vertaalmodus

  • filter_type (string) – Type filter automatisch vertalen

  • auto_source (string) – Bron van automatische vertaling - mt of others

  • component (string) – Schakel bijdragen aan het gedeeld vertaalgeheugen in om toegang te krijgen tot aanvullende onderdelen.

  • engines (array) – Programma’s voor machinevertaling

  • threshold (string) – Drempelwaarde van score

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

Download het huidige vertaalbestand zoals dat is opgeslagen in het VCS (zonder de parameter format) of geconverteerd naar een andere indeling (bekijk Vertalingen downloaden).

Notitie

Dit API-eindpunt gebruikt verschillende logica voor uitvoer dan de rest van de API, omdat het op een geheel bestand werkt in plaats van op gegevens. Set voor geaccepteerde parameter format verschilt en zonder een dergelijke parameter krijgt u het vertaalbestand zoals dat is opgeslagen in het VCS.

Koppen voor antwoord:

  • Last-Modified – Tijdstempel van laatste wijziging aan dit bestand.

Koppen voor verzoeken:

  • If-Modified-Since – Slaat antwoord over als het bestand sinds die tijd niet is aangepast.

Parameters voor query’s:

  • format – Te gebruiken bestandsindeling; indien niet gespecificeerd wordt geen conversie voor de indeling uitgevoerd; bekijk Vertalingen downloaden voor ondersteunde indelingen

  • q (string) – Filter gedownloade tekenreeksen, bekijk Zoekpagina, alleen van toepassing als conversie wordt uitgevoerd (format is gespecificeerd).

Parameters:

  • project (string) – Project-url-slug

  • component (string) – Onderdeel-url-slug

  • language (string) – Taalcode vertaling

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

Nieuw bestand met vertalingen uploaden.

Parameters:

  • project (string) – Project-url-slug

  • component (string) – Onderdeel-url-slug

  • language (string) – Taalcode vertaling

Parameters voor formulieren:

  • string conflicts – Hoe conflicten af te handelen (ignore, replace-translated of replace-approved), bekijk Afhandelen van conflicten

  • file file – Geüpload bestand

  • string email – E-mailadres van auteur

  • string author – Naam van auteur

  • string method – Methode voor uploaden (translate, approve, suggest, fuzzy, replace, source, add), bekijk Methoden voor importeren

  • string fuzzy – Verwerken fuzzy tekenreeksen (gemarkeerd om te bewerken) (empty, process, approve)

Voorbeeld met CURL:

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/

Geeft informatie terug over de status van de opslagruimte van het VCS.

Het antwoord is hetzelfde als voor GET /api/components/(string:project)/(string:component)/repository/.

Parameters:

  • project (string) – Project-url-slug

  • component (string) – Onderdeel-url-slug

  • language (string) – Taalcode vertaling

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

Voert een opgegeven bewerking uit op de opslagruimte van het VCS.

Bekijk POST /api/projects/(string:project)/repository/ voor documentatie.

Parameters:

  • project (string) – Project-url-slug

  • component (string) – Onderdeel-url-slug

  • language (string) – Taalcode vertaling

Verzoek JSON-object:

  • operation (string) – Uit te voeren bewerking: een van push, pull, commit, reset, cleanup

JSON-object van antwoord:

  • result (boolean) – resultaat van de bewerking

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

Geeft gedetailleerde statistieken voor vertalingen terug.

Parameters:

  • project (string) – Project-url-slug

  • component (string) – Onderdeel-url-slug

  • language (string) – Taalcode vertaling

Zie ook

De teruggegeven attributen worden beschreven in Statistieken.

Geheugen

Added in version 4.14.

GET /api/memory/

Geeft een lijst met resultaten uit het geheugen terug.

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

Verwijdert een geheugenobject

Parameters:

  • memory_object_id – ID geheugenobject

Eenheden

Een eenheid is een enkel stukje vertaling die een brontekenreeks koppelt aan een corresponderende vertaalde tekenreeks en ook enige gerelateerde metadata bevat. De term is afgeleid van de translate.storage.base.TranslationUnit in Translate Toolkit en XLIFF.

GET /api/units/

Geeft een lijst met vertaaleenheden terug.

Parameters:

  • q (string) – Tekenreeks zoekquery Zoeken (optioneel)

Zie ook

Objectattributen voor eenheden zijn gedocumenteerd in GET /api/units/(int:id)/.

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

Veranderd in versie 4.3: De target en source zijn nu arrays om op de juiste manier tekenreeksen voor meervoud af te handelen.

Veranderd in versie 5.6: Het attribuut last_updated wordt nu weergegeven.

Geeft informatie terug over de vertaaleenheid.

Parameters:

  • id (int) – ID eenheid

JSON-object van antwoord:

  • translation (string) – URL van een gerelateerd vertaalobject

  • source (array) – brontekenreeks

  • previous_source (string) – vorige brontekenreeks gebruikt voor fuzzy overeenkomsten

  • target (array) – doeltekenreeks

  • id_hash (string) – unieke identificatie voor de eenheid

  • content_hash (string) – unieke identificatie voor de tekenreeks

  • location (string) – locatie van de eenheid in de broncode

  • context (string) – context vertaaleenheid

  • note (string) – opmerking vertaaleenheid

  • flags (string) – vlaggen vertaaleenheid

  • labels (array) – labels vertaaleenheid, beschikbaar voor broneenheden

  • state (int) – status eenheid, 0 - niet vertaald, 10 - bewerken nodig, 20 - vertaald, 30 - goedgekeurd, 100 - alleen-lezen

  • fuzzy (boolean) – of de eenheid fuzzy is of gemarkeerd om na te kijken

  • translated (boolean) – of de eenheid is vertaald

  • approved (boolean) – of de vertaling is goedgekeurd

  • position (int) – positie eenheid in vertaalbestand

  • has_suggestion (boolean) – of de eenheid suggesties heeft

  • has_comment (boolean) – of de eenheid opmerkingen heeft

  • has_failing_check (boolean) – of de eenheid mislukte controles heeft

  • num_words (int) – aantal bronwoorden

  • priority (int) – prioriteit vertaling; 100 is standaard

  • id (int) – identificatie eenheid

  • explanation (string) – Uitleg tekenreeks, beschikbaar voor broneenheden, bekijk Aanvullende informatie over brontekenreeksen

  • extra_flags (string) – Aanvullende vlaggen voor tekenreeksen, beschikbaar voor broneenheden, bekijk Gedrag aanpassen met vlaggen

  • web_url (string) – URL waar de eenheid kan worden bewerkt

  • source_unit (string) – Koppeling naar broneenheid; bekijk GET /api/units/(int:id)/

  • pending (boolean) – of de eenheid openstaand is om te worden geschreven

  • timestamp (timestamp) – ouderdom tekenreeks

  • last_updated (timestamp) – laatste bijwerking tekenreeks

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

Added in version 4.3.

Voert gedeeltelijk bijwerken van een vertaaleenheid uit.

Parameters:

  • id (int) – ID eenheid

Verzoek JSON-object:

  • state (int) – status eenheid, 0 - niet vertaald, 10 - bewerken nodig, 20 - vertaald, 30 - goedgekeurd (werkstroom Beoordelen nodig ingeschakeld, bekijk Aangewezen beoordelaars)

  • target (array) – doeltekenreeks

  • explanation (string) – Uitleg tekenreeks, beschikbaar voor broneenheden, bekijk Aanvullende informatie over brontekenreeksen

  • extra_flags (string) – Aanvullende vlaggen voor tekenreeksen, beschikbaar voor broneenheden, bekijk Gedrag aanpassen met vlaggen

  • labels (array) – labels, beschikbaar voor broneenheden

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

Added in version 4.3.

Voert volledig bijwerken van een vertaaleenheid uit.

Parameters:

  • id (int) – ID eenheid

Verzoek JSON-object:

  • state (int) – status eenheid, 0 - niet vertaald, 10 - bewerken nodig, 20 - vertaald, 30 - goedgekeurd (werkstroom Beoordelen nodig ingeschakeld, bekijk Aangewezen beoordelaars)

  • target (array) – doeltekenreeks

  • explanation (string) – Uitleg tekenreeks, beschikbaar voor broneenheden, bekijk Aanvullende informatie over brontekenreeksen

  • extra_flags (string) – Aanvullende vlaggen voor tekenreeksen, beschikbaar voor broneenheden, bekijk Gedrag aanpassen met vlaggen

  • labels (array) – labels, beschikbaar voor broneenheden

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

Added in version 4.3.

Verwijdert een vertaaleenheid.

Parameters:

  • id (int) – ID eenheid

Wijzigingen

GET /api/changes/

Veranderd in versie 4.1: Filteren van wijzigingen werd geïntroduceerd in de uitgave 4.1.

Geeft een lijst met wijzigingen in de vertaling terug.

Zie ook

Objectattributen voor wijzigingen zijn gedocumenteerd in GET /api/changes/(int:id)/.

Parameters voor query’s:

  • user (string) – Gebruikersnaam van te filteren gebruiker

  • action (int) – Actie waarop gefilterd moet worden, mag meerdere keren gebruikt worden

  • timestamp_after (timestamp) – Tijdstempel in opmaak ISO 8601 voor vermelden van wijzigingen na

  • timestamp_before (timestamp) – Tijdstempel in opmaak ISO 8601 voor vermelden van wijzigingen voor

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

Geeft informatie terug over de wijziging in de vertaling.

Parameters:

  • id (int) – ID wijziging

JSON-object van antwoord:

  • unit (string) – URL van een gerelateerd object eenheid

  • translation (string) – URL van een gerelateerd vertaalobject

  • component (string) – URL van een gerelateerd object onderdeel

  • user (string) – URL van een gerelateerd object gebruiker

  • author (string) – URL van een gerelateerd object auteur

  • timestamp (timestamp) – tijdstempel gebeurtenis

  • action (int) – numerieke identificatie van actie

  • action_name (string) – tekstbeschrijving van actie

  • target (string) – gebeurtenis gewijzigde tekst

  • old (string) – vorige tekst

  • details (object) – aanvullende details over de wijziging

  • id (int) – identificatie wijziging

Schermafdrukken

GET /api/screenshots/

Geeft een lijst terug met informatie over ene schermafdruk van een tekenreeks.

Zie ook

Objectattributen voor schermafdrukken zijn gedocumenteerd in GET /api/screenshots/(int:id)/.

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

Geeft informatie terug over de schermafdruk.

Parameters:

  • id (int) – ID schermafdruk

JSON-object van antwoord:

  • name (string) – naam van een schermafdruk

  • component (string) – URL van een gerelateerd object onderdeel

  • file_url (string) – URL voor downloaden van een bestand; bekijk GET /api/screenshots/(int:id)/file/

  • units (array) – koppeling naar geassocieerde informatie voor de brontekenreeks; bekijk GET /api/units/(int:id)/

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

Download de afbeelding van de schermafdruk.

Parameters:

  • id (int) – ID schermafdruk

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

Vervang de afbeelding van de schermafdruk.

Parameters:

  • id (int) – ID schermafdruk

Parameters voor formulieren:

  • file image – Geüpload bestand

Voorbeeld met CURL:

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

Associeer brontekenreeks met schermafdruk.

Parameters:

  • id (int) – ID schermafdruk

Parameters voor formulieren:

  • string unit_id – ID eenheid

JSON-object van antwoord:

  • name (string) – naam van een schermafdruk

  • translation (string) – URL van een gerelateerd vertaalobject

  • file_url (string) – URL voor downloaden van een bestand; bekijk GET /api/screenshots/(int:id)/file/

  • units (array) – koppeling naar geassocieerde informatie voor de brontekenreeks; bekijk GET /api/units/(int:id)/

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

Verwijder de koppeling van de brontekenreeks met de schermafdruk.

Parameters:

  • id (int) – ID schermafdruk

  • unit_id – Brontekenreeks eenheid ID

POST /api/screenshots/

Maakt een nieuwe schermafdruk.

Parameters voor formulieren:

  • file image – Geüpload bestand

  • string name – Naam van schermafdruk

  • string project_slug – Slug voor project

  • string component_slug – Slug voor het onderdeel

  • string language_code – Taalcode

JSON-object van antwoord:

  • name (string) – naam van een schermafdruk

  • component (string) – URL van een gerelateerd object onderdeel

  • file_url (string) – URL voor downloaden van een bestand; bekijk GET /api/screenshots/(int:id)/file/

  • units (array) – koppeling naar geassocieerde informatie voor de brontekenreeks; bekijk GET /api/units/(int:id)/

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

Gedeeltelijke informatie over schermafdruk bewerken.

Parameters:

  • id (int) – ID schermafdruk

JSON-object van antwoord:

  • name (string) – naam van een schermafdruk

  • component (string) – URL van een gerelateerd object onderdeel

  • file_url (string) – URL voor downloaden van een bestand; bekijk GET /api/screenshots/(int:id)/file/

  • units (array) – koppeling naar geassocieerde informatie voor de brontekenreeks; bekijk GET /api/units/(int:id)/

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

Volledige informatie over schermafdruk bewerken.

Parameters:

  • id (int) – ID schermafdruk

JSON-object van antwoord:

  • name (string) – naam van een schermafdruk

  • component (string) – URL van een gerelateerd object onderdeel

  • file_url (string) – URL voor downloaden van een bestand; bekijk GET /api/screenshots/(int:id)/file/

  • units (array) – koppeling naar geassocieerde informatie voor de brontekenreeks; bekijk GET /api/units/(int:id)/

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

Schermafdruk verwijderen.

Parameters:

  • id (int) – ID schermafdruk

Add-ons

Added in version 4.4.1.

GET /api/addons/

Geeft een lijst met add-ons terug.

Zie ook

Objectattributen voor add-ons zijn gedocumenteerd in GET /api/addons/(int:id)/.

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

Geeft informatie over informatie van add-ons terug.

Parameters:

  • id (int) – Add-on ID

JSON-object van antwoord:

  • name (string) – naam van een add-on

  • component (string) – URL van een gerelateerd object onderdeel

  • configuration (object) – Optionele configuratie add-on

Zie ook

Add-ons

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

Maakt een nieuwe add-on.

Parameters:

  • project_slug (string) – Slug voor project

  • component_slug (string) – Slug voor het onderdeel

Verzoek JSON-object:

  • name (string) – naam van een add-on

  • configuration (object) – Optionele configuratie add-on

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

Gedeeltelijke informatie over add-on bewerken.

Parameters:

  • id (int) – Add-on ID

JSON-object van antwoord:

  • configuration (object) – Optionele configuratie add-on

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

Volledige informatie over add-on bewerken.

Parameters:

  • id (int) – Add-on ID

JSON-object van antwoord:

  • configuration (object) – Optionele configuratie add-on

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

Add-on verwijderen.

Parameters:

  • id (int) – Add-on ID

Onderdelenlijsten

Added in version 4.0.

GET /api/component-lists/

Geeft een lijst met onderdelenlijsten terug.

Zie ook

Objectattributen voor onderdelenlijsten zijn gedocumenteerd in GET /api/component-lists/(str:slug)/.

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

Geeft informatie terug over een onderdelenlijst.

Parameters:

  • slug (string) – Slug onderdelenlijst

JSON-object van antwoord:

  • name (string) – naam van een onderdelenlijst

  • slug (string) – slug van een onderdelenlijst

  • show_dashboard (boolean) – of het op een dashboard moet worden weergegeven

  • components (array) – koppeling naar geassocieerde onderdelen; bekijk GET /api/components/(string:project)/(string:component)/

  • auto_assign (array) – regels voor automatisch toewijzen

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

Wijzigt de parameters voor de onderdelenlijst.

Parameters:

  • slug (string) – Slug onderdelenlijst

Verzoek JSON-object:

  • name (string) – naam van een onderdelenlijst

  • slug (string) – slug van een onderdelenlijst

  • show_dashboard (boolean) – of het op een dashboard moet worden weergegeven

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

Wijzigt de parameters voor de onderdelenlijst.

Parameters:

  • slug (string) – Slug onderdelenlijst

Verzoek JSON-object:

  • name (string) – naam van een onderdelenlijst

  • slug (string) – slug van een onderdelenlijst

  • show_dashboard (boolean) – of het op een dashboard moet worden weergegeven

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

Verwijdert de onderdelenlijst.

Parameters:

  • slug (string) – Slug onderdelenlijst

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

Added in version 5.0.1: Vermeld onderdelen in een onderdelenlijst.

parameter slug:

Slug onderdelenlijst

type slug:

tekenreeks

formulier tekenreeks onderdeel_id:

ID onderdeel

>json array results:

array met onderdeelobjecten; bekijk GET /api/components/(string:project)/(string:component)/

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

Associeer onderdeel met een onderdelenlijst.

Parameters:

  • slug (string) – Slug onderdelenlijst

Parameters voor formulieren:

  • string component_id – ID onderdeel

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

Ontkoppel een onderdeel van een onderdelenlijst.

Parameters:

  • slug (string) – Slug onderdelenlijst

  • component_slug (string) – Slug voor het onderdeel

Woordenlijst

Veranderd in versie 4.5: Woordenlijsten worden nu opgeslagen als reguliere onderdelen, vertalingen en tekenreeksen, gebruik in plaats daarvan hun respectievelijke API.

Taken

Added in version 4.4.

GET /api/tasks/

Vermelding van de taken is momenteel niet beschikbaar.

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

Geeft informatie over een taak terug.

Parameters:

  • uuid (string) – UUID taak

JSON-object van antwoord:

  • completed (boolean) – Of de taak is voltooid

  • progress (int) – Voortgang taak in percentage

  • result (object) – Resultaat taak of detail voortgang

  • log (string) – Log van taak

Statistieken

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

Er zijn verscheidene eindpunten voor statistieken voor objecten en ze bevatten allemaal dezelfde structuur.

Parameters:

  • object (string) – Pad URL

JSON-object van antwoord:

  • total (int) – totaal aantal tekenreeksen

  • total_words (int) – totaal aantal woorden

  • total_chars (int) – totaal aantal tekens

  • last_change (timestamp) – datum laatste wijziging

  • translated (int) – aantal vertaalde tekenreeksen

  • translated_percent (float) – percentage vertaalde tekenreeksen

  • translated_words (int) – aantal vertaalde woorden

  • translated_words_percent (float) – percentage vertaalde woorden

  • translated_chars (int) – aantal vertaalde tekens

  • translated_chars_percent (float) – percentage vertaalde tekens

  • fuzzy (int) – aantal fuzzy (gemarkeerd om te bewerken) tekenreeksen

  • fuzzy_words (int) – aantal fuzzy (gemarkeerd voor bewerken) woorden

  • fuzzy_chars (int) – aantal fuzzy (gemarkeerd voor bewerken) tekens

  • fuzzy_percent (float) – percentage van fuzzy tekenreeksen (gemarkeerd voor bewerken)

  • fuzzy_words_percent (float) – percentage fuzzy (gemarkeerd voor bewerken) woorden

  • fuzzy_chars_percent (float) – percentage van fuzzy (gemarkeerd voor bewerken) tekens

  • failing (int) – aantal mislukte controles

  • failing_percent (float) – percentage mislukte controles

  • approved (int) – aantal goedgekeurde tekenreeksen

  • approved_words (int) – aantal goedgekeurde woorden

  • approved_chars (int) – aantal goedgekeurde tekens

  • approved_percent (float) – percentage goedgekeurde tekenreeksen

  • approved_words_percent (float) – percentage goedgekeurde woorden

  • approved_chars_percent (float) – percentage goedgekeurde tekens

  • readonly (int) – aantal tekenreeksen alleen-lezen

  • readonly_words (int) – aantal woorden alleen-lezen

  • readonly – aantal tekens alleen-lezen

  • readonly_percent (float) – percentage tekenreeksen alleen-lezen

  • readonly_words_percent (float) – percentage woorden alleen-lezen

  • readonly_char_percent (float) – percentage tekens alleen-lezen

  • suggestions (int) – aantal tekenreeksen met suggesties

  • comments (int) – aantal tekenreeksen met opmerkingen

  • name (string) – objectnaam

  • url (string) – URL voor toegang tot het object (indien van toepassing)

  • url_translate (string) – URL voor toegang tot vertaling (indien van toepassing)

  • code (string) – taalcode (indien van toepassing)

Zie ook

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

Metrieken

GET /api/metrics/

Geeft metrieken voor de server terug.

Veranderd in versie 5.6.1: Metrieken kunnen nu worden weergegeven in de compatibele opmaak voor OpenMetrics met ?format=openmetrics.

JSON-object van antwoord:

  • units (int) – Aantal eenheden

  • units_translated (int) – Aantal vertaalde eenheden

  • users (int) – Aantal gebruikers

  • changes (int) – Aantal aanpassingen

  • projects (int) – Aantal projecten

  • components (int) – Aantal onderdelen

  • translations (int) – Aantal vertalingen

  • languages (int) – Aantal gebruikte talen

  • checks (int) – Aantal geactiveerde kwaliteitscontroles

  • configuration_errors (int) – Aantal configuratiefouten

  • suggestions (int) – Aantal openstaande suggesties

  • celery_queues (object) – Lengten van wachtrijen voor Celery, bekijk Achtergrondtaken met Celery

  • name (string) – Geconfigureerde servernaam

Categorieën

GET /api/categories/

Added in version 5.0.

Vermeld beschikbare categorieën. Bekijk GET /api/categories/(int:id)/ voor velddefinities.

POST /api/categories/

Added in version 5.0.

Maakt een nieuwe categorie. Bekijk GET /api/categories/(int:id)/ voor velddefinities.

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

Added in version 5.0.

Parameters:

  • id (int) – ID categorie

JSON-object van antwoord:

  • name (str) – Naam van de categorie.

  • slug (str) – Slug van de categorie.

  • project (str) – Koppeling naar een project.

  • category (str) – Koppeling naar een oudercategorie.

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

Added in version 5.0: Gedeeltelijke informatie over categorie bewerken.

ID parameter:

ID categorie

type ID:

integer (geheel getal)

>json object configuration:

Optionele configuratie categorie

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

Added in version 5.0: Volledige informatie over categorie bewerken.

ID parameter:

ID categorie

type ID:

integer (geheel getal)

>json object configuration:

Optionele configuratie categorie

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

Added in version 5.0: Categorie verwijderen.

ID parameter:

ID categorie

type ID:

integer (geheel getal)

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

Added in version 5.5.

Geeft statistieken voor een categorie terug.

Parameters:

  • project (int) – ID categorie

Zie ook

De teruggegeven attributen worden beschreven in Statistieken.

Notificatie-hooks

Notificatie-hooks maken het voor externe toepassingen mogelijk Weblate in kennis te stellen dat de opslagruimte voor het VCS is bijgewerkt.

U kunt eindpunten voor projecten, onderdelen en vertalingen voor opslagruimten gebruiken om individuele opslagruimten bij te werken; bekijk POST /api/projects/(string:project)/repository/ voor documentatie.

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

Verouderd sinds versie 2.6: Gebruik in plaats daarvan POST /api/components/(string:project)/(string:component)/repository/ wat goed werkt met authenticatie voor ACL-beperkte projecten.

Activeert bijwerken van een onderdeel (ophalen uit VCS en scannen naar wijzigingen in de vertaling).

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

Verouderd sinds versie 2.6: Gebruik in plaats daarvan POST /api/projects/(string:project)/repository/ wat goed werkt met authenticatie voor ACL-beperkte projecten.

Activeert bijwerken van alle onderdelen in een project (ophalen uit VCS en scannen naar wijzigingen in de vertaling).

POST /hooks/github/

Speciale hook voor afhandeling van notificaties van GitHub en automatisch bijwerken van overeenkomende onderdelen.

Notitie

GitHub bevat directe ondersteuning voor het notificeren van Weblate: schakel de service hook voor Weblate in de instellingen voor de opslagruimte in en stel de URL in op de URL van uw installatie van Weblate.

Zie ook

Automatisch wijzigingen van GitHub ontvangen

Voor instructie voor het instellen van integratie van GitHub

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

Algemene informatie over GitHub Webhooks

ENABLE_HOOKS

Voor het inschakelen van hooks voor geheel Weblate

POST /hooks/gitlab/

Speciale hook voor afhandeling van notificaties van GitLab en automatisch bijwerken van overeenkomende onderdelen.

Zie ook

Automatisch wijzigingen van GitLab ontvangen

Voor instructie over het instellen van integratie van GitLab

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

Algemene informatie over GitLab Webhooks

ENABLE_HOOKS

Voor het inschakelen van hooks voor geheel Weblate

POST /hooks/bitbucket/

Speciale hook voor afhandeling van notificaties van Bitbucket en automatisch bijwerken van overeenkomende onderdelen.

Zie ook

Automatisch wijzigingen van Bitbucket ontvangen

Voor instructie over instellen van integratie voor Bitbucket

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

Algemene informatie over Bitbucket Webhooks

ENABLE_HOOKS

Voor het inschakelen van hooks voor geheel Weblate

POST /hooks/pagure/

Speciale hook voor afhandeling van notificaties van Pagure en automatisch bijwerken van overeenkomende onderdelen.

Zie ook

Automatisch wijzigingen van Pagure ontvangen

Voor instructie over instellen van integratie voor Pagure

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

Algemene informatie over Pagure Webhooks

ENABLE_HOOKS

Voor het inschakelen van hooks voor geheel Weblate

POST /hooks/azure/

Speciale hook voor afhandeling van notificaties van Azure DevOps en automatisch bijwerken van overeenkomende onderdelen.

Notitie

Zorg ervoor dat Resource details to send is ingesteld op All, anders zal Weblate niet in staat zijn te matchen met uw opslagruimte van Azure.

Zie ook

Automatisch wijzigingen van Azure Repos ontvangen

Voor instructie over instellen van integratie voor Azure

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

Algemene informatie over Azure DevOps Web Hooks

ENABLE_HOOKS

Voor het inschakelen van hooks voor geheel Weblate

POST /hooks/gitea/

Speciale hook voor afhandeling van notificaties van Gitea Webhook en automatisch bijwerken van overeenkomende onderdelen.

Zie ook

Automatisch wijzigingen van Gitea Repos ontvangen

Voor instructie over integratie van Gitea

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

Algemene informatie over Gitea Webhooks

ENABLE_HOOKS

Voor het inschakelen van hooks voor geheel Weblate

POST /hooks/gitee/

Speciale hook voor afhandeling van notificaties van Gitee Webhook en automatisch bijwerken van overeenkomende onderdelen.

Zie ook

Automatisch wijzigingen van Gitee Repos ontvangen

Voor instructie over instellen van integratie voor Gitee

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

Algemene informatie over Gitee Webhooks

ENABLE_HOOKS

Voor het inschakelen van hooks voor geheel Weblate

RSS-feeds

Wijzigingen in vertalingen worden geëxporteerd in RSS-feeds.

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

Haalt RSS-feed op met recente wijzigingen in een vertaling.

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

Haalt RSS-feed op met recente wijzigingen in een onderdeel.

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

Haalt RSS-feed op met recente wijzigingen in een project.

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

Haalt RSS-feed op met recente wijzigingen voor een taal.

GET /exports/rss/

Haalt RSS-feed op met recente wijzigingen voor een instantie van Weblate.

Zie ook

RSS op Wikipedia