Weblates REST API

API:et är tillgängligt på URL:en /api/ och baseras på Django REST framework. Du kan använda det direkt eller via Weblate-klient.

API:et är också dokumenterat med OpenAPI 3.1 på URL:en /api/schema/, som du kan bläddra i på /api/docs/.

Observera

OpenAPI är tillgängligt som en förhandsvisning av funktionen. Dokumentationen är sannolikt ofullständig i nuläget och kan komma att ändras. Se dokumentationen nedan för mer detaljerad information om API:et.

Autentisering och generiska parametrar

Det offentliga projekt-API:et är tillgängligt utan autentisering, men oautentiserade förfrågningar begränsas kraftigt (som standard till 100 förfrågningar per dag), så det rekommenderas att använda autentisering. Autentiseringen använder en token, som du kan hämta i din profil. Använd den i Authorization-rubriken:

ANY /

Generellt förfrågningsbeteende för API:et, rubrikerna, statuskoderna och parametrarna här gäller även för alla slutpunkter.

Parametrar i förfrågan:

  • format – Svarsformat (återkallar Accept). Möjliga värden beror på REST-ramverkets inställningar. Som standard stöds json, csv och api. Det sistnämnda tillhandahåller ett webbläsargränssnitt för API.

  • page – Returnerar given sida med paginerade resultat (använd fälten next och previous i svaret för att automatisera navigeringen).

  • page_size – Returnera det angivna antalet objekt per begäran. Standardvärdet är 50 och maximivärdet är 1000. För slutpunkterna units är standardvärdet 100 och maximivärdet 10000. Standardvärdet kan också konfigureras med inställningen PAGE_SIZE.

Begärande rubriker:

  • Accept – svarets innehållstyp beror på Accept-rubriken

  • Authorization – valfritt token för autentisering som Authorization: Token YOUR-TOKEN

Svarsrubriker:

  • Content-Type – detta beror på Accept-rubriken i begäran

  • Allow – lista över tillåtna HTTP-metoder på objekt

Svar JSON-objekt:

  • detail (string) – detaljerad beskrivning av resultatet (för andra HTTP-statuskoder än 200 OK)

  • count (int) – totalt antal objekt för objektlistor

  • next (string) – nästa sida URL för objektlistor

  • previous (string) – föregående sida URL för objektlistor

  • results (array) – resultat för objektlistor

  • url (string) – URL för att komma åt denna resurs med hjälp av API:et

  • web_url (string) – URL för att komma åt denna resurs med en webbläsare

Statuskoder:

Autentiseringstoken

Förändrat i version 4.10: Projektbegränsade tokens introducerades i version 4.10.

Varje användare har en personlig åtkomsttoken som kan erhållas i användarprofilen. Nygenserade användartoken har prefixet wlu_.

Det är möjligt att skapa projektbegränsade tokens för API-åtkomst till endast ett visst projekt. Dessa tokens kan identifieras genom prefixet wlp_.

Se även

Exempel på autentisering

Exempel på begäran:

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

Exempel på svar:

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-exempel:

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

Exempel på överföring av parametrar

För metoden POST kan parametrarna anges antingen som formulärinlämning (application/x-www-form-urlencoded) eller som JSON (application/json).

Exempel på formulärförfrågan:

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

Exempel på JSON-förfrågan:

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-exempel:

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

CURL JSON-exempel:

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

Komponenter och kategorier

För att komma åt en komponent som är inbäddad i en Kategori måste du URL-koda kategorinamnet till ett komponentnamn separerat med en snedstreck. Till exempel måste usage som placeras i kategorin docs användas som docs%252Fusage. Den fullständiga URL:en i detta fall skulle till exempel vara https://example.com/api/components/hello/docs%252Fusage/repository/.

API-hastighetsbegränsning

API-förfrågningarna är begränsade; standardkonfigurationen begränsar dem till 100 förfrågningar per dag för anonyma användare och 5000 förfrågningar per timme för autentiserade användare.

Hastighetsbegränsningen kan justeras i settings.py; se Throttling in Django REST framework documentation för mer information om hur du konfigurerar den.

I Docker-containern kan detta konfigureras med hjälp av WEBLATE_API_RATELIMIT_ANON och WEBLATE_API_RATELIMIT_USER.

Status för hastighetsbegränsning rapporteras i följande rubriker:

X-RateLimit-Limit

Tillåtet antal förfrågningar att utföra

X-RateLimit-Remaining

Återstående antal förfrågningar att utföra

X-RateLimit-Reset

Antal sekunder tills frekvensbegränsningsfönstret återställs

Förändrat i version 4.1: Lagt till statusrubriker för hastighetsbegränsning.

Se även

Felmeddelanden

Förändrat i version 5.10: Felmeddelanden var tidigare specifika för slutpunkter.

Weblate-felmeddelanden formateras enligt Error Response Format.

API-ingångspunkt

GET /api/

API-rotens ingångspunkt.

Exempel på begäran:

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

Exempel på svar:

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

Användare

Added in version 4.0.

GET /api/users/

Returnerar en lista över användare om du har behörighet att se och hantera användare. Om inte, kan du bara se dina egna uppgifter.

Parametrar i förfrågan:

  • username (string) – Användarnamn att söka efter

  • id (int) – Användar-ID att söka efter

Se även

Användarnas objektattribut dokumenteras på GET /api/users/(str:username)/.

POST /api/users/

Skapar en ny användare.

Parametrar:

  • username (string) – Användarnamn

  • full_name (string) – Användarens fullständiga namn

  • email (string) – Användarens e-post

  • is_superuser (boolean) – Är användaren superanvändare? (valfritt)

  • is_active (boolean) – Är användaren aktiv? (valfritt)

  • is_bot (boolean) – Är användaren en bot? (valfritt) (används för projektbegränsade tokens)

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

Returnerar information om användare.

Parametrar:

  • username (string) – Användarens användarnamn

Svar JSON-objekt:

  • username (string) – användarnamn för en användare

  • full_name (string) – användarens fullständiga namn

  • email (string) – användarens e-postadress

  • is_superuser (boolean) – om användaren är en superanvändare

  • is_active (boolean) – om användaren är aktiv

  • is_bot (boolean) – om användaren är en bot (används för projektbegränsade tokens)

  • date_joined (string) – datum då användaren skapades

  • last_login (string) – datum då användaren senast loggade in

  • groups (array) – länk till associerade grupper; se GET /api/groups/(int:id)/

  • languages (array) – länk till översatta språk; se GET /api/languages/(string:language)/

Exempel på JSON-data:

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

Ändrar användarparametrarna.

Parametrar:

  • username (string) – Användarens användarnamn

Svar JSON-objekt:

  • username (string) – användarnamn för en användare

  • full_name (string) – användarens fullständiga namn

  • email (string) – användarens e-postadress

  • is_superuser (boolean) – om användaren är en superanvändare

  • is_active (boolean) – om användaren är aktiv

  • is_bot (boolean) – om användaren är en bot (används för projektbegränsade tokens)

  • date_joined (string) – datum då användaren skapades

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

Ändrar användarparametrarna.

Parametrar:

  • username (string) – Användarens användarnamn

Svar JSON-objekt:

  • username (string) – användarnamn för en användare

  • full_name (string) – användarens fullständiga namn

  • email (string) – användarens e-postadress

  • is_superuser (boolean) – om användaren är en superanvändare

  • is_active (boolean) – om användaren är aktiv

  • is_bot (boolean) – om användaren är en bot (används för projektbegränsade tokens)

  • date_joined (string) – datum då användaren skapades

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

Raderar all användarinformation och markerar användaren som inaktiv.

Parametrar:

  • username (string) – Användarens användarnamn

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

