Weblate’s REST API
2.6 sürümünde geldi: The REST API is available since Weblate 2.6.
The API is accessible on the /api/
URL and it is based on
Django REST framework.
You can use it directly or by Weblate Client.
Authentication and generic parameters
The public project API is available without authentication, though
unauthenticated requests are heavily throttled (by default to 100 requests per
day), so it is recommended to use authentication. The authentication uses a
token, which you can get in your profile. Use it in the Authorization
header:
- ANY /
Generic request behaviour for the API, the headers, status codes and parameters here apply to all endpoints as well.
- Query Parameters
format – Response format (overrides Accept). Possible values depends on REST framework setup, by default
json
andapi
are supported. The latter provides web browser interface for API.page – Returns given page of paginated results (use next and previous fields in response to automate the navigation).
- Request Headers
Authorization – optional token to authenticate as
Authorization: Token YOUR-TOKEN
- Response Headers
Content-Type – this depends on Accept header of request
Allow – list of allowed HTTP methods on object
- Response JSON Object
detail (string) – verbose description of the result (for HTTP status codes other than 200 OK)
count (int) – total item count for object lists
next (string) – next page URL for object lists
previous (string) – previous page URL for object lists
results (array) – results for object lists
url (string) – URL to access this resource using API
web_url (string) – URL to access this resource using web browser
- Status Codes
200 OK – when request was correctly handled
201 Created – when a new object was created successfully
204 No Content – when an object was deleted successfully
400 Bad Request – when form parameters are missing
403 Forbidden – when access is denied
429 Too Many Requests – when throttling is in place
Authentication examples
Example request:
GET /api/ HTTP/1.1
Host: example.com
Accept: application/json, text/javascript
Authorization: Token YOUR-TOKEN
Example response:
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 example:
curl \
-H "Authorization: Token TOKEN" \
https://example.com/api/
Passing Parameters Examples
For the POST method the parameters can be specified either as form submission (application/x-www-form-urlencoded) or as JSON (application/json).
Form request example:
POST /api/projects/hello/repository/ HTTP/1.1
Host: example.com
Accept: application/json
Content-Type: application/x-www-form-urlencoded
Authorization: Token TOKEN
operation=pull
JSON request example:
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 example:
curl \
-d operation=pull \
-H "Authorization: Token TOKEN" \
http://example.com/api/components/hello/weblate/repository/
CURL JSON example:
curl \
--data-binary '{"operation":"pull"}' \
-H "Content-Type: application/json" \
-H "Authorization: Token TOKEN" \
http://example.com/api/components/hello/weblate/repository/
API rate limiting
The API requests are rate limited; the default configuration limits it to 100 requests per day for anonymous users and 5000 requests per hour for authenticated users.
Rate limiting can be adjusted in the settings.py
; see
Throttling in Django REST framework documentation
for more details how to configure it.
The status of rate limiting is reported in following headers:
|
Rate limiting limit of requests to perform |
|
Remaining limit of requests |
|
Number of seconds until ratelimit window resets |
4.1 sürümünde değişti: Added ratelimiting status headers.
Ayrıca bakınız
API Entry Point
- GET /api/
The API root entry point.
Example request:
GET /api/ HTTP/1.1 Host: example.com Accept: application/json, text/javascript Authorization: Token YOUR-TOKEN
Example response:
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/" }
Kullanıcılar
4.0 sürümünde geldi.
- GET /api/users/
Returns a list of users if you have permissions to see manage users. If not, then you get to see only your own details.
Ayrıca bakınız
Users object attributes are documented at
GET /api/users/(str:username)/
.
- POST /api/users/
Creates a new user.
- Parameters
username (string) – Kullanıcı adı
full_name (string) – User full name
email (string) – User email
is_superuser (boolean) – Is user superuser? (optional)
is_active (boolean) – Is user active? (optional)
- GET /api/users/(str: username)/
Returns information about users.
- Parameters
username (string) – User’s username
- Response JSON Object
username (string) – username of a user
full_name (string) – full name of a user
email (string) – email of a user
is_superuser (boolean) – whether the user is a super user
is_active (boolean) – whether the user is active
date_joined (string) – date the user is created
groups (array) – link to associated groups; see
GET /api/groups/(int:id)/
Example 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/" ], "is_superuser": true, "is_active": true, "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)/
Changes the user parameters.
- Parameters
username (string) – User’s username
- Response JSON Object
username (string) – username of a user
full_name (string) – full name of a user
email (string) – email of a user
is_superuser (boolean) – whether the user is a super user
is_active (boolean) – whether the user is active
date_joined (string) – date the user is created
- PATCH /api/users/(str: username)/
Changes the user parameters.
- Parameters
username (string) – User’s username
- Response JSON Object
username (string) – username of a user
full_name (string) – full name of a user
email (string) – email of a user
is_superuser (boolean) – whether the user is a super user
is_active (boolean) – whether the user is active
date_joined (string) – date the user is created
- DELETE /api/users/(str: username)/
Deletes all user information and marks the user inactive.
- Parameters
username (string) – User’s username
- POST /api/users/(str: username)/groups/
Associate groups with a user.
- Parameters
username (string) – User’s username
- Form Parameters
string group_id – The unique group ID
- GET /api/users/(str: username)/statistics/
List statistics of a user.
- Parameters
username (string) – User’s username
- Response JSON Object
translated (int) – Kullanıcı tarafından yapılan çeviri sayısı
suggested (int) – Kullanıcı tarafından yapılan öneri sayısı
uploaded (int) – Kullanıcı tarafından yapılan yükleme sayısı
commented (int) – Kullanıcı tarafından yapılan yorum sayısı
languages (int) – Kullanıcının çevirebileceği dil sayısı
- GET /api/users/(str: username)/notifications/
List subscriptions of a user.
- Parameters
username (string) – User’s username
- POST /api/users/(str: username)/notifications/
Associate subscriptions with a user.
- Parameters
username (string) – User’s username
- Request JSON Object
notification (string) – Name of notification registered
scope (int) – Scope of notification from the available choices
frequency (int) – Frequency choices for notifications
- GET /api/users/(str: username)/notifications/(int: subscription_id)/
Get a subscription associated with a user.
- Parameters
username (string) – User’s username
subscription_id (int) – Kayıtlı bildirim kimliği
- PUT /api/users/(str: username)/notifications/(int: subscription_id)/
Edit a subscription associated with a user.
- Parameters
username (string) – User’s username
subscription_id (int) – Kayıtlı bildirim kimliği
- Request JSON Object
notification (string) – Name of notification registered
scope (int) – Scope of notification from the available choices
frequency (int) – Frequency choices for notifications
- PATCH /api/users/(str: username)/notifications/(int: subscription_id)/
Edit a subscription associated with a user.
- Parameters
username (string) – User’s username
subscription_id (int) – Kayıtlı bildirim kimliği
- Request JSON Object
notification (string) – Name of notification registered
scope (int) – Scope of notification from the available choices
frequency (int) – Frequency choices for notifications
- DELETE /api/users/(str: username)/notifications/(int: subscription_id)/
Delete a subscription associated with a user.
- Parameters
username (string) – User’s username
subscription_id – Name of notification registered
subscription_id – int
Gruplar
4.0 sürümünde geldi.
- GET /api/groups/
Returns a list of groups if you have permissions to see manage groups. If not, then you get to see only the groups the user is a part of.
Ayrıca bakınız
Group object attributes are documented at
GET /api/groups/(int:id)/
.
- POST /api/groups/
Creates a new group.
- Parameters
name (string) – Grup adı
project_selection (int) – Group of project selection from given options
language_selection (int) – Group of languages selected from given options
- GET /api/groups/(int: id)/
Returns information about group.
- Parameters
id (int) – Group’s ID
- Response JSON Object
name (string) – name of a group
project_selection (int) – integer corresponding to group of projects
language_selection (int) – integer corresponding to group of languages
roles (array) – link to associated roles; see
GET /api/roles/(int:id)/
projects (array) – link to associated projects; see
GET /api/projects/(string:project)/
components (array) – link to associated components; see
GET /api/components/(string:project)/(string:component)/
componentlist (array) – link to associated componentlist; see
GET /api/component-lists/(str:slug)/
Example JSON data:
{ "name": "Guests", "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)/
Changes the group parameters.
- Parameters
id (int) – Group’s ID
- Response JSON Object
name (string) – name of a group
project_selection (int) – integer corresponding to group of projects
language_selection (int) – integer corresponding to group of Languages
- PATCH /api/groups/(int: id)/
Changes the group parameters.
- Parameters
id (int) – Group’s ID
- Response JSON Object
name (string) – name of a group
project_selection (int) – integer corresponding to group of projects
language_selection (int) – integer corresponding to group of languages
- DELETE /api/groups/(int: id)/
Deletes the group.
- Parameters
id (int) – Group’s ID
- POST /api/groups/(int: id)/roles/
Associate roles with a group.
- Parameters
id (int) – Group’s ID
- Form Parameters
string role_id – The unique role ID
- POST /api/groups/(int: id)/components/
Associate components with a group.
- Parameters
id (int) – Group’s ID
- Form Parameters
string component_id – The unique component ID
- DELETE /api/groups/(int: id)/components/(int: component_id)
Delete component from a group.
- Parameters
id (int) – Group’s ID
component_id (int) – The unique component ID
- POST /api/groups/(int: id)/projects/
Associate projects with a group.
- Parameters
id (int) – Group’s ID
- Form Parameters
string project_id – The unique project ID
- DELETE /api/groups/(int: id)/projects/(int: project_id)
Delete project from a group.
- Parameters
id (int) – Group’s ID
project_id (int) – The unique project ID
- POST /api/groups/(int: id)/languages/
Associate languages with a group.
- Parameters
id (int) – Group’s ID
- Form Parameters
string language_code – The unique language code
- DELETE /api/groups/(int: id)/languages/(string: language_code)
Delete language from a group.
- Parameters
id (int) – Group’s ID
language_code (string) – The unique language code
- POST /api/groups/(int: id)/componentlists/
Associate componentlists with a group.
- Parameters
id (int) – Group’s ID
- Form Parameters
string component_list_id – The unique componentlist ID
- DELETE /api/groups/(int: id)/componentlists/(int: component_list_id)
Delete componentlist from a group.
- Parameters
id (int) – Group’s ID
component_list_id (int) – The unique componentlist ID
Roller
- GET /api/roles/
Returns a list of all roles associated with user. If user is superuser, then list of all existing roles is returned.
Ayrıca bakınız
Roles object attributes are documented at
GET /api/roles/(int:id)/
.
- POST /api/roles/
Creates a new role.
- Parameters
name (string) – Role name
permissions (array) – List of codenames of permissions
- GET /api/roles/(int: id)/
Returns information about a role.
- Parameters
id (int) – Role ID
- Response JSON Object
name (string) – Role name
permissions (array) – list of codenames of permissions
Example JSON data:
{ "name": "Access repository", "permissions": [ "vcs.access", "vcs.view" ], "url": "http://example.com/api/roles/1/", }
- PUT /api/roles/(int: id)/
Changes the role parameters.
- Parameters
id (int) – Role’s ID
- Response JSON Object
name (string) – Role name
permissions (array) – list of codenames of permissions
- PATCH /api/roles/(int: id)/
Changes the role parameters.
- Parameters
id (int) – Role’s ID
- Response JSON Object
name (string) – Role name
permissions (array) – list of codenames of permissions
- DELETE /api/roles/(int: id)/
Deletes the role.
- Parameters
id (int) – Role’s ID
Diller
- GET /api/languages/
Returns a list of all languages.
Ayrıca bakınız
Language object attributes are documented at
GET /api/languages/(string:language)/
.
- POST /api/languages/
Creates a new language.
- Parameters
code (string) – Dil adı
name (string) – Dil adı
direction (string) – Metin yönü
plural (object) – Language plural formula and number
- GET /api/languages/(string: language)/
Returns information about a language.
- Parameters
language (string) – Dil kodu
- Response JSON Object
code (string) – Dil kodu
direction (string) – Metin yönü
plural (object) – Object of language plural information
aliases (array) – Array of aliases for language
Example JSON data:
{ "code": "en", "direction": "ltr", "name": "English", "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)/
Changes the language parameters.
- Parameters
language (string) – Language’s code
- Request JSON Object
name (string) – Dil adı
direction (string) – Metin yönü
plural (object) – Language plural details
- PATCH /api/languages/(string: language)/
Changes the language parameters.
- Parameters
language (string) – Language’s code
- Request JSON Object
name (string) – Dil adı
direction (string) – Metin yönü
plural (object) – Language plural details
- DELETE /api/languages/(string: language)/
Dili siler.
- Parameters
language (string) – Language’s code
- GET /api/languages/(string: language)/statistics/
Returns statistics for a language.
- Parameters
language (string) – Dil kodu
- Response JSON Object
total (int) – total number of strings
total_words (int) – total number of words
last_change (timestamp) – last changes in the language
recent_changes (int) – total number of changes
translated (int) – number of translated strings
translated_percent (float) – percentage of translated strings
translated_words (int) – number of translated words
translated_words_percent (int) – percentage of translated words
translated_chars (int) – number of translated characters
translated_chars_percent (int) – percentage of translated characters
total_chars (int) – number of total characters
fuzzy (int) – belirsiz (düzenleme için işaretlenen) dizgilerin sayısı
fuzzy_percent (int) – percentage of fuzzy (marked for edit) strings
failing (int) – number of failing strings
failing – percentage of failing strings
Projeler
- GET /api/projects/
Returns a list of all projects.
Ayrıca bakınız
Project object attributes are documented at
GET /api/projects/(string:project)/
.
- POST /api/projects/
3.9 sürümünde geldi.
Creates a new project.
- Parameters
name (string) – Proje adı
slug (string) – Project slug
web (string) – Proje web sitesi
- GET /api/projects/(string: project)/
Returns information about a project.
- Parameters
project (string) – Proje URL’si kısaltması
- Response JSON Object
name (string) – proje adı
slug (string) – project slug
web (string) – project website
components_list_url (string) – URL to components list; see
GET /api/projects/(string:project)/components/
repository_url (string) – URL to repository status; see
GET /api/projects/(string:project)/repository/
changes_list_url (string) – URL to changes list; see
GET /api/projects/(string:project)/changes/
translation_review (boolean) – Gözden geçirmeleri etkinleştir
source_review (boolean) – Kaynak gözden geçirmelerini etkinleştir
set_language_team (boolean) – “Language-Team” (Çeviri-Takımı) başlığını ayarla
enable_hooks (boolean) – Kancaları etkinleştir
instructions (string) – Çeviri talimatları
language_aliases (string) – Dil kod adları
Example 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)/
4.3 sürümünde geldi.
Edit a project by a PATCH request.
- Parameters
project (string) – Proje URL’si kısaltması
component (string) – Bileşen URL’si kısaltması
- PUT /api/projects/(string: project)/
4.3 sürümünde geldi.
Edit a project by a PUT request.
- Parameters
project (string) – Proje URL’si kısaltması
- DELETE /api/projects/(string: project)/
3.9 sürümünde geldi.
Deletes a project.
- Parameters
project (string) – Proje URL’si kısaltması
- GET /api/projects/(string: project)/changes/
Returns a list of project changes. This is essentially a project scoped
GET /api/changes/
accepting same params.- Parameters
project (string) – Proje URL’si kısaltması
- Response JSON Object
results (array) – array of component objects; see
GET /api/changes/(int:id)/
- GET /api/projects/(string: project)/repository/
Returns information about VCS repository status. This endpoint contains only an overall summary for all repositories for the project. To get more detailed status use
GET /api/components/(string:project)/(string:component)/repository/
.- Parameters
project (string) – Proje URL’si kısaltması
- Response JSON Object
needs_commit (boolean) – whether there are any pending changes to commit
needs_merge (boolean) – whether there are any upstream changes to merge
needs_push (boolean) – whether there are any local changes to push
Example JSON data:
{ "needs_commit": true, "needs_merge": false, "needs_push": true }
- POST /api/projects/(string: project)/repository/
Performs given operation on the VCS repository.
- Parameters
project (string) – Proje URL’si kısaltması
- Request JSON Object
operation (string) – Operation to perform: one of
push
,pull
,commit
,reset
,cleanup
,file-sync
- Response JSON Object
result (boolean) – result of the operation
CURL example:
curl \ -d operation=pull \ -H "Authorization: Token TOKEN" \ http://example.com/api/projects/hello/repository/
JSON request example:
POST /api/projects/hello/repository/ HTTP/1.1 Host: example.com Accept: application/json Content-Type: application/json Authorization: Token TOKEN Content-Length: 20 {"operation":"pull"}
JSON response example:
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/
Returns a list of translation components in the given project.
- Parameters
project (string) – Proje URL’si kısaltması
- Response JSON Object
results (array) – array of component objects; see
GET /api/components/(string:project)/(string:component)/
- POST /api/projects/(string: project)/components/
3.9 sürümünde geldi.
4.3 sürümünde değişti: The
zipfile
anddocfile
parameters are now accepted for VCS-less components, see Local files.4.6 sürümünde değişti: The cloned repositories are now automatically shared within a project using Weblate internal URLs. Use
disable_autoshare
to turn off this.Creates translation components in the given project.
İpucu
Use Weblate internal URLs when creating multiple components from a single VCS repository.
Not
Most of the component creation happens in the background. Check the
task_url
attribute of created component and follow the progress there.- Parameters
project (string) – Proje URL’si kısaltması
- Form Parameters
file zipfile – ZIP file to upload into Weblate for translations initialization
file docfile – Çevrilecek belge
boolean disable_autoshare – Disables automatic repository sharing via Weblate internal URLs.
- Response JSON Object
result (object) – Created component object; see
GET /api/components/(string:project)/(string:component)/
JSON can not be used when uploading the files using the
zipfile
anddocfile
parameters. The data has to be uploaded as multipart/form-data.CURL form request example:
curl \ --form docfile=@strings.html \ --form name=Weblate \ --form slug=weblate \ --form file_format=html \ --form new_lang=add \ -H "Authorization: Token TOKEN" \ http://example.com/api/projects/hello/components/
CURL JSON request example:
curl \ --data-binary '{ "branch": "main", "file_format": "po", "filemask": "po/*.po", "git_export": "", "license": "", "license_url": "", "name": "Weblate", "slug": "weblate", "repo": "file:///home/nijel/work/weblate-hello", "template": "", "new_base": "", "vcs": "git" }' \ -H "Content-Type: application/json" \ -H "Authorization: Token TOKEN" \ http://example.com/api/projects/hello/components/
JSON request example:
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", "git_export": "", "license": "", "license_url": "", "name": "Weblate", "slug": "weblate", "repo": "file:///home/nijel/work/weblate-hello", "template": "", "new_base": "", "vcs": "git" }
JSON response example:
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", "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/
Returns paginated statistics for all languages within a project.
3.8 sürümünde geldi.
- Parameters
project (string) – Proje URL’si kısaltması
- Response JSON Object
results (array) – array of translation statistics objects
language (string) – language name
code (string) – language code
total (int) – total number of strings
translated (int) – number of translated strings
translated_percent (float) – percentage of translated strings
total_words (int) – total number of words
translated_words (int) – number of translated words
words_percent (float) – percentage of translated words
- GET /api/projects/(string: project)/statistics/
Returns statistics for a project.
3.8 sürümünde geldi.
- Parameters
project (string) – Proje URL’si kısaltması
- Response JSON Object
total (int) – total number of strings
translated (int) – number of translated strings
translated_percent (float) – percentage of translated strings
total_words (int) – total number of words
translated_words (int) – number of translated words
words_percent (float) – percentage of translated words
Bileşenler
- GET /api/components/
Returns a list of translation components.
Ayrıca bakınız
Component object attributes are documented at
GET /api/components/(string:project)/(string:component)/
.
- GET /api/components/(string: project)/(string: component)/
Returns information about translation component.
- Parameters
project (string) – Proje URL’si kısaltması
component (string) – Bileşen URL’si kısaltması
- Response JSON Object
project (object) – the translation project; see
GET /api/projects/(string:project)/
name (string) – Bileşen adı
slug (string) – Component slug
vcs (string) – Sürüm denetleme sistemi
repo (string) – Kaynak kod deposu
git_export (string) – Dışa aktarılmış depo URL’si
branch (string) – Depo dalı
push_branch (string) – Yollama dalı
filemask (string) – File mask
template (string) – Tek dilli taban dil dosyası
edit_template (string) – Taban dosyayı düzenle
intermediate (string) – Ara dil dosyası
new_base (string) – Yeni çeviriler için şablon
file_format (string) – Dosya biçimi
license (string) – Çeviri lisansı
agreement (string) – Katılımcı sözleşmesi
new_lang (string) – Yeni çeviri ekleniyor
language_code_style (string) – Dil kodu stili
source_language (object) – source language object; see
GET /api/languages/(string:language)/
push (string) – Depo yollama URL’si
check_flags (string) – Çeviri işaretleri
priority (string) – Öncelik
enforced_checks (string) – Zorunlu denetimler
restricted (string) – Restricted access
repoweb (string) – Depo tarayıcısı
report_source_bugs (string) – Kaynak dizgi hata bildirme adresi
merge_style (string) – Birleştirme stili
commit_message (string) – Commit, add, delete, merge and addon messages
add_message (string) – Commit, add, delete, merge and addon messages
delete_message (string) – Commit, add, delete, merge and addon messages
merge_message (string) – Commit, add, delete, merge and addon messages
addon_message (string) – Commit, add, delete, merge and addon messages
allow_translation_propagation (string) – Çeviri yaymaya izin ver
enable_suggestions (string) – Önerileri etkinleştir
suggestion_voting (string) – Öneri oylaması
suggestion_autoaccept (string) – Önerileri kendiliğinden kabul et
push_on_commit (string) – İşlemeye yolla
commit_pending_age (string) – İşlenecek değişikliklerin yaşı
auto_lock_error (string) – Hata durumunda kilitle
language_regex (string) – Dil süzgeci
variant_regex (string) – Çeşitlerin düzenli ifadesi
repository_url (string) – URL to repository status; see
GET /api/components/(string:project)/(string:component)/repository/
translations_url (string) – URL to translations list; see
GET /api/components/(string:project)/(string:component)/translations/
lock_url (string) – URL to lock status; see
GET /api/components/(string:project)/(string:component)/lock/
changes_list_url (string) – URL to changes list; see
GET /api/components/(string:project)/(string:component)/changes/
task_url (string) – URL to a background task (if any); see
GET /api/tasks/(str:uuid)/
Example JSON data:
{ "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", "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", "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)/
Edit a component by a PATCH request.
- Parameters
project (string) – Proje URL’si kısaltması
component (string) – Bileşen URL’si kısaltması
source_language (string) – Project source language code (optional)
- Request JSON Object
name (string) – name of component
slug (string) – slug of component
repo (string) – VCS repository URL
CURL example:
curl \ --data-binary '{"name": "new name"}' \ -H "Content-Type: application/json" \ -H "Authorization: Token TOKEN" \ PATCH http://example.com/api/projects/hello/components/
JSON request example:
PATCH /api/projects/hello/components/ HTTP/1.1 Host: example.com Accept: application/json Content-Type: application/json Authorization: Token TOKEN Content-Length: 20 { "name": "new name" }
JSON response example:
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", "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)/
Edit a component by a PUT request.
- Parameters
project (string) – Proje URL’si kısaltması
component (string) – Bileşen URL’si kısaltması
- Request JSON Object
branch (string) – VCS repository branch
file_format (string) – file format of translations
filemask (string) – mask of translation files in the repository
name (string) – name of component
slug (string) – slug of component
repo (string) – VCS repository URL
template (string) – base file for monolingual translations
new_base (string) – base file for adding new translations
vcs (string) – version control system
- DELETE /api/components/(string: project)/(string: component)/
3.9 sürümünde geldi.
Deletes a component.
- Parameters
project (string) – Proje URL’si kısaltması
component (string) – Bileşen URL’si kısaltması
- GET /api/components/(string: project)/(string: component)/changes/
Returns a list of component changes. This is essentially a component scoped
GET /api/changes/
accepting same params.- Parameters
project (string) – Proje URL’si kısaltması
component (string) – Bileşen URL’si kısaltması
- Response JSON Object
results (array) – array of component objects; see
GET /api/changes/(int:id)/
- GET /api/components/(string: project)/(string: component)/file/
4.9 sürümünde geldi.
Downloads all available translations associated with the component as an archive file using the requested format.
- Parameters
project (string) – Proje URL’si kısaltması
component (string) – Bileşen URL’si kısaltması
- Query Parameters
format (string) – The archive format to use; If not specified, defaults to
zip
; Supported formats:zip
- GET /api/components/(string: project)/(string: component)/screenshots/
Returns a list of component screenshots.
- Parameters
project (string) – Proje URL’si kısaltması
component (string) – Bileşen URL’si kısaltması
- Response JSON Object
results (array) – array of component screenshots; see
GET /api/screenshots/(int:id)/
- GET /api/components/(string: project)/(string: component)/lock/
Returns component lock status.
- Parameters
project (string) – Proje URL’si kısaltması
component (string) – Bileşen URL’si kısaltması
- Response JSON Object
locked (boolean) – whether component is locked for updates
Example JSON data:
{ "locked": false }
- POST /api/components/(string: project)/(string: component)/lock/
Sets component lock status.
Response is same as
GET /api/components/(string:project)/(string:component)/lock/
.- Parameters
project (string) – Proje URL’si kısaltması
component (string) – Bileşen URL’si kısaltması
- Request JSON Object
lock – Boolean whether to lock or not.
CURL example:
curl \ -d lock=true \ -H "Authorization: Token TOKEN" \ http://example.com/api/components/hello/weblate/repository/
JSON request example:
POST /api/components/hello/weblate/repository/ HTTP/1.1 Host: example.com Accept: application/json Content-Type: application/json Authorization: Token TOKEN Content-Length: 20 {"lock": true}
JSON response example:
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/
Returns information about VCS repository status.
The response is same as for
GET /api/projects/(string:project)/repository/
.- Parameters
project (string) – Proje URL’si kısaltması
component (string) – Bileşen URL’si kısaltması
- Response JSON Object
needs_commit (boolean) – whether there are any pending changes to commit
needs_merge (boolean) – whether there are any upstream changes to merge
needs_push (boolean) – whether there are any local changes to push
remote_commit (string) – Remote commit information
status (string) – VCS repository status as reported by VCS
merge_failure – Text describing merge failure or null if there is none
- POST /api/components/(string: project)/(string: component)/repository/
Performs the given operation on a VCS repository.
See
POST /api/projects/(string:project)/repository/
for documentation.- Parameters
project (string) – Proje URL’si kısaltması
component (string) – Bileşen URL’si kısaltması
- Request JSON Object
operation (string) – Operation to perform: one of
push
,pull
,commit
,reset
,cleanup
- Response JSON Object
result (boolean) – result of the operation
CURL example:
curl \ -d operation=pull \ -H "Authorization: Token TOKEN" \ http://example.com/api/components/hello/weblate/repository/
JSON request example:
POST /api/components/hello/weblate/repository/ HTTP/1.1 Host: example.com Accept: application/json Content-Type: application/json Authorization: Token TOKEN Content-Length: 20 {"operation":"pull"}
JSON response example:
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/
Downloads base file for monolingual translations.
- Parameters
project (string) – Proje URL’si kısaltması
component (string) – Bileşen URL’si kısaltması
- GET /api/components/(string: project)/(string: component)/new_template/
Downloads template file for new translations.
- Parameters
project (string) – Proje URL’si kısaltması
component (string) – Bileşen URL’si kısaltması
- GET /api/components/(string: project)/(string: component)/translations/
Returns a list of translation objects in the given component.
- Parameters
project (string) – Proje URL’si kısaltması
component (string) – Bileşen URL’si kısaltması
- Response JSON Object
results (array) – array of translation objects; see
GET /api/translations/(string:project)/(string:component)/(string:language)/
- POST /api/components/(string: project)/(string: component)/translations/
Creates new translation in the given component.
- Parameters
project (string) – Proje URL’si kısaltması
component (string) – Bileşen URL’si kısaltması
- Request JSON Object
language_code (string) – translation language code; see
GET /api/languages/(string:language)/
- Response JSON Object
result (object) – new translation object created
CURL example:
curl \ -d language_code=cs \ -H "Authorization: Token TOKEN" \ http://example.com/api/projects/hello/components/
JSON request example:
POST /api/projects/hello/components/ HTTP/1.1 Host: example.com Accept: application/json Content-Type: application/json Authorization: Token TOKEN Content-Length: 20 {"language_code": "cs"}
JSON response example:
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", "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/
Returns paginated statistics for all translations within component.
2.7 sürümünde geldi.
- Parameters
project (string) – Proje URL’si kısaltması
component (string) – Bileşen URL’si kısaltması
- Response JSON Object
results (array) – array of translation statistics objects; see
GET /api/translations/(string:project)/(string:component)/(string:language)/statistics/
- GET /api/components/(string: project)/(string: component)/links/
Bir bileşenle bağlantılı projeleri döndürür.
4.5 sürümünde geldi.
- Parameters
project (string) – Proje URL’si kısaltması
component (string) – Bileşen URL’si kısaltması
- Response JSON Object
projects (array) – ilişkili projeler; bkz
GET /api/projects/(string:project)/
- POST /api/components/(string: project)/(string: component)/links/
Projeyi bir bileşenle ilişkilendir.
4.5 sürümünde geldi.
- Parameters
project (string) – Proje URL’si kısaltması
component (string) – Bileşen URL’si kısaltması
- Form Parameters
string project_slug – Project slug
- DELETE /api/components/(string: project)/(string: component)/links/(string: project_slug)/
Bir projenin bir bileşenle ilişkisini kaldır.
4.5 sürümünde geldi.
- Parameters
project (string) – Proje URL’si kısaltması
component (string) – Bileşen URL’si kısaltması
project_slug (string) – Kaldırılacak projenin kısaltması
Çeviriler
- GET /api/translations/
Returns a list of translations.
Ayrıca bakınız
Translation object attributes are documented at
GET /api/translations/(string:project)/(string:component)/(string:language)/
.
- GET /api/translations/(string: project)/(string: component)/(string: language)/
Returns information about a translation.
- Parameters
project (string) – Proje URL’si kısaltması
component (string) – Bileşen URL’si kısaltması
language (string) – Translation language code
- Response JSON Object
component (object) – component object; see
GET /api/components/(string:project)/(string:component)/
failing_checks (int) – kusur denetimleri olan dizgi sayısı
failing_checks_percent (float) – kusur denetimleri olan dizgi yüzdesi
failing_checks_words (int) – kusur denetimleri olan sözcük sayısı
filename (string) – translation filename
fuzzy (int) – belirsiz (düzenleme için işaretlenen) dizgilerin sayısı
fuzzy_percent (float) – percentage of fuzzy (marked for edit) strings
fuzzy_words (int) – number of words in fuzzy (marked for edit) strings
have_comment (int) – number of strings with comment
have_suggestion (int) – number of strings with suggestion
is_template (boolean) – çevirinin tek dilli bir tabanı olup olmadığı
language (object) – source language object; see
GET /api/languages/(string:language)/
language_code (string) – language code used in the repository; this can be different from language code in the language object
last_author (string) – name of last author
last_change (timestamp) – last change timestamp
revision (string) – revision hash for the file
share_url (string) – URL for sharing leading to engagement page
total (int) – total number of strings
total_words (int) – total number of words
translate_url (string) – URL for translating
translated (int) – number of translated strings
translated_percent (float) – percentage of translated strings
translated_words (int) – number of translated words
repository_url (string) – URL to repository status; see
GET /api/translations/(string:project)/(string:component)/(string:language)/repository/
file_url (string) – URL to file object; see
GET /api/translations/(string:project)/(string:component)/(string:language)/file/
changes_list_url (string) – URL to changes list; see
GET /api/translations/(string:project)/(string:component)/(string:language)/changes/
units_list_url (string) – URL to strings list; see
GET /api/translations/(string:project)/(string:component)/(string:language)/units/
Example JSON data:
{ "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", "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", "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)/
3.9 sürümünde geldi.
Deletes a translation.
- Parameters
project (string) – Proje URL’si kısaltması
component (string) – Bileşen URL’si kısaltması
language (string) – Translation language code
- GET /api/translations/(string: project)/(string: component)/(string: language)/changes/
Returns a list of translation changes. This is essentially a translations-scoped
GET /api/changes/
accepting the same parameters.- Parameters
project (string) – Proje URL’si kısaltması
component (string) – Bileşen URL’si kısaltması
language (string) – Translation language code
- Response JSON Object
results (array) – array of component objects; see
GET /api/changes/(int:id)/
- GET /api/translations/(string: project)/(string: component)/(string: language)/units/
Returns a list of translation units.
- Parameters
project (string) – Proje URL’si kısaltması
component (string) – Bileşen URL’si kısaltması
language (string) – Translation language code
q (string) – Search query string Searching (optional)
- Response JSON Object
results (array) – array of component objects; see
GET /api/units/(int:id)/
- POST /api/translations/(string: project)/(string: component)/(string: language)/units/
Add new monolingual unit.
- Parameters
project (string) – Proje URL’si kısaltması
component (string) – Bileşen URL’si kısaltması
language (string) – Translation language code
- Request JSON Object
key (string) – Name of translation unit
value (array) – The translation unit value
Ayrıca bakınız
- POST /api/translations/(string: project)/(string: component)/(string: language)/autotranslate/
Trigger automatic translation.
- Parameters
project (string) – Proje URL’si kısaltması
component (string) – Bileşen URL’si kısaltması
language (string) – Translation language code
- Request JSON Object
mode (string) – Otomatik çeviri kipi
filter_type (string) – Automatic translation filter type
auto_source (string) – Otomatik çeviri kaynağı -
mt
veyaothers
component (string) – Projenin ek bileşenlere erişebilmesi için paylaşılan çeviri belleğine katkıyı açın.
engines (array) – Makine çevirisi motorları
threshold (string) – Skor eşiği
- GET /api/translations/(string: project)/(string: component)/(string: language)/file/
Download current translation file as it is stored in the VCS (without the
format
parameter) or converted to another format (see Downloading translations).Not
This API endpoint uses different logic for output than rest of API as it operates on whole file rather than on data. Set of accepted
format
parameter differs and without such parameter you get translation file as stored in VCS.- Query Parameters
format – File format to use; if not specified no format conversion happens; supported file formats:
po
,mo
,xliff
,xliff11
,tbx
,csv
,xlsx
,json
,aresource
,strings
- Parameters
project (string) – Proje URL’si kısaltması
component (string) – Bileşen URL’si kısaltması
language (string) – Translation language code
- POST /api/translations/(string: project)/(string: component)/(string: language)/file/
Upload new file with translations.
- Parameters
project (string) – Proje URL’si kısaltması
component (string) – Bileşen URL’si kısaltması
language (string) – Translation language code
- Form Parameters
string conflict – How to deal with conflicts (
ignore
,replace-translated
orreplace-approved
)file file – Uploaded file
string email – Hazırlayanın e-postası
string author – Hazırlayanın adı
string method – Upload method (
translate
,approve
,suggest
,fuzzy
,replace
,source
,add
), see Import methodsstring fuzzy – Fuzzy (marked for edit) strings processing (empty,
process
,approve
)
CURL example:
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/
Returns information about VCS repository status.
The response is same as for
GET /api/components/(string:project)/(string:component)/repository/
.- Parameters
project (string) – Proje URL’si kısaltması
component (string) – Bileşen URL’si kısaltması
language (string) – Translation language code
- POST /api/translations/(string: project)/(string: component)/(string: language)/repository/
Performs given operation on the VCS repository.
See
POST /api/projects/(string:project)/repository/
for documentation.- Parameters
project (string) – Proje URL’si kısaltması
component (string) – Bileşen URL’si kısaltması
language (string) – Translation language code
- Request JSON Object
operation (string) – Operation to perform: one of
push
,pull
,commit
,reset
,cleanup
- Response JSON Object
result (boolean) – result of the operation
- GET /api/translations/(string: project)/(string: component)/(string: language)/statistics/
Returns detailed translation statistics.
2.7 sürümünde geldi.
- Parameters
project (string) – Proje URL’si kısaltması
component (string) – Bileşen URL’si kısaltması
language (string) – Translation language code
- Response JSON Object
code (string) – language code
failing (int) – number of failing checks
failing_percent (float) – percentage of failing checks
fuzzy (int) – belirsiz (düzenleme için işaretlenen) dizgilerin sayısı
fuzzy_percent (float) – percentage of fuzzy (marked for edit) strings
total_words (int) – total number of words
translated_words (int) – number of translated words
last_author (string) – name of last author
last_change (timestamp) – date of last change
name (string) – language name
total (int) – total number of strings
translated (int) – number of translated strings
translated_percent (float) – percentage of translated strings
url (string) – URL to access the translation (engagement URL)
url_translate (string) – URL to access the translation (real translation URL)
Units
A unit is a single piece of a translation which pairs a source string with a corresponding translated string and also contains some related metadata. The term is derived from the Translate Toolkit and XLIFF.
2.10 sürümünde geldi.
- GET /api/units/
Returns list of translation units.
Ayrıca bakınız
Unit object attributes are documented at
GET /api/units/(int:id)/
.
- GET /api/units/(int: id)/
4.3 sürümünde değişti: The
target
andsource
are now arrays to properly handle plural strings.Returns information about translation unit.
- Parameters
id (int) – Unit ID
- Response JSON Object
translation (string) – URL of a related translation object
source (array) – source string
previous_source (string) – previous source string used for fuzzy matching
target (array) – target string
id_hash (string) – unique identifier of the unit
content_hash (string) – unique identifier of the source string
location (string) – location of the unit in source code
context (string) – translation unit context
note (string) – translation unit note
flags (string) – translation unit flags
state (int) – unit state, 0 - not translated, 10 - needs editing, 20 - translated, 30 - approved, 100 - read only
fuzzy (boolean) – birimin belirsiz veya gözden geçirilmek üzere işaretlenmiş olup olmadığı
translated (boolean) – birimin çevrilmiş olup olmadığı
approved (boolean) – çevirinin onaylanmış olup olmadığı
position (int) – unit position in translation file
has_suggestion (boolean) – birimin önerileri olup olmadığı
has_comment (boolean) – birimin yorumları olup olmadığı
has_failing_check (boolean) – birimin kusur denetimleri olup olmadığı
num_words (int) – number of source words
priority (int) – translation priority; 100 is default
id (int) – unit identifier
explanation (string) – String explanation, available on source units, see Additional info on source strings
extra_flags (string) – Additional string flags, available on source units, see Customizing behavior using flags
web_url (string) – URL where the unit can be edited
souce_unit (string) – Source unit link; see
GET /api/units/(int:id)/
- PATCH /api/units/(int: id)/
4.3 sürümünde geldi.
Çeviri birimi üzerinde kısmi güncelleme gerçekleştirir.
- Parameters
id (int) – Unit ID
- Request JSON Object
state (int) – unit state, 0 - not translated, 10 - needs editing, 20 - translated, 30 - approved (need review workflow enabled, see Dedicated reviewers)
target (array) – target string
explanation (string) – String explanation, available on source units, see Additional info on source strings
extra_flags (string) – Additional string flags, available on source units, see Customizing behavior using flags
- PUT /api/units/(int: id)/
4.3 sürümünde geldi.
Çeviri birimi üzerinde tam güncelleme gerçekleştirir.
- Parameters
id (int) – Unit ID
- Request JSON Object
state (int) – unit state, 0 - not translated, 10 - needs editing, 20 - translated, 30 - approved (need review workflow enabled, see Dedicated reviewers)
target (array) – target string
explanation (string) – String explanation, available on source units, see Additional info on source strings
extra_flags (string) – Additional string flags, available on source units, see Customizing behavior using flags
- DELETE /api/units/(int: id)/
4.3 sürümünde geldi.
Bir çeviri birimini siler.
- Parameters
id (int) – Unit ID
Değişiklikler
2.10 sürümünde geldi.
- GET /api/changes/
4.1 sürümünde değişti: Filtering of changes was introduced in the 4.1 release.
Returns a list of translation changes.
Ayrıca bakınız
Change object attributes are documented at
GET /api/changes/(int:id)/
.- Query Parameters
user (string) – Username of user to filters
action (int) – Action to filter, can be used several times
timestamp_after (timestamp) – ISO 8601 formatted timestamp to list changes after
timestamp_before (timestamp) – ISO 8601 formatted timestamp to list changes before
- GET /api/changes/(int: id)/
Returns information about translation change.
- Parameters
id (int) – Change ID
- Response JSON Object
unit (string) – URL of a related unit object
translation (string) – URL of a related translation object
component (string) – URL of a related component object
user (string) – URL of a related user object
author (string) – URL of a related author object
timestamp (timestamp) – event timestamp
action (int) – numeric identification of action
action_name (string) – text description of action
target (string) – event changed text or detail
id (int) – change identifier
Ekran görüntüleri
2.14 sürümünde geldi.
- GET /api/screenshots/
Returns a list of screenshot string information.
Ayrıca bakınız
Screenshot object attributes are documented at
GET /api/screenshots/(int:id)/
.
- GET /api/screenshots/(int: id)/
Returns information about screenshot information.
- Parameters
id (int) – Screenshot ID
- Response JSON Object
name (string) – name of a screenshot
component (string) – URL of a related component object
file_url (string) – URL to download a file; see
GET /api/screenshots/(int:id)/file/
units (array) – link to associated source string information; see
GET /api/units/(int:id)/
- GET /api/screenshots/(int: id)/file/
Download the screenshot image.
- Parameters
id (int) – Screenshot ID
- POST /api/screenshots/(int: id)/file/
Replace screenshot image.
- Parameters
id (int) – Screenshot ID
- Form Parameters
file image – Uploaded file
CURL example:
curl -X POST \ -F image=@image.png \ -H "Authorization: Token TOKEN" \ http://example.com/api/screenshots/1/file/
- POST /api/screenshots/(int: id)/units/
Associate source string with screenshot.
- Parameters
id (int) – Screenshot ID
- Form Parameters
string unit_id – Unit ID
- Response JSON Object
name (string) – name of a screenshot
translation (string) – URL of a related translation object
file_url (string) – URL to download a file; see
GET /api/screenshots/(int:id)/file/
units (array) – link to associated source string information; see
GET /api/units/(int:id)/
- DELETE /api/screenshots/(int: id)/units/(int: unit_id)
Kaynak dizgi ile ekran görüntüsü ilişkilendirmesini kaldır.
- Parameters
id (int) – Screenshot ID
unit_id – Kaynak dizgi birimi kimliği
- POST /api/screenshots/
Yeni bir ekran görüntüsü oluşturur.
- Form Parameters
file image – Uploaded file
string name – Ekran görüntüsü adı
string project_slug – Project slug
string component_slug – Component slug
string language_code – Dil kodu
- Response JSON Object
name (string) – name of a screenshot
component (string) – URL of a related component object
file_url (string) – URL to download a file; see
GET /api/screenshots/(int:id)/file/
units (array) – link to associated source string information; see
GET /api/units/(int:id)/
- PATCH /api/screenshots/(int: id)/
Ekran görüntüsü ile ilgili kısmi bilgileri düzenle.
- Parameters
id (int) – Screenshot ID
- Response JSON Object
name (string) – name of a screenshot
component (string) – URL of a related component object
file_url (string) – URL to download a file; see
GET /api/screenshots/(int:id)/file/
units (array) – link to associated source string information; see
GET /api/units/(int:id)/
- PUT /api/screenshots/(int: id)/
Ekran görüntüsü ile ilgili tüm bilgileri düzenle.
- Parameters
id (int) – Screenshot ID
- Response JSON Object
name (string) – name of a screenshot
component (string) – URL of a related component object
file_url (string) – URL to download a file; see
GET /api/screenshots/(int:id)/file/
units (array) – link to associated source string information; see
GET /api/units/(int:id)/
- DELETE /api/screenshots/(int: id)/
Ekran görüntüsünü sil.
- Parameters
id (int) – Screenshot ID
Eklentiler
4.4.1 sürümünde geldi.
- GET /api/addons/
Eklentilerin bir listesini döndürür.
Ayrıca bakınız
Eklenti nesne nitelikleri
GET /api/addons/(int:id)/
adresinde belgelendirilmiştir.
- GET /api/addons/(int: id)/
Eklentiyle ilgili bilgileri döndürür.
- Parameters
id (int) – Eklenti kimliği
- Response JSON Object
name (string) – bir eklentinin adı
component (string) – URL of a related component object
configuration (object) – İsteğe bağlı eklenti yapılandırması
Ayrıca bakınız
- POST /api/components/(string: project)/(string: component)/addons/
Yeni bir eklenti oluşturur.
- Parameters
project_slug (string) – Project slug
component_slug (string) – Component slug
- Request JSON Object
name (string) – bir eklentinin adı
configuration (object) – İsteğe bağlı eklenti yapılandırması
- PATCH /api/addons/(int: id)/
Eklenti ile ilgili kısmi bilgileri düzenle.
- Parameters
id (int) – Eklenti kimliği
- Response JSON Object
configuration (object) – İsteğe bağlı eklenti yapılandırması
- PUT /api/addons/(int: id)/
Eklenti ile ilgili tüm bilgileri düzenle.
- Parameters
id (int) – Eklenti kimliği
- Response JSON Object
configuration (object) – İsteğe bağlı eklenti yapılandırması
- DELETE /api/addons/(int: id)/
Eklentiyi sil.
- Parameters
id (int) – Eklenti kimliği
Bileşen listeleri
4.0 sürümünde geldi.
- GET /api/component-lists/
Bileşen listelerinin bir listesini döndürür.
Ayrıca bakınız
Bileşen listesi nesne nitelikleri
GET /api/component-lists/(str:slug)/
adresinde belgelendirilmiştir.
- GET /api/component-lists/(str: slug)/
Bileşen listesi hakkında bilgi döndürür.
- Parameters
slug (string) – Bileşen listesi kısaltması
- Response JSON Object
name (string) – bir bileşen listesinin adı
slug (string) – bir bileşen listesinin kısaltması
show_dashboard (boolean) – bir panelde gösterilip gösterilmeyeceği
components (array) – link to associated components; see
GET /api/components/(string:project)/(string:component)/
auto_assign (array) – otomatik atama kuralları
- PUT /api/component-lists/(str: slug)/
Bileşen listesi parametrelerini değiştirir.
- Parameters
slug (string) – Bileşen listesi kısaltması
- Request JSON Object
name (string) – bir bileşen listesinin adı
slug (string) – bir bileşen listesinin kısaltması
show_dashboard (boolean) – bir panelde gösterilip gösterilmeyeceği
- PATCH /api/component-lists/(str: slug)/
Bileşen listesi parametrelerini değiştirir.
- Parameters
slug (string) – Bileşen listesi kısaltması
- Request JSON Object
name (string) – bir bileşen listesinin adı
slug (string) – bir bileşen listesinin kısaltması
show_dashboard (boolean) – bir panelde gösterilip gösterilmeyeceği
- DELETE /api/component-lists/(str: slug)/
Bileşen listesini siler.
- Parameters
slug (string) – Bileşen listesi kısaltması
- POST /api/component-lists/(str: slug)/components/
Bileşeni bir bileşen listesiyle ilişkilendir.
- Parameters
slug (string) – Bileşen listesi kısaltması
- Form Parameters
string component_id – Bileşen kimliği
- DELETE /api/component-lists/(str: slug)/components/(str: component_slug)
Bileşen listesinden bir bileşenin ilişkisini kaldır.
- Parameters
slug (string) – Bileşen listesi kısaltması
component_slug (string) – Component slug
Sözlük
4.5 sürümünde değişti: Glossaries are now stored as regular components, translations and strings, please use respective API instead.
Görevler
4.4 sürümünde geldi.
- GET /api/tasks/
Görevlerin listesi şu anda kullanılamıyor.
- GET /api/tasks/(str: uuid)/
Bir görevle ilgili bilgileri döndürür
- Parameters
uuid (string) – Görev UUID’si
- Response JSON Object
completed (boolean) – Görevin tamamlanıp tamamlanmadığı
progress (int) – Yüzde olarak görev ilerlemesi
result (object) – Görev sonucu veya ilerleme ayrıntıları
log (string) – Görev günlüğü
Metrics
- GET /api/metrics/
Returns server metrics.
- Response JSON Object
units (int) – Birim sayısı
units_translated (int) – Çevrilen birim sayısı
users (int) – Kullanıcı sayısı
changes (int) – Değişiklik sayısı
projects (int) – Proje sayısı
components" (int) – Bileşen sayısı
translations" (int) – Çeviri sayısı
languages" (int) – Kullanılan dil sayısı
checks" (int) – Tetiklenen kusur denetimleri sayısı
configuration_errors" (int) – Yapılandırma hataları sayısı
suggestions" (int) – Bekleyen öneri sayısı
celery_queues (object) – Lengths of Celery queues, see Background tasks using Celery
name (string) – Yapılandırılan sunucu adı
Bildirim kancaları
Notification hooks allow external applications to notify Weblate that the VCS repository has been updated.
You can use repository endpoints for projects, components and translations to
update individual repositories; see
POST /api/projects/(string:project)/repository/
for documentation.
- GET /hooks/update/(string: project)/(string: component)/
2.6 sürümünden beri kullanım dışı: Please use
POST /api/components/(string:project)/(string:component)/repository/
instead which works properly with authentication for ACL limited projects.Triggers update of a component (pulling from VCS and scanning for translation changes).
- GET /hooks/update/(string: project)/
2.6 sürümünden beri kullanım dışı: Please use
POST /api/projects/(string:project)/repository/
instead which works properly with authentication for ACL limited projects.Triggers update of all components in a project (pulling from VCS and scanning for translation changes).
- POST /hooks/github/
Special hook for handling GitHub notifications and automatically updating matching components.
Not
GitHub includes direct support for notifying Weblate: enable Weblate service hook in repository settings and set the URL to the URL of your Weblate installation.
Ayrıca bakınız
- Automatically receiving changes from GitHub
For instruction on setting up GitHub integration
- https://docs.github.com/en/github/extending-github/about-webhooks
Generic information about GitHub Webhooks
ENABLE_HOOKS
For enabling hooks for whole Weblate
- POST /hooks/gitlab/
Special hook for handling GitLab notifications and automatically updating matching components.
Ayrıca bakınız
- Automatically receiving changes from GitLab
For instruction on setting up GitLab integration
- https://docs.gitlab.com/ee/user/project/integrations/webhooks.html
Generic information about GitLab Webhooks
ENABLE_HOOKS
For enabling hooks for whole Weblate
- POST /hooks/bitbucket/
Special hook for handling Bitbucket notifications and automatically updating matching components.
Ayrıca bakınız
- Automatically receiving changes from Bitbucket
For instruction on setting up Bitbucket integration
- https://support.atlassian.com/bitbucket-cloud/docs/manage-webhooks/
Generic information about Bitbucket Webhooks
ENABLE_HOOKS
For enabling hooks for whole Weblate
- POST /hooks/pagure/
3.3 sürümünde geldi.
Special hook for handling Pagure notifications and automatically updating matching components.
Ayrıca bakınız
- Automatically receiving changes from Pagure
For instruction on setting up Pagure integration
- https://docs.pagure.org/pagure/usage/using_webhooks.html
Generic information about Pagure Webhooks
ENABLE_HOOKS
For enabling hooks for whole Weblate
- POST /hooks/azure/
3.8 sürümünde geldi.
Special hook for handling Azure Repos notifications and automatically updating matching components.
Ayrıca bakınız
- Automatically receiving changes from Azure Repos
For instruction on setting up Azure integration
- https://docs.microsoft.com/en-us/azure/devops/service-hooks/services/webhooks?view=azure-devops
Generic information about Azure Repos Web Hooks
ENABLE_HOOKS
For enabling hooks for whole Weblate
- POST /hooks/gitea/
3.9 sürümünde geldi.
Special hook for handling Gitea Webhook notifications and automatically updating matching components.
Ayrıca bakınız
- Automatically receiving changes from Gitea Repos
For instruction on setting up Gitea integration
- https://docs.gitea.io/en-us/webhooks/
Generic information about Gitea Webhooks
ENABLE_HOOKS
For enabling hooks for whole Weblate
- POST /hooks/gitee/
3.9 sürümünde geldi.
Special hook for handling Gitee Webhook notifications and automatically updating matching components.
Ayrıca bakınız
- Automatically receiving changes from Gitee Repos
For instruction on setting up Gitee integration
- https://gitee.com/help/categories/40
Generic information about Gitee Webhooks
ENABLE_HOOKS
For enabling hooks for whole Weblate
Exports
Weblate provides various exports to allow you to further process the data.
- GET /exports/stats/(string: project)/(string: component)/
- Query Parameters
format (string) – Output format: either
json
orcsv
2.6 sürümünden beri kullanım dışı: Please use
GET /api/components/(string:project)/(string:component)/statistics/
andGET /api/translations/(string:project)/(string:component)/(string:language)/statistics/
instead; it allows access to ACL controlled projects as well.Retrieves statistics for given component in given format.
Example request:
GET /exports/stats/weblate/main/ HTTP/1.1 Host: example.com Accept: application/json, text/javascript
Example response:
HTTP/1.1 200 OK Vary: Accept Content-Type: application/json [ { "code": "cs", "failing": 0, "failing_percent": 0.0, "fuzzy": 0, "fuzzy_percent": 0.0, "last_author": "Michal Čihař", "last_change": "2012-03-28T15:07:38+00:00", "name": "Czech", "total": 436, "total_words": 15271, "translated": 436, "translated_percent": 100.0, "translated_words": 3201, "url": "http://hosted.weblate.org/engage/weblate/cs/", "url_translate": "http://hosted.weblate.org/projects/weblate/main/cs/" }, { "code": "nl", "failing": 21, "failing_percent": 4.8, "fuzzy": 11, "fuzzy_percent": 2.5, "last_author": null, "last_change": null, "name": "Dutch", "total": 436, "total_words": 15271, "translated": 319, "translated_percent": 73.2, "translated_words": 3201, "url": "http://hosted.weblate.org/engage/weblate/nl/", "url_translate": "http://hosted.weblate.org/projects/weblate/main/nl/" }, { "code": "el", "failing": 11, "failing_percent": 2.5, "fuzzy": 21, "fuzzy_percent": 4.8, "last_author": null, "last_change": null, "name": "Greek", "total": 436, "total_words": 15271, "translated": 312, "translated_percent": 71.6, "translated_words": 3201, "url": "http://hosted.weblate.org/engage/weblate/el/", "url_translate": "http://hosted.weblate.org/projects/weblate/main/el/" } ]
RSS bildirimleri
Çevirilerdeki değişiklikler RSS bildirimlerinde dışa aktarılır.
- GET /exports/rss/(string: project)/(string: component)/(string: language)/
Bir çeviri için son değişiklikleri içeren RSS bildirimini alır.
- GET /exports/rss/(string: project)/(string: component)/
Bir bileşen için son değişiklikleri içeren RSS bildirimini alır.
- GET /exports/rss/(string: project)/
Bir proje için son değişiklikleri içeren RSS bildirimini alır.
- GET /exports/rss/language/(string: language)/
Bir dil için son değişiklikleri içeren RSS bildirimini alır.
- GET /exports/rss/
Weblate örneği için son değişiklikleri içeren RSS bildirimini alır.
Ayrıca bakınız