Koppla grupper till en användare.

Parametrar:

  • username (string) – Användarens användarnamn

Formulärparametrar:

  • string group_id – Det unika grupp-ID:t

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

Added in version 4.13.1.

Ta bort användare från en grupp.

Parametrar:

  • username (string) – Användarens användarnamn

Formulärparametrar:

  • string group_id – Det unika grupp-ID:t

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

Lista statistik för en användare.

Parametrar:

  • username (string) – Användarens användarnamn

Svar JSON-objekt:

  • translated (int) – Antal översättningar per användare

  • suggested (int) – Antal förslag per användare

  • uploaded (int) – Antal uppladdningar per användare

  • commented (int) – Antal kommentarer per användare

  • languages (int) – Antal språk som användaren kan översätta

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

Lista översättningar med bidrag från en användare.

Parametrar:

  • username (string) – Användarens användarnamn

Svar JSON-objekt:
GET /api/users/(str: username)/notifications/

Lista prenumerationer för en användare.

Parametrar:

  • username (string) – Användarens användarnamn

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

Koppla prenumerationer till en användare.

Parametrar:

  • username (string) – Användarens användarnamn

Begär JSON-objekt:

  • notification (string) – Namn på registrerad anmälan

  • scope (int) – Omfattning av anmälan från de tillgängliga alternativen

  • frequency (int) – Val av frekvens för aviseringar

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

Hämta en prenumeration som är kopplad till en användare.

Parametrar:

  • username (string) – Användarens användarnamn

  • subscription_id (int) – ID för registrerad anmälan

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

Redigera en prenumeration som är kopplad till en användare.

Parametrar:

  • username (string) – Användarens användarnamn

  • subscription_id (int) – ID för registrerad anmälan

Begär JSON-objekt:

  • notification (string) – Namn på registrerad anmälan

  • scope (int) – Omfattning av anmälan från de tillgängliga alternativen

  • frequency (int) – Val av frekvens för aviseringar

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

Redigera en prenumeration som är kopplad till en användare.

Parametrar:

  • username (string) – Användarens användarnamn

  • subscription_id (int) – ID för registrerad anmälan

Begär JSON-objekt:

  • notification (string) – Namn på registrerad anmälan

  • scope (int) – Omfattning av anmälan från de tillgängliga alternativen

  • frequency (int) – Val av frekvens för aviseringar

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

Ta bort en prenumeration som är kopplad till en användare.

Parametrar:

  • username (string) – Användarens användarnamn

  • subscription_id – Namn på registrerad anmälan

  • subscription_id – int

Grupper

Added in version 4.0.

GET /api/groups/

Returnerar en lista över grupper om du har behörighet att se och hantera grupper. Om inte, får du endast se de grupper som användaren är medlem i.

Se även

Gruppobjektets attribut dokumenteras på GET /api/groups/(int:id)/.

POST /api/groups/

Skapar en ny grupp.

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

Returnerar information om gruppen.

Parametrar:

  • id (int) – Gruppens ID

Svar JSON-objekt:

Exempel på JSON-data:

{
    "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/"
    ],
    "admins": [
        "http://example.com/api/users/exampleusername/"
    ]
}
PUT /api/groups/(int: id)/

Ändrar gruppparametrarna.

Parametrar:

  • id (int) – Gruppens ID

Svar JSON-objekt:

  • name (string) – namn på en grupp

  • project_selection (int) – heltal som motsvarar en grupp av projekt

  • language_selection (int) – heltal som motsvarar en grupp av språk

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

Ändrar gruppparametrarna.

Parametrar:

  • id (int) – Gruppens ID

Svar JSON-objekt:

  • name (string) – namn på en grupp

  • project_selection (int) – heltal som motsvarar en grupp av projekt

  • language_selection (int) – heltal som motsvarar en grupp av språk

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

Tar bort gruppen.

Parametrar:

  • id (int) – Gruppens ID

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

Koppla roller till en grupp.

Parametrar:

  • id (int) – Gruppens ID

Formulärparametrar:

  • string role_id – Det unika roll-ID:t

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

Ta bort roll från en grupp.

Parametrar:

  • id (int) – Gruppens ID

  • role_id (int) – Det unika roll-ID:t

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

Koppla komponenter till en grupp.

Parametrar:

  • id (int) – Gruppens ID

Formulärparametrar:

  • string component_id – Det unika komponent-ID:t

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

Ta bort komponent från en grupp.

Parametrar:

  • id (int) – Gruppens ID

  • component_id (int) – Det unika komponent-ID:t

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

Koppla projekt till en grupp.

Parametrar:

  • id (int) – Gruppens ID

Formulärparametrar:

  • string project_id – Det unika projekt-ID:t

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

Ta bort projekt från en grupp.

Parametrar:

  • id (int) – Gruppens ID

  • project_id (int) – Det unika projekt-ID:t

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

Koppla språk till en grupp.

Parametrar:

  • id (int) – Gruppens ID

Formulärparametrar:

  • string language_code – Den unika språkkoden

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

Ta bort språk från en grupp.

Parametrar:

  • id (int) – Gruppens ID

  • language_code (string) – Den unika språkkoden

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

Koppla komponentlistor till en grupp.

Parametrar:

  • id (int) – Gruppens ID

Formulärparametrar:

  • string component_list_id – Det unika komponentlist-ID:t

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

Ta bort komponentlista från en grupp.

Parametrar:

  • id (int) – Gruppens ID

  • component_list_id (int) – Det unika komponentlist-ID:t

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

Added in version 5.5.

Lägg till användare till teamadministratörer.

Parametrar:

  • id (int) – Gruppens ID

Formulärparametrar:

  • string user_id – Profil-slug ”Användar-ID”

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

Added in version 5.5.

Ta bort användare från teamadministratörer.

Parametrar:

  • id (int) – Gruppens ID

  • user_id (integer) – Profil-slug ”Användar-ID”

Roller

GET /api/roles/

Returnerar en lista över alla roller som är associerade med användaren. Om användaren är superanvändare returneras en lista över alla befintliga roller.

Se även

Rollobjektets attribut dokumenteras på GET /api/roles/(int:id)/.

POST /api/roles/

Skapar en ny roll.

Parametrar:

  • name (string) – Rollnamn

  • permissions (array) – Lista över kodnamn för behörigheter

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

Returnerar information om rollen.

Parametrar:

  • id (int) – Rollens ID

Svar JSON-objekt:

  • name (string) – Rollnamn

  • permissions (array) – lista över kodnamn för behörigheter

Exempel på JSON-data:

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

Ändrar rollparametrarna.

Parametrar:

  • id (int) – Rollens ID

Svar JSON-objekt:

  • name (string) – Rollnamn

  • permissions (array) – lista över kodnamn för behörigheter

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

Ändrar rollparametrarna.

Parametrar:

  • id (int) – Rollens ID

Svar JSON-objekt:

  • name (string) – Rollnamn

  • permissions (array) – lista över kodnamn för behörigheter

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

Tar bort rollen.

Parametrar:

  • id (int) – Rollens ID

Språk

GET /api/languages/

Returnerar en lista över alla språk.

Se även

Språkobjektets attribut dokumenteras på GET /api/languages/(string:language)/.

POST /api/languages/

Skapar ett nytt språk.

Parametrar:

  • code (string) – Språknamn

  • name (string) – Språknamn

  • direction (string) – Textriktning

  • population (int) – Antal talare

  • plural (object) – Språkets pluralform och numerus

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

Returnerar information om språket.

Parametrar:

  • language (string) – Språkkod

Svar JSON-objekt:

  • code (string) – Språkkod

  • direction (string) – Textriktning

  • plural (object) – Språkets pluralinformation

  • aliases (array) – Alias för språk

Begär JSON-objekt:

  • population (int) – Antal talare

Exempel på JSON-data:

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

Ändrar språkinställningarna.

Parametrar:

  • language (string) – Språkets kod

Begär JSON-objekt:

  • name (string) – Språknamn

  • direction (string) – Textriktning

  • population (int) – Antal talare

  • plural (object) – Språk plural detaljer

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

Ändrar språkinställningarna.

Parametrar:

  • language (string) – Språkets kod

Begär JSON-objekt:

  • name (string) – Språknamn

  • direction (string) – Textriktning

  • population (int) – Antal talare

  • plural (object) – Språk plural detaljer

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

Tar bort språket.

Parametrar:

  • language (string) – Språkets kod

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

Returnerar statistik för ett språk.

Parametrar:

  • language (string) – Språkkod

Se även

Returnerade attribut beskrivs i Statistik.

Projekt

GET /api/projects/

Returnerar en lista över alla projekt.

Se även

Projektets objektattribut dokumenteras på GET /api/projects/(string:project)/.

POST /api/projects/

Skapar ett nytt projekt.

Parametrar:

  • name (string) – Projektnamn

  • slug (string) – Projektslugg

  • web (string) – Projektwebbplats

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

Returnerar information om projektet.

Parametrar:

  • project (string) – Projektets URL-slug

Svar JSON-objekt:

Exempel på JSON-data:

{
    "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.

Redigera ett projekt med en PATCH-begäran.

Parametrar:

  • project (string) – Projektets URL-slug

  • component (string) – Komponentens URL-slug

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

Added in version 4.3.

Redigera ett projekt med en PUT-begäran.

Parametrar:

  • project (string) – Projektets URL-slug

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

Tar bort ett projekt.

Parametrar:

  • project (string) – Projektets URL-slug

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

Returnerar en lista över projektändringar. Detta är i huvudsak ett projektomfattande GET /api/changes/ som accepterar samma parametrar.

Parametrar:

  • project (string) – Projektets URL-slug

Svar JSON-objekt:
GET /api/projects/(string: project)/file/

Added in version 5.5.

Hämtar alla tillgängliga översättningar som är kopplade till projektet som en arkivfil i det begärda formatet och språket.

Parametrar:

  • project (string) – Projektets URL-slug

Parametrar i förfrågan:

  • format (string) – Arkivformatet som ska användas; Om inget anges är standardinställningen zip; Format som stöds: zip och zip:CONVERSION där CONVERSION är en av de konverterare som listas under Ladda ner översättningar.

  • language_code (string) – Språkkoden som ska laddas ner. Om inget anges ingår alla språk.

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

Returnerar information om VCS-arkivets status. Denna slutpunkt innehåller endast en övergripande sammanfattning för alla arkiv för projektet. För att få mer detaljerad status, använd GET /api/components/(string:project)/(string:component)/repository/.

Parametrar:

  • project (string) – Projektets URL-slug

Svar JSON-objekt:

  • needs_commit (boolean) – om det finns några väntande ändringar att bekräfta

  • needs_merge (boolean) – om det finns några uppströmsändringar att slå samman

  • needs_push (boolean) – om det finns några lokala ändringar att genomföra

Exempel på JSON-data:

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

Utför given operation på VCS-arkivet.

Parametrar:

  • project (string) – Projektets URL-slug

Begär JSON-objekt:

  • operation (string) – Åtgärd som ska utföras: en av push, pull, commit, reset, cleanup, file-sync, file-scan

Svar JSON-objekt:

  • result (boolean) – resultatet av operationen

CURL-exempel:

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

Exempel på JSON-förfrågan:

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

Exempel på JSON-svar:

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/

Returnerar en lista över översättningskomponenter i det angivna projektet.

Parametrar:

  • project (string) – Projektets URL-slug

Svar JSON-objekt:
POST /api/projects/(string: project)/components/

Förändrat i version 4.3: Parametrarna zipfile och docfile accepteras nu för komponenter utan VCS, se Lokala filer.

Förändrat i version 4.6: De klonade arkiven delas nu automatiskt inom ett projekt med hjälp av Weblates interna URL:er. Använd disable_autoshare för att inaktivera denna funktion.

Skapar översättningskomponenter i det angivna projektet.

Råd

Använd Weblates interna URL:er när du skapar flera komponenter från ett enda VCS-arkiv.

Observera

Det mesta av komponentskapandet sker i bakgrunden. Kontrollera attributet task_url för den skapade komponenten och följ framstegen där.

Parametrar:

  • project (string) – Projektets URL-slug

Formulärparametrar:

  • file zipfile – ZIP-fil att ladda upp till Weblate för initialisering av översättningar

  • file docfile – Dokument att översätta

  • boolean disable_autoshare – Inaktiverar automatisk delning av arkiv via Weblates interna URL:er.

Begär JSON-objekt:
Svar JSON-objekt:

JSON kan inte användas när filerna laddas upp med parametrarna zipfile och docfile. Data måste laddas upp som multipart/form-data.

Exempel på CURL-formulärförfrågan:

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/

Exempel på CURL JSON-förfrågan:

curl \
    --data-binary '{
        "branch": "main",
        "file_format": "po",
        "file_format_params": {
            "po_line_wrap": 65535,
            "po_no_location": true
        },
        "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-begäran för att skapa en ny komponent från 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",
    "file_format_params": {
        "po_line_wrap": 65535,
        "po_no_location": true
    },
    "filemask": "po/*.po",
    "name": "Weblate",
    "slug": "weblate",
    "repo": "https://github.com/WeblateOrg/hello.git",
    "template": "",
    "new_base": "po/hello.pot",
    "vcs": "git"
}

JSON-begäran för att skapa en ny komponent från en annan:

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

Exempel på JSON-svar:

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",
    "file_format_params": {
        "po_line_wrap": 65535,
        "po_no_location": true
    },
    "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/

Returnerar paginerad statistik för alla språk inom ett projekt.

Parametrar:

  • project (string) – Projektets URL-slug

Svar JSON-objekt:

  • results (array) – matris med översättningsstatistikobjekt

  • language (string) – språknamn

  • code (string) – språkkod

  • total (int) – totalt antal strängar

  • translated (int) – antal översatta strängar

  • translated_percent (float) – procentandel översatta strängar

  • total_words (int) – totalt antal ord

  • translated_words (int) – antal översatta ord

  • words_percent (float) – procentandel översatta ord

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

Returnerar statistik för ett projekt.

Parametrar:

  • project (string) – Projektets URL-slug

Se även

Returnerade attribut beskrivs i Statistik.

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

Added in version 5.0: Returnerar kategorier för ett projekt. Se GET /api/categories/(int:id)/ för fältdefinitioner.

param-projekt:

Projektets URL-slug

typ av projekt:

sträng

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

Added in version 5.3: Returetiketter för ett projekt.

param-projekt:

Projektets URL-slug

typ av projekt:

sträng

>json int id:

Etikettens ID

>json string name:

etikettens namn

>json string color:

etikettens färg

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

Added in version 5.3: Skapar en etikett för ett projekt.

param-projekt:

Projektets URL-slug

typ av projekt:

sträng

<json string name:

etikettens namn

<json string color:

etikettens färg

DELETE /api/projects/(string: project)/labels/(int: label_id)/

Added in version 5.14: Tar bort en etikett från ett projekt.

param-projekt:

Projektets URL-slug

typ av projekt:

sträng

param label_id:

ID för etiketten som ska tas bort

typ label_id:

heltal

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

Returnerar bidragsgivares krediter för ett projekt.

Added in version 5.7.

Parametrar:

  • project (string) – Projektets URL-slug

  • start (date) – Nedre gräns för tidsstämpel enligt ISO 8601 (obligatoriskt)

  • end (date) – Övre gräns för ISO 8601-tidsstämpel (obligatoriskt)

  • lang (source_language) – Språkkod att söka efter

Svar JSON-objekt:

  • email (string) – E-postadress till bidragsgivaren

  • full_name (string) – Bidragsgivarens fullständiga namn

  • change_count (string) – Antal ändringar som gjorts under tidsperioden

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

Added in version 5.9.

Returnerar automatiska förslagsinställningar för ett projekt, bestående av de konfigurationer som definierats för varje installerad översättningstjänst.

Parametrar:

  • project (string) – Projektets URL-slug

Svar JSON-objekt:

  • suggestion_settings (object) – Konfiguration för alla installerade tjänster.

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

Added in version 5.9.

Skapa eller uppdatera tjänstekonfigurationen för ett projekt.

Parametrar:

  • project (string) – Projektets URL-slug

Formulärparametrar:

  • string service – Namn på service

  • string configuration – Tjänstkonfiguration i JSON

GET /api/projects/(string: project)/languages/(string: language_code)/file/

Förändrat i version 5.15.1: Lagt till möjlighet att ladda ner ZIP-fil med alla komponentöversättningar i ett projekt för ett specifikt språk.

Ladda ner en ZIP-fil med alla översättningsfiler för en angiven språkkod för alla komponenter i ett givet projekt istället för att ladda ner enskilda översatta filer och manuellt komprimera dem. Arkivet har namnet {project-slug}-{language-code}.zip och är organiserat efter komponentvägar (t.ex. component-slug/po/lang.po).

Parametrar:

  • project (string) – Projektets URL-slug

  • language_code (string) – Språkkod

Parametrar i förfrågan:

  • filter (string) – Valfri delsträng som inte är skiftlägeskänslig för att filtrera komponenter efter slug (t.ex. ?filter=core matchar komponenter med ’core’ någonstans i deras slug); endast komponenter vars slugs innehåller delsträngen kommer att inkluderas i nedladdningen.

  • format (string) – Arkivformatet som ska användas; Om inget anges är standardinställningen zip; Format som stöds: zip och zip:CONVERSION där CONVERSION är en av de konverterare som listas under Ladda ner översättningar.

Observera

Möjliga svar:

  • 200 OK med ZIP-filen med översättningar för det angivna språket för alla komponenter i projektet. Om inga komponenter har översättningar för det angivna språket returneras en tom ZIP-fil.

  • 403 Förbjudet om användaren inte har behörighet till projektet.

  • 404 Not Found om projektets slug inte finns.

Komponenter

Råd

Använd POST /api/projects/(string:project)/components/ för att skapa nya komponenter.

GET /api/components/

Returnerar en lista över översättningskomponenter.

Se även

Komponentobjektets attribut dokumenteras på GET /api/components/(string:project)/(string:component)/.

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

Returnerar information om översättningskomponenten.

Parametrar:

  • project (string) – Projektets URL-slug

  • component (string) – Komponentens URL-slug

Svar JSON-objekt:

Exempel på JSON-data:

{
    "branch": "main",
    "file_format": "po",
    "file_format_params": {
        "po_line_wrap": 65535,
        "po_no_location": true
    },
    "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)/

Redigera en komponent med en PATCH-begäran.

Parametrar:

  • project (string) – Projektets URL-slug

  • component (string) – Komponentens URL-slug

  • source_language (string) – Projektets källspråkskod (valfritt)

Begär JSON-objekt:

  • name (string) – komponentens namn

  • slug (string) – komponentbit

  • repo (string) – VCS-arkivets URL

CURL-exempel:

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

Exempel på JSON-förfrågan:

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

Exempel på JSON-svar:

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",
    "file_format_params": {
        "po_line_wrap": 65535,
        "po_no_location": true
    },
    "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)/

Redigera en komponent med en PUT-begäran.

Parametrar:

  • project (string) – Projektets URL-slug

  • component (string) – Komponentens URL-slug

Begär JSON-objekt:

  • branch (string) – VCS-arkivets gren

  • file_format (string) – filformat för översättningar

  • file_format_params (object) – parametrar relaterade till filen

  • filemask (string) – mask av översättningsfiler i arkivet

  • name (string) – komponentens namn

  • slug (string) – komponentbit

  • repo (string) – VCS-arkivets URL

  • template (string) – basfil för enspråkiga översättningar

  • new_base (string) – basfil för att lägga till nya översättningar

  • vcs (string) – versionshanteringssystem

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

Tar bort en komponent.

Parametrar:

  • project (string) – Projektets URL-slug

  • component (string) – Komponentens URL-slug

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

Returnerar en lista över komponentändringar. Detta är i huvudsak en komponent med omfattningen GET /api/changes/ som accepterar samma parametrar.

Parametrar:

  • project (string) – Projektets URL-slug

  • component (string) – Komponentens URL-slug

Svar JSON-objekt:
GET /api/components/(string: project)/(string: component)/file/

Added in version 4.9.

Hämtar alla tillgängliga översättningar som är kopplade till komponenten som en arkivfil i det begärda formatet.

Parametrar:

  • project (string) – Projektets URL-slug

  • component (string) – Komponentens URL-slug

Parametrar i förfrågan:

  • format (string) – Arkivformatet som ska användas; Om inget anges är standardinställningen zip; Format som stöds: zip och zip:CONVERSION där CONVERSION är en av de konverterare som listas under Ladda ner översättningar.

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

Returnerar en lista med skärmdumpar av komponenter.

Parametrar:

  • project (string) – Projektets URL-slug

  • component (string) – Komponentens URL-slug

Svar JSON-objekt:
GET /api/components/(string: project)/(string: component)/lock/

Returnerar komponentens låsstatus.

Parametrar:

  • project (string) – Projektets URL-slug

  • component (string) – Komponentens URL-slug

Svar JSON-objekt:

  • locked (boolean) – om komponenten är låst för uppdateringar

Exempel på JSON-data:

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

Ställer in komponentlåsstatus.

Svaret är detsamma som GET /api/components/(string:project)/(string:component)/lock/.

Parametrar:

  • project (string) – Projektets URL-slug

  • component (string) – Komponentens URL-slug

Begär JSON-objekt:

  • lock – Boolesk värde som anger om låsning ska användas eller inte.

CURL-exempel:

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

Exempel på JSON-förfrågan:

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}

Exempel på JSON-svar:

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/

Returnerar information om VCS-arkivets status.

Svaret är detsamma som för GET /api/projects/(string:project)/repository/.

Parametrar:

  • project (string) – Projektets URL-slug

  • component (string) – Komponentens URL-slug

Svar JSON-objekt:

  • needs_commit (boolean) – om det finns några väntande ändringar att bekräfta

  • needs_merge (boolean) – om det finns några uppströmsändringar att slå samman

  • needs_push (boolean) – om det finns några lokala ändringar att genomföra

  • remote_commit (string) – Information om fjärrkommit

  • status (string) – VCS-arkivstatus enligt rapportering från VCS

  • merge_failure – Text som beskriver sammanfogningsfel eller null om det inte finns något

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

Utför den angivna åtgärden på ett VCS-arkiv.

Se POST /api/projects/(string:project)/repository/ för dokumentation.

Parametrar:

  • project (string) – Projektets URL-slug

  • component (string) – Komponentens URL-slug

Begär JSON-objekt:

  • operation (string) – Åtgärd som ska utföras: en av push, pull, commit, reset, cleanup

Svar JSON-objekt:

  • result (boolean) – resultatet av operationen

CURL-exempel:

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

Exempel på JSON-förfrågan:

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

Exempel på JSON-svar:

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/

Hämtar basfilen för enspråkiga översättningar.

Parametrar:

  • project (string) – Projektets URL-slug

  • component (string) – Komponentens URL-slug

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

Hämtar mallfil för nya översättningar.

Parametrar:

  • project (string) – Projektets URL-slug

  • component (string) – Komponentens URL-slug

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

Returnerar en lista över översättningsobjekt i den angivna komponenten.

Parametrar:

  • project (string) – Projektets URL-slug

  • component (string) – Komponentens URL-slug

Svar JSON-objekt:
POST /api/components/(string: project)/(string: component)/translations/

Skapar en ny översättning i den angivna komponenten.

Parametrar:

  • project (string) – Projektets URL-slug

  • component (string) – Komponentens URL-slug

Begär JSON-objekt:
Svar JSON-objekt:

  • result (object) – nytt översättningsobjekt skapat

CURL-exempel:

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

Exempel på JSON-förfrågan:

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

Exempel på JSON-svar:

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/

Returnerar paginerad statistik för alla översättningar inom komponenten.

Parametrar:

  • project (string) – Projektets URL-slug

  • component (string) – Komponentens URL-slug

Se även

Returnerade attribut beskrivs i Statistik.

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

Returnerar projekt som är kopplade till en komponent.

Added in version 4.5.

Parametrar:

  • project (string) – Projektets URL-slug

  • component (string) – Komponentens URL-slug

Svar JSON-objekt:
POST /api/components/(string: project)/(string: component)/links/

Koppla projektet till en komponent.

Added in version 4.5.

Parametrar:

  • project (string) – Projektets URL-slug

  • component (string) – Komponentens URL-slug

Formulärparametrar:

  • string project_slug – Projektslugg

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

Ta bort kopplingen mellan ett projekt och en komponent.

Added in version 4.5.

Parametrar:

  • project (string) – Projektets URL-slug

  • component (string) – Komponentens URL-slug

  • project_slug (string) – Slug av projektet att ta bort

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

Returnerar bidragsgivares krediter för ett projekt.

Added in version 5.7.

Parametrar:

  • project (string) – Projektets URL-slug

  • start (date) – Nedre gräns för tidsstämpel enligt ISO 8601 (obligatoriskt)

  • end (date) – Övre gräns för ISO 8601-tidsstämpel (obligatoriskt)

  • lang (source_language) – Språkkod att söka efter

Svar JSON-objekt:

  • email (string) – E-postadress till bidragsgivaren

  • full_name (string) – Bidragsgivarens fullständiga namn

  • change_count (string) – Antal ändringar som gjorts under tidsperioden

Översättningar

GET /api/translations/

Returnerar en lista med översättningar.

Se även

Översättningsobjektets attribut dokumenteras på GET /api/translations/(string:project)/(string:component)/(string:language)/.

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

Returnerar information om översättningen.

Parametrar:

  • project (string) – Projektets URL-slug

  • component (string) – Komponentens URL-slug

  • language (string) – Översättningsspråkkod

Svar JSON-objekt:

Exempel på JSON-data:

{
    "component": {
        "branch": "main",
        "file_format": "po",
        "file_format_params": {
            "po_line_wrap": 65535,
            "po_no_location": true
        },
        "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)/

Tar bort en översättning.

Parametrar:

  • project (string) – Projektets URL-slug

  • component (string) – Komponentens URL-slug

  • language (string) – Översättningsspråkkod

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

Returnerar en lista över översättningsändringar. Detta är i huvudsak en översättningsbegränsad GET /api/changes/ som accepterar samma parametrar.

Parametrar:

  • project (string) – Projektets URL-slug

  • component (string) – Komponentens URL-slug

  • language (string) – Översättningsspråkkod

Svar JSON-objekt:
GET /api/translations/(string: project)/(string: component)/(string: language)/units/

Returnerar en lista över översättningsenheter.

Parametrar:

  • project (string) – Projektets URL-slug

  • component (string) – Komponentens URL-slug

  • language (string) – Översättningsspråkkod

  • q (string) – Söksträng Söker (valfritt)

Svar JSON-objekt:
POST /api/translations/(string: project)/(string: component)/(string: language)/units/

Lägg till ny enhet.

Parametrar:

  • project (string) – Projektets URL-slug

  • component (string) – Komponentens URL-slug

  • language (string) – Översättningsspråkkod

Begär JSON-objekt:

  • key (string) – Enspråkiga översättningar: Nyckel för översättningsenhet

  • value (array) – Enspråkiga översättningar: Källsträngar (använd enstaka sträng om du inte skapar plural)

  • context (string) – Tvåspråkiga översättningar: Kontext för en översättningsenhet

  • source (array) – Tvåspråkiga översättningar: Källsträngar (använd enstaka sträng om du inte skapar plural)

  • target (array) – Tvåspråkiga översättningar: Målsträngar (använd enstaka sträng om du inte skapar plural)

  • state (int) – Strängstatus; se GET /api/units/(int:id)/

Svar JSON-objekt:

Se även

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

Förändrat i version 5.13: Parametern filter_type stöds inte längre och filtrering sker med parametern q.

Aktivera automatisk översättning.

Parametrar:

  • project (string) – Projektets URL-slug

  • component (string) – Komponentens URL-slug

  • language (string) – Översättningsspråkkod

Begär JSON-objekt:

  • mode (string) – Automatiskt översättningsläge

  • q (string) – Automatisk översättning av söksträng, se Söka efter strängar.

  • auto_source (string) – Källa för automatisk översättning - mt eller andra

  • component (string) – Aktivera bidrag till delat översättningsminne för projektet för att få tillgång till ytterligare komponenter.

  • engines (array) – Översättningsmotor

  • threshold (string) – Poänggräns

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

Ladda ner aktuell översättningsfil så som den lagras i VCS (utan parametern format) eller konvertera den till ett annat format (se Ladda ner översättningar).

Observera

Denna API-ändpunkt använder annan logik för utdata än resten av API:et, eftersom den arbetar med hela filen istället för med data. Uppsättningen av accepterade format-parametrar skiljer sig åt, och utan en sådan parameter får du översättningsfilen som den lagras i VCS.

Svarsrubriker:

  • Last-Modified – Tidsstämpel för senaste ändring av denna fil.

Begärande rubriker:
Parametrar i förfrågan:

  • format – Filformat som ska användas; om inget anges sker ingen formatkonvertering; se Ladda ner översättningar för format som stöds

  • q (string) – Filtrera nedladdade strängar, se Söksida, endast tillämpligt när konvertering är på plats (format är angivet).

Parametrar:

  • project (string) – Projektets URL-slug

  • component (string) – Komponentens URL-slug

  • language (string) – Översättningsspråkkod

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

Ladda upp ny fil med översättningar.

Parametrar:

  • project (string) – Projektets URL-slug

  • component (string) – Komponentens URL-slug

  • language (string) – Översättningsspråkkod

Formulärparametrar:

  • string conflicts – Hur man hanterar konflikter (ignorera, ersätt-översatt eller ersätt-godkänt), se Konflikthantering

  • file file – Uppladdad fil

  • string email – Författarens e-post

  • string author – Författarens namn

  • string method – Uppladdningsmetod (translate, approve, suggest, fuzzy, replace, source, add), se Importmetoder

  • string fuzzy – Bearbetning av fuzzy-strängar (markerade för redigering) (tom, bearbeta, godkänn)

CURL-exempel:

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/

Returnerar information om VCS-arkivets status.

Svaret är detsamma som för GET /api/components/(string:project)/(string:component)/repository/.

Parametrar:

  • project (string) – Projektets URL-slug

  • component (string) – Komponentens URL-slug

  • language (string) – Översättningsspråkkod

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

Utför given operation på VCS-arkivet.

Se POST /api/projects/(string:project)/repository/ för dokumentation.

Parametrar:

  • project (string) – Projektets URL-slug

  • component (string) – Komponentens URL-slug

  • language (string) – Översättningsspråkkod

Begär JSON-objekt:

  • operation (string) – Åtgärd som ska utföras: en av push, pull, commit, reset, cleanup

Svar JSON-objekt:

  • result (boolean) – resultatet av operationen

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

Returnerar detaljerad översättningsstatistik.

Parametrar:

  • project (string) – Projektets URL-slug

  • component (string) – Komponentens URL-slug

  • language (string) – Översättningsspråkkod

Se även

Returnerade attribut beskrivs i Statistik.

Minne

Added in version 4.14.

GET /api/memory/

Returnerar en lista med minnesresultat.

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

Tar bort ett minnesobjekt

Parametrar:

  • memory_object_id – Minnesobjekt-ID

Enheter

En enhet är en enskild del av en översättning som kopplar samman en källsträng med en motsvarande översatt sträng och även innehåller vissa relaterade metadata. Termen härstammar från translate.storage.base.TranslationUnit i Translate Toolkit och XLIFF.

GET /api/units/

Returnerar en lista över översättningsenheter.

Parametrar:

  • q (string) – Söksträng Söker (valfritt)

Se även

Enhetsobjektets attribut dokumenteras på GET /api/units/(int:id)/.

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

Förändrat i version 4.3: Mål och källa är nu matriser för att korrekt hantera flera strängar.

Förändrat i version 5.6: Attributet last_updated är nu exponerat.

Returnerar information om översättningsenheten.

Parametrar:

  • id (int) – Enhet ID

Svar JSON-objekt:

  • translation (string) – URL till ett relaterat översättningsobjekt

  • source (array) – källsträng

  • previous_source (string) – tidigare källsträng som används för fuzzy-matchning

  • target (array) – målsträng

  • id_hash (string) – enhetens unika identifierare

  • content_hash (string) – unik identifierare för källsträngen

  • location (string) – enhetens placering i källkoden

  • context (string) – översättningsenhetens sammanhang

  • note (string) – översättningsenhet anmärkning

  • flags (string) – översättningsenhetsflaggor

  • labels (array) – översättningsenhetsetiketter, tillgängliga på källenheter

  • state (int) – enhetsstatus, 0 – inte översatt, 10 – behöver redigeras, 20 – översatt, 30 – godkänd, 100 – skrivskyddad

  • fuzzy (boolean) – om enheten är oklar eller markerad för granskning

  • translated (boolean) – om enheten är översatt

  • approved (boolean) – om översättningen är godkänd

  • position (int) – enhetsposition i översättningsfil

  • has_suggestion (boolean) – om enheten har förslag

  • has_comment (boolean) – om enheten har kommentarer

  • has_failing_check (boolean) – om enheten har misslyckade kontroller

  • num_words (int) – antal källord

  • priority (int) – översättningsprioritet; 100 är standard

  • id (int) – enhetsidentifierare

  • explanation (string) – Strängförklaring, tillgänglig på källenheter, se Ytterligare information om källsträngar

  • extra_flags (string) – Ytterligare strängflaggor, tillgängliga på källenheter, se Anpassa beteende med hjälp av flaggor

  • web_url (string) – URL där enheten kan redigeras

  • source_unit (string) – Källens enhetslänk; se GET /api/units/(int:id)/

  • pending (boolean) – om enheten väntar på skrivning

  • timestamp (timestamp) – åldersträng

  • last_updated (timestamp) – senaste stränguppdatering

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

Added in version 4.3.

Utför partiell uppdatering av översättningsenheten.

Parametrar:

  • id (int) – Enhet ID

Begär JSON-objekt:

  • state (int) – enhetsstatus, 0 – inte översatt, 10 – behöver redigeras, 20 – översatt, 30 – godkänd (granskningsarbetsflöde måste vara aktiverat, se Engagerade granskare)

  • target (array) – målsträng

  • explanation (string) – Strängförklaring, tillgänglig på källenheter, se Ytterligare information om källsträngar

  • extra_flags (string) – Ytterligare strängflaggor, tillgängliga på källenheter, se Anpassa beteende med hjälp av flaggor

  • labels (array) – etiketter, tillgängliga på källenheter

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

Added in version 4.3.

Utför fullständig uppdatering av översättningsenheten.

Parametrar:

  • id (int) – Enhet ID

Begär JSON-objekt:

  • state (int) – enhetsstatus, 0 – inte översatt, 10 – behöver redigeras, 20 – översatt, 30 – godkänd (granskningsarbetsflöde måste vara aktiverat, se Engagerade granskare)

  • target (array) – målsträng

  • explanation (string) – Strängförklaring, tillgänglig på källenheter, se Ytterligare information om källsträngar

  • extra_flags (string) – Ytterligare strängflaggor, tillgängliga på källenheter, se Anpassa beteende med hjälp av flaggor

  • labels (array) – etiketter, tillgängliga på källenheter

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

Added in version 4.3.

Tar bort en översättningsenhet.

Parametrar:

  • id (int) – Enhet ID

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

Added in version 5.11.

Returnerar en lista över alla målöversättningsenheter för den angivna källöversättningsenheten.

POST /api/units/(int: id)/comments/

Added in version 5.12.

Skapa en ny kommentar till den angivna översättningsenheten.

Parametrar:

  • id (int) – Enhet ID

Begär JSON-objekt:

  • scope (string) – kommentarsomfång – globalt, översättning (tillgängligt på alla icke-källenheter), rapport (kräver att granskningsarbetsflödet är aktiverat, se Engagerade granskare)

  • comment (string) – innehållet i den nya kommentaren kan du använda Markdown och nämna användare med @användarnamn.

  • user_email (string) – kommentatorns e-postadress kan endast ställas in av projektadministratörer och är som standard den autentiserade användaren.

  • timestamp (string) – kommentarens skapelsetidsstämpel kan endast ställas in av projektadministratörer och är som standard inställd på nu.

Svar JSON-objekt:

  • id (int) – kommentaridentifierare

  • comment (string) – innehållet i den nya kommentaren

  • user (string) – URL till kommenterarens objekt

  • timestamp (string) – kommentarens skapelsetidsstämpel

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

Added in version 5.15.

Returnerar en lista med kommentarer om en given översättningsenhet

Parametrar:

  • id (int) – Enhet ID

Svar JSON-objekt:

  • id (int) – kommentaridentifierare

  • comment (string) – kommentarens innehåll

  • timestamp (string) – kommentarens skapelsetidsstämpel

  • user (string) – URL till kommenterarens objekt

Ändringar

GET /api/changes/

Förändrat i version 4.1: Filtrering av ändringar introducerades i version 4.1.

Returnerar en lista över översättningsändringar.

Se även

Ändrade objektattribut dokumenteras på GET /api/changes/(int:id)/.

Parametrar i förfrågan:

  • user (string) – Användarnamn för användare som ska filtreras

  • action (int) – Åtgärd för att filtrera, kan användas flera gånger

  • timestamp_after (timestamp) – Tidsstämpel i ISO 8601-format för att lista ändringar efter

  • timestamp_before (timestamp) – Tidsstämpel i ISO 8601-format för att lista ändringar före

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

Returnerar information om översättningsändringen.

Parametrar:

  • id (int) – Ändra ID

Svar JSON-objekt:

  • unit (string) – URL för ett relaterat enhetsobjekt

  • translation (string) – URL till ett relaterat översättningsobjekt

  • component (string) – URL för ett relaterat komponentobjekt

  • user (string) – URL till ett relaterat användarobjekt

  • author (string) – URL till ett relaterat författarobjekt

  • timestamp (timestamp) – händelsetidsstämpel

  • action (int) – numerisk identifiering av åtgärd

  • action_name (string) – textbeskrivning av åtgärd

  • target (string) – händelse ändrad text

  • old (string) – föregående text

  • details (object) – ytterligare detaljer om förändringen

  • id (int) – ändringsidentifierare

Skärmdumpar

GET /api/screenshots/

Returnerar en lista med information om skärmdumpsträngar.

Se även

Skärmdumpsobjektets attribut dokumenteras på GET /api/screenshots/(int:id)/.

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

Returnerar information om skärmdumpen.

Parametrar:

  • id (int) – Skärmdump-ID

Svar JSON-objekt:
GET /api/screenshots/(int: id)/file/

Ladda ner skärmdumpen.

Parametrar:

  • id (int) – Skärmdump-ID

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

Ersätt skärmdumpbilden.

Parametrar:

  • id (int) – Skärmdump-ID

Formulärparametrar:

  • file image – Uppladdad fil

CURL-exempel:

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

Koppla källsträngen till skärmdumpen.

Parametrar:

  • id (int) – Skärmdump-ID

Formulärparametrar:

  • string unit_id – Enhet ID

Svar JSON-objekt:

  • name (string) – namn på en skärmdump

  • translation (string) – URL till ett relaterat översättningsobjekt

  • file_url (string) – URL för att ladda ner en fil; se GET /api/screenshots/(int:id)/file/

  • units (array) – länk till tillhörande källstränginformation; se GET /api/units/(int:id)/

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

Ta bort källsträngens koppling till skärmdumpen.

Parametrar:

  • id (int) – Skärmdump-ID

  • unit_id – Källsträngens enhets-ID

POST /api/screenshots/

Skapar en ny skärmdump.

Formulärparametrar:

  • file image – Uppladdad fil

  • string name – Namn på skärmdump

  • string project_slug – Projektslugg

  • string component_slug – Komponent slug

  • string language_code – Språkkod

Svar JSON-objekt:
PATCH /api/screenshots/(int: id)/

Redigera delvis information om skärmdump.

Parametrar:

  • id (int) – Skärmdump-ID

Svar JSON-objekt:
PUT /api/screenshots/(int: id)/

Redigera fullständig information om skärmdumpen.

Parametrar:

  • id (int) – Skärmdump-ID

Svar JSON-objekt:
DELETE /api/screenshots/(int: id)/

Ta bort skärmdump.

Parametrar:

  • id (int) – Skärmdump-ID

Tillägg

Added in version 4.4.1.

GET /api/addons/

Returnerar en lista över tillägg.

Se även

Tilläggsobjektattribut dokumenteras på GET /api/addons/(int:id)/.

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

Returnerar information om tilläggsinformation.

Parametrar:

  • id (int) – Tilläggs-ID

Svar JSON-objekt:

  • name (string) – namn på ett tillägg

  • component (string) – URL för ett relaterat komponentobjekt

  • configuration (object) – Valfri tilläggskonfiguration

Se även

Tillägg

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

Skapar ett nytt tillägg.

Parametrar:

  • project_slug (string) – Projektslugg

  • component_slug (string) – Komponent slug

Begär JSON-objekt:

  • name (string) – namn på ett tillägg

  • configuration (object) – Valfri tilläggskonfiguration

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

Redigera delvis information om tillägg.

Parametrar:

  • id (int) – Tilläggs-ID

Svar JSON-objekt:

  • configuration (object) – Valfri tilläggskonfiguration

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

Redigera fullständig information om tillägget.

Parametrar:

  • id (int) – Tilläggs-ID

Svar JSON-objekt:

  • configuration (object) – Valfri tilläggskonfiguration

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

Ta bort tillägg.

Parametrar:

  • id (int) – Tilläggs-ID

Komponentlistor

Added in version 4.0.

GET /api/component-lists/

Returnerar en lista med komponentlistor.

Se även

Komponentlistans objektattribut dokumenteras på GET /api/component-lists/(str:slug)/.

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

Returnerar information om komponentlistan.

Parametrar:

  • slug (string) – Komponentlista slug

Svar JSON-objekt:

  • name (string) – namn på en komponentlista

  • slug (string) – komponentlista

  • show_dashboard (boolean) – om det ska visas på en instrumentpanel

  • components (array) – länk till associerade komponenter; se GET /api/components/(string:project)/(string:component)/

  • auto_assign (array) – automatiska tilldelningsregler

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

Ändrar komponentlistans parametrar.

Parametrar:

  • slug (string) – Komponentlista slug

Begär JSON-objekt:

  • name (string) – namn på en komponentlista

  • slug (string) – komponentlista

  • show_dashboard (boolean) – om det ska visas på en instrumentpanel

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

Ändrar komponentlistans parametrar.

Parametrar:

  • slug (string) – Komponentlista slug

Begär JSON-objekt:

  • name (string) – namn på en komponentlista

  • slug (string) – komponentlista

  • show_dashboard (boolean) – om det ska visas på en instrumentpanel

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

Tar bort komponentlistan.

Parametrar:

  • slug (string) – Komponentlista slug

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

Added in version 5.0.1: Lista komponenter i en komponentlista.

param slug:

Komponentlista slug

typ slug:

sträng

form sträng komponent_id:

Komponent-ID

>json array results:

array av komponentobjekt; se GET /api/components/(string:project)/(string:component)/

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

Koppla komponenten till en komponentlista.

Parametrar:

  • slug (string) – Komponentlista slug

Formulärparametrar:

  • string component_id – Komponent-ID

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

Ta bort en komponent från komponentlistan.

Parametrar:

  • slug (string) – Komponentlista slug

  • component_slug (string) – Komponent slug

Ordlista

Förändrat i version 4.5: Ordlistor lagras nu som vanliga komponenter, översättningar och strängar. Använd respektive API istället.

Uppgifter

Added in version 4.4.

GET /api/tasks/

Förteckningen över uppgifterna är för närvarande inte tillgänglig.

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

Returnerar information om en uppgift.

Parametrar:

  • uuid (string) – Uppgift UUID

Svar JSON-objekt:

  • completed (boolean) – Om uppgiften har slutförts

  • progress (int) – Uppgiftsförlopp i procent

  • result (object) – Uppgiftsresultat eller framstegsinformation

  • log (string) – Uppgiftslogg

Statistik

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

Det finns flera statistikändpunkter för objekt och alla har samma struktur.

Parametrar:

  • object (string) – URL-sökväg

Svar JSON-objekt:

  • total (int) – totalt antal strängar

  • total_words (int) – totalt antal ord

  • total_chars (int) – totalt antal tecken

  • last_change (timestamp) – datum för senaste ändring

  • translated (int) – antal översatta strängar

  • translated_percent (float) – procentandel översatta strängar

  • translated_words (int) – antal översatta ord

  • translated_words_percent (float) – procentandel översatta ord

  • translated_chars (int) – antal översatta tecken

  • translated_chars_percent (float) – procentandel översatta tecken

  • fuzzy (int) – antal otydliga (markerade för redigering) strängar

  • fuzzy_words (int) – antal otydliga (markerade för redigering) ord

  • fuzzy_chars (int) – antal otydliga (markerade för redigering) tecken

  • fuzzy_percent (float) – procentandel av otydliga (markerade för redigering) strängar

  • fuzzy_words_percent (float) – procentandel av otydliga (markerade för redigering) ord

  • fuzzy_chars_percent (float) – procentandel av otydliga (markerade för redigering) tecken

  • failing (int) – antal misslyckade kontroller

  • failing_percent (float) – andel misslyckade kontroller

  • approved (int) – antal godkända strängar

  • approved_words (int) – antal godkända ord

  • approved_chars (int) – antal godkända tecken

  • approved_percent (float) – procentandel godkända strängar

  • approved_words_percent (float) – procentandel godkända ord

  • approved_chars_percent (float) – procentandel godkända tecken

  • readonly (int) – antal skrivskyddade strängar

  • readonly_words (int) – antal skrivskyddade ord

  • readonly – antal skrivskyddade tecken

  • readonly_percent (float) – procentandel av skrivskyddade strängar

  • readonly_words_percent (float) – procentandel av skrivskyddade ord

  • readonly_char_percent (float) – procentandel av skrivskyddade tecken

  • suggestions (int) – antal strängar med förslag

  • comments (int) – antal strängar med kommentarer

  • name (string) – objektnamn

  • url (string) – URL för åtkomst till objektet (om tillämpligt)

  • url_translate (string) – URL för att komma åt översättningen (om tillämpligt)

  • code (string) – språkkod (om tillämpligt)

Se även

Mätvärden

GET /api/metrics/

Returnerar serverstatistik.

Förändrat i version 5.6.1: Mätvärden kan nu visas i OpenMetrics-kompatibelt format med ?format=openmetrics.

Svar JSON-objekt:

  • units (int) – Antal kursdelar

  • units_translated (int) – Antal översatta enheter

  • users (int) – Antal användare

  • changes (int) – Antal ändringar

  • projects (int) – Antal projekt

  • components (int) – Antal komponenter

  • translations (int) – Antal översättningar

  • languages (int) – Antal använda språk

  • checks (int) – Antal utlösta kvalitetskontroller

  • configuration_errors (int) – Antal konfigurationsfel

  • suggestions (int) – Antal väntande förslag

  • celery_queues (object) – Längder på Celery-köer, se Bakgrundsuppgifter med Celery

  • name (string) – Konfigurerat servernamn

Kategorier

GET /api/categories/

Added in version 5.0.

Visar tillgängliga kategorier. Se GET /api/categories/(int:id)/ för fältdefinitioner.

POST /api/categories/

Added in version 5.0.

Skapar en ny kategori. Se GET /api/categories/(int:id)/ för fältdefinitioner.

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

Added in version 5.0.

Parametrar:

  • id (int) – Ingen kategoriinställning i {0}

Svar JSON-objekt:

  • name (str) – Namn på kategori.

  • slug (str) – Kategoriens slug.

  • project (str) – Länk till ett projekt.

  • category (str) – Länk till en överordnad kategori.

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

Added in version 5.0: Redigera delvis information om kategori.

param id:

Ingen kategoriinställning i {0}

typ id:

int

>json object configuration:

Valfri kategorikonfiguration

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

Added in version 5.0: Redigera fullständig information om kategorin.

param id:

Ingen kategoriinställning i {0}

typ id:

int

>json object configuration:

Valfri kategorikonfiguration

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

Added in version 5.0: Ta bort kategori.

param id:

Ingen kategoriinställning i {0}

typ id:

int

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

Added in version 5.5.

Returstatistik för en kategori.

Parametrar:

  • project (int) – Ingen kategoriinställning i {0}

Se även

Returnerade attribut beskrivs i Statistik.

Aviseringskopplingar

Meddelandehookar gör det möjligt för externa applikationer att meddela Weblate att VCS-arkivet har uppdaterats.

Du kan använda repository-ändpunkter för projekt, komponenter och översättningar för att uppdatera enskilda repositorier. Se POST /api/projects/(string:project)/repository/ för dokumentation.

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

Ersatt sedan version 2.6: Använd istället POST /api/components/(string:project)/(string:component)/repository/, som fungerar korrekt med autentisering för ACL-begränsade projekt.

Removed in version 5.14.

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

Ersatt sedan version 2.6: Använd istället POST /api/projects/(string:project)/repository/, som fungerar korrekt med autentisering för ACL-begränsade projekt.

Removed in version 5.14.

POST /hooks/github/

Specialkrok för hantering av GitHub-meddelanden och automatisk uppdatering av matchande komponenter.

Observera

GitHub har direkt stöd för att meddela Weblate: aktivera Weblate-tjänstkroken i inställningarna för arkivet och ange URL:en till din Weblate-installation.

Se även

Automatiskt ta emot ändringar från GitHub

För instruktioner om hur du konfigurerar GitHub-integration

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

Allmän information om GitHub Webhooks

ENABLE_HOOKS

För att aktivera hooks för hela Weblate

POST /hooks/gitlab/

Specialkrok för hantering av GitLab-meddelanden och automatisk uppdatering av matchande komponenter.

Se även

Automatiskt ta emot ändringar från GitLab

För instruktioner om hur du konfigurerar GitLab-integrationen

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

Allmän information om GitLab Webhooks

ENABLE_HOOKS

För att aktivera hooks för hela Weblate

POST /hooks/bitbucket/

Specialkrok för hantering av Bitbucket-meddelanden och automatisk uppdatering av matchande komponenter.

Se även

Automatiskt ta emot ändringar från Bitbucket

För instruktioner om hur du konfigurerar Bitbucket-integrationen

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

Allmän information om Bitbucket Webhooks

ENABLE_HOOKS

För att aktivera hooks för hela Weblate

POST /hooks/pagure/

Specialkrok för hantering av Pagure-meddelanden och automatisk uppdatering av matchande komponenter.

Se även

Automatiskt ta emot ändringar från Pagure

För instruktioner om hur du konfigurerar Pagure-integrationen

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

Allmän information om Pagure Webhooks

ENABLE_HOOKS

För att aktivera hooks för hela Weblate

POST /hooks/azure/

Specialkrok för hantering av Azure DevOps-meddelanden och automatisk uppdatering av matchande komponenter.

Observera

Se till att Resursdetaljer att skicka är inställt på Alla, annars kommer Weblate inte att kunna matcha ditt Azure-arkiv.

Se även

Automatiskt ta emot ändringar från Azure Repos

Instruktioner för att konfigurera Azure-integration

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

Allmän information om Azure DevOps Web Hooks

ENABLE_HOOKS

För att aktivera hooks för hela Weblate

POST /hooks/gitea/

Specialkrok för hantering av Gitea Webhook-meddelanden och automatisk uppdatering av matchande komponenter.

Se även

Automatiskt ta emot ändringar från Gitea Repos

För instruktioner om hur du konfigurerar Gitea-integrationen

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

Allmän information om Gitea Webhooks

ENABLE_HOOKS

För att aktivera hooks för hela Weblate

POST /hooks/gitee/

Specialkrok för hantering av Gitee Webhook-meddelanden och automatisk uppdatering av matchande komponenter.

Se även

Automatiskt ta emot ändringar från Gitee Repos

Instruktioner för att konfigurera Gitee-integration

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

Allmän information om Gitee Webhooks

ENABLE_HOOKS

För att aktivera hooks för hela Weblate

RSS-flöden

Ändringar i översättningar exporteras i RSS-flöden.

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

Hämtar RSS-flöde med senaste ändringar för en översättning.

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

Hämtar RSS-flöde med senaste ändringar för en komponent.

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

Hämtar RSS-flöde med senaste ändringar för ett projekt.

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

Hämtar RSS-flöde med senaste ändringar för ett språk.

GET /exports/rss/

Hämtar RSS-flöde med senaste ändringar för Weblate-instansen.

Se även

RSS på Wikipedia <https://en.wikipedia.org/wiki/RSS>_