Weblate REST API uygulaması#
API erişimi için /api/
adresi kullanılabilir. API Django REST framework üzerine geliştirilmiştir. Doğrudan ya da :ref:`wlc’ ile kullanabilirsiniz.
Kimlik doğrulama ve genel parametreler#
Herkese açık proje API uygulaması kimlik doğrulaması olmadan kullanılabilir. Ancak kimliği doğrulanmamış istekler yoğun şekilde kısıtlanır (varsayılan olarak günde 100 istek). Bu nedenle kimlik doğrulamasının kullanılması önerilir. Kimlik doğrulamasında, profilinizden alabileceğiniz bir kod kullanılır. Bunu Yetkilendirme
üst bilgisinde kullanın:
- ANY /#
API için genel istek davranışı, buradaki üst bilgiler, durum kodları ve parametreler tüm uç noktalara da uygulanır.
- Sorgu parametreleri:
format – Yanıt biçimi (Accept değiştirir). Olası değerler REST çatısının kurulumuna bağlıdır. Varsayılan olarak
json
veapi
desteklenir. İkincisi, API için tarayıcı arayüzünü sağlar.page – Sayfalanmış sonuçların belirtilen sayfasını görüntüler (gezinmeyi otomatikleştirmek için yanıtta next ve previous alanlarını kullanın).
- İstek üst bilgileri:
Authorization – Kimlik doğrulaması için
Authorization: Token BELIRTECİNİZ
olarak isteğe bağlı belirteç
- Yanıt üst bilgileri:
Content-Type – bu parametre, isteğin Accept üst bilgisine bağlıdır
Allow – Nesne için izin verilen HTTP yöntemlerinin listesi
- Yanıt JSON nesnesi:
detail (string) – Sonucun ayrıntılı açıklaması (200 OK dışındaki HTTP durum kodları için)
count (int) – Nesne listelerindeki toplam öge sayısı
next (string) – Nesne listeleri için sonraki sayfa adresi
previous (string) – Nesne listeleri için önceki sayfa adresi
results (array) – Nesne listelerinin sonuçları
url (string) – API ile bu kaynağa erişme adresi
web_url (string) – Tarayıcı ile bu kaynağa erişme adresi
- Durum kodları:
200 OK – istek düzgün olarak işlendiğinde
201 Created – yeni bir nesne sorunsuz oluşturulduğunda
204 No Content – bir nesne sorunsuz silindiğinde
400 Bad Request – form parametreleri eksik olduğunda
403 Forbidden – erişim reddedildiğinde
429 Too Many Requests – hız sınırlaması uygulandığında
Kimlik doğrulama kodları#
4.10 sürümünde değişti: Proje kapsamlı kodlar 4.10 sürümünde tanıtıldı.
Her kullanıcının, kendi kullanıcı profilinden öğrenilebileceği kişisel erişim kodu vardır. Yeni oluşturulan kullanıcı kodlarında wlu_
ön eki bulunur.
Yalnızca belirli bir projeye API erişimi sağlamak için proje kapsamlı kodlar oluşturulabilir. Bu belirteçler wlp_
ön ekiyle anlaşılabilir.
Kimlik doğrulama örnekleri#
Örnek istek:
GET /api/ HTTP/1.1
Host: example.com
Accept: application/json, text/javascript
Authorization: Token YOUR-TOKEN
Örnek yanıt:
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 örneği:
curl \
-H "Authorization: Token TOKEN" \
https://example.com/api/
Parametre aktarma örnekleri#
POST yöntemi için parametreler form gönderimi (application/x-www-form-urlencoded) ya da JSON (application/json) olarak belirtilebilir.
Form isteği örneği:
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 isteği örneği:
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 örneği:
curl \
-d operation=pull \
-H "Authorization: Token TOKEN" \
http://example.com/api/components/hello/weblate/repository/
CURL JSON örneği:
curl \
--data-binary '{"operation":"pull"}' \
-H "Content-Type: application/json" \
-H "Authorization: Token TOKEN" \
http://example.com/api/components/hello/weblate/repository/
Bileşenler ve kategoriler#
Bir Kategori içindeki iç içe geçmiş bir bileşene erişmek için, adresi yazarken bileşen adına bölü karakteriyle kategori adını eklemeniz gerekir. Örneğin docs
kategorisine eklenmiş usage
için docs%252Fusage
yazmalısınız. Bu durumda tam adres https://ornek.com/api/components/hello/docs%252Fusage/repository/
olabilir.
API hız sınırlaması#
API isteklerinin hızı sınırlanmıştır; Varsayılan yapılandırmada anonim kullanıcılar için günde 100 istek ve kimliği doğrulanmış kullanıcılar için saatte 5000 istek sınırı bulunur.
Hız sınırlaması settings.py
dosyasından ayarlanabilir. Nasıl yapılandırılacağı ile ilgili ayrıntılı bilgi almak için Throttling in Django REST framework documentation bölümüne bakabilirsiniz.
Docker kapsayıcısında hız sınırlaması WEBLATE_API_RATELIMIT_ANON
ve WEBLATE_API_RATELIMIT_USER
seçenekleri kullanılarak yapılandırılabilir.
Hız sınırlamasının durumu şu üst bilgiler ile bildirilir:
|
Yapılacak isteklerin hız sınırlama sınırı |
|
Kalan istek sınırı |
|
Saniye olarak hız sınırlama penceresinin sıfırlanma süresi |
4.1 sürümünde değişti: Eklenen hız sınırlaması durumu üst bilgileri.
Ayrıca bakınız
Hızı sınırlamak,
Hızı sınırlamak,
WEBLATE_API_RATELIMIT_ANON
,
WEBLATE_API_RATELIMIT_USER
API giriş noktası#
- GET /api/#
API kök giriş noktası.
Örnek istek:
GET /api/ HTTP/1.1 Host: example.com Accept: application/json, text/javascript Authorization: Token YOUR-TOKEN
Örnek yanıt:
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/#
Kullanıcıları yönetme izniniz varsa kullanıcı listesini görüntüler. Yoksa, yalnızca kendi bilgilerinizi görüntüler.
Ayrıca bakınız
Kullanıcı nesnesi öznitelikleri
GET /api/users/(str:username)/
bölümünde bulunabilir.
- POST /api/users/#
Yeni bir kullanıcı oluşturur.
- Parametreler:
username (string) – Kullanıcı adı
full_name (string) – Kullanıcının tam adı
email (string) – Kullanıcının e-posta adresi
is_superuser (boolean) – Kullanıcı süper kullanıcı mı? (isteğe bağlı)
is_active (boolean) – Kullanıcı etkin mi? (isteğe bağlı)
is_bot (boolean) – Kullanıcı bot mu? (isteğe bağlı) (proje kapsamındaki belirteçler için kullanılır)
- GET /api/users/(str: username)/#
Kullanıcılar hakkındaki bilgileri görüntüler.
- Parametreler:
username (string) – Kullanıcının kullanıcı adı
- Yanıt JSON nesnesi:
username (string) – bir kullanıcının kullanıcı adı
full_name (string) – bir kullanıcının tam adı
email (string) – bir kullanıcının e-posta adresi
is_superuser (boolean) – kullanıcının süper kullanıcı olup olmadığı
is_active (boolean) – kullanıcının etkin olup olmadığı
is_bot (boolean) – kullanıcının bot olup olmadığı (proje kapsamındaki belirteçler için kullanılır)
date_joined (string) – kullanıcının oluşturulduğu tarih
last_login (string) – kullanıcının son oturum açtığı tarih
groups (array) – ilişkili grup bağlantıları. Bilgi almak için:
GET /api/groups/(int:id)/
Örnek JSON verileri:
{ "email": "user@example.com", "full_name": "Example User", "username": "exampleusername", "groups": [ "http://example.com/api/groups/2/", "http://example.com/api/groups/3/" ], "is_superuser": true, "is_active": true, "is_bot": false, "date_joined": "2020-03-29T18:42:42.617681Z", "url": "http://example.com/api/users/exampleusername/", "statistics_url": "http://example.com/api/users/exampleusername/statistics/" }
- PUT /api/users/(str: username)/#
Kullanıcı parametrelerini değiştirir.
- Parametreler:
username (string) – Kullanıcının kullanıcı adı
- Yanıt JSON nesnesi:
username (string) – bir kullanıcının kullanıcı adı
full_name (string) – bir kullanıcının tam adı
email (string) – bir kullanıcının e-posta adresi
is_superuser (boolean) – kullanıcının süper kullanıcı olup olmadığı
is_active (boolean) – kullanıcının etkin olup olmadığı
is_bot (boolean) – kullanıcının bot olup olmadığı (proje kapsamındaki belirteçler için kullanılır)
date_joined (string) – kullanıcının oluşturulduğu tarih
- PATCH /api/users/(str: username)/#
Kullanıcı parametrelerini değiştirir.
- Parametreler:
username (string) – Kullanıcının kullanıcı adı
- Yanıt JSON nesnesi:
username (string) – bir kullanıcının kullanıcı adı
full_name (string) – bir kullanıcının tam adı
email (string) – bir kullanıcının e-posta adresi
is_superuser (boolean) – kullanıcının süper kullanıcı olup olmadığı
is_active (boolean) – kullanıcının etkin olup olmadığı
is_bot (boolean) – kullanıcının bot olup olmadığı (proje kapsamındaki belirteçler için kullanılır)
date_joined (string) – kullanıcının oluşturulduğu tarih
- DELETE /api/users/(str: username)/#
Tüm kullanıcı bilgilerini siler ve kullanıcıyı etkin değil olarak imler.
- Parametreler:
username (string) – Kullanıcının kullanıcı adı
- POST /api/users/(str: username)/groups/#
Grupları bir kullanıcı ile ilişkilendirir.
- Parametreler:
username (string) – Kullanıcının kullanıcı adı
- Form parametreleri:
string group_id – Benzersiz grup kimliği
- DELETE /api/users/(str: username)/groups/#
4.13.1 sürümünde geldi.
Kullanıcıyı bir gruptan kaldır.
- Parametreler:
username (string) – Kullanıcının kullanıcı adı
- Form parametreleri:
string group_id – Benzersiz grup kimliği
- GET /api/users/(str: username)/statistics/#
Bir kullanıcının istatistiklerini görüntüle.
- Parametreler:
username (string) – Kullanıcının kullanıcı adı
- Yanıt JSON nesnesi:
translated (int) – Kullanıcının yaptığı çeviri sayısı
suggested (int) – Kullanıcının yaptığı öneri sayısı
uploaded (int) – Kullanıcının yaptığı yükleme sayısı
commented (int) – Kullanıcının yaptığı yorum sayısı
languages (int) – Kullanıcının çevirebileceği dil sayısı
- GET /api/users/(str: username)/notifications/#
Bir kullanıcının aboneliklerini görüntüler.
- Parametreler:
username (string) – Kullanıcının kullanıcı adı
- POST /api/users/(str: username)/notifications/#
Abonelikleri bir kullanıcıyla ilişkilendirir.
- Parametreler:
username (string) – Kullanıcının kullanıcı adı
- JSON nesnesi ister:
notification (string) – Kayıtlı bildirimin adı
scope (int) – Var olan seçeneklerden bildirim kapsamı
frequency (int) – Bildirimler için sıklık seçenekleri
- GET /api/users/(str: username)/notifications/(int: subscription_id)/#
Bir kullanıcıyla ilişkilendirilmiş bir aboneliği alır.
- Parametreler:
username (string) – Kullanıcının kullanıcı adı
subscription_id (int) – Kayıtlı bildirim kimliği
- PUT /api/users/(str: username)/notifications/(int: subscription_id)/#
Bir kullanıcıyla ilişkili aboneliği düzenler.
- Parametreler:
username (string) – Kullanıcının kullanıcı adı
subscription_id (int) – Kayıtlı bildirim kimliği
- JSON nesnesi ister:
notification (string) – Kayıtlı bildirimin adı
scope (int) – Var olan seçeneklerden bildirim kapsamı
frequency (int) – Bildirimler için sıklık seçenekleri
- PATCH /api/users/(str: username)/notifications/(int: subscription_id)/#
Bir kullanıcıyla ilişkili aboneliği düzenler.
- Parametreler:
username (string) – Kullanıcının kullanıcı adı
subscription_id (int) – Kayıtlı bildirim kimliği
- JSON nesnesi ister:
notification (string) – Kayıtlı bildirimin adı
scope (int) – Var olan seçeneklerden bildirim kapsamı
frequency (int) – Bildirimler için sıklık seçenekleri
- DELETE /api/users/(str: username)/notifications/(int: subscription_id)/#
Bir kullanıcıyla ilişkili aboneliği siler.
- Parametreler:
username (string) – Kullanıcının kullanıcı adı
subscription_id – Kayıtlı bildirimin adı
subscription_id – tamsayı
Gruplar#
4.0 sürümünde geldi.
- GET /api/groups/#
Grupları yönetme izniniz varsa grupların listesini görüntüler. Yoksa, yalnızca kullanıcının parçası olduğu grupları görüntüler.
Ayrıca bakınız
Grup nesnesi öznitelikleri
GET /api/groups/(int:id)/
bölümünde bulunabilir.
- POST /api/groups/#
Yeni bir grup oluşturur.
- Parametreler:
name (string) – Grup adı
project_selection (int) – Belirtilen seçeneklerden proje seçimi grubu
language_selection (int) – Belirtilen seçeneklerden seçilmiş dil grubu
defining_project (str) – Her proje için erişim denetimi yönetimi için kullanılan tanımlayıcı proje bağlantısı. Bilgi almak için:
GET /api/projects/(string:project)/
- GET /api/groups/(int: id)/#
Grup hakkındaki bilgileri görüntüler.
- Parametreler:
id (int) – Grubun kimliği
- Yanıt JSON nesnesi:
name (string) – bir grubun adı
project_selection (int) – proje grubuna karşılık gelen tamsayı
language_selection (int) – dil grubuna karşılık gelen tamsayı
roles (array) – ilişkili rollerin bağlantısı. Bilgi almak için:
GET /api/roles/(int:id)/
projects (array) – ilişkili projelerin bağlantısı. Bilgi almak için:
GET /api/projects/(string:project)/
components (array) – ilişkili bileşenlerin bağlantısı. Bilgi almak için:
GET /api/components/(string:project)/(string:component)/
componentlists (array) – ilişkili bileşen listelerinin bağlantısı. Bilgi almak için:
GET /api/component-lists/(str:slug)/
defining_project (str) – Her proje için erişim denetimi yönetimi için kullanılan tanımlayıcı proje bağlantısı. Bilgi almak için:
GET /api/projects/(string:project)/
Örnek JSON verileri:
{ "name": "Guests", "defining_project": null, "project_selection": 3, "language_selection": 1, "url": "http://example.com/api/groups/1/", "roles": [ "http://example.com/api/roles/1/", "http://example.com/api/roles/2/" ], "languages": [ "http://example.com/api/languages/en/", "http://example.com/api/languages/cs/", ], "projects": [ "http://example.com/api/projects/demo1/", "http://example.com/api/projects/demo/" ], "componentlist": "http://example.com/api/component-lists/new/", "components": [ "http://example.com/api/components/demo/weblate/" ] }
- PUT /api/groups/(int: id)/#
Grup parametrelerini değiştirir.
- Parametreler:
id (int) – Grubun kimliği
- Yanıt JSON nesnesi:
name (string) – bir grubun adı
project_selection (int) – proje grubuna karşılık gelen tamsayı
language_selection (int) – dil grubuna karşılık gelen tamsayı
- PATCH /api/groups/(int: id)/#
Grup parametrelerini değiştirir.
- Parametreler:
id (int) – Grubun kimliği
- Yanıt JSON nesnesi:
name (string) – bir grubun adı
project_selection (int) – proje grubuna karşılık gelen tamsayı
language_selection (int) – dil grubuna karşılık gelen tamsayı
- DELETE /api/groups/(int: id)/#
Grubu siler.
- Parametreler:
id (int) – Grubun kimliği
- POST /api/groups/(int: id)/roles/#
Rolleri bir grupla ilişkilendirir.
- Parametreler:
id (int) – Grubun kimliği
- Form parametreleri:
string role_id – Benzersiz rol kimliği
- POST /api/groups/(int: id)/components/#
Bileşenleri bir grupla ilişkilendirir.
- Parametreler:
id (int) – Grubun kimliği
- Form parametreleri:
string component_id – Benzersiz bileşen kimliği
- DELETE /api/groups/(int: id)/components/(int: component_id)#
Bileşeni bir gruptan siler.
- Parametreler:
id (int) – Grubun kimliği
component_id (int) – Benzersiz bileşen kimliği
- POST /api/groups/(int: id)/projects/#
Projeleri bir grupla ilişkilendirir.
- Parametreler:
id (int) – Grubun kimliği
- Form parametreleri:
string project_id – Benzersiz proje kimliği
- DELETE /api/groups/(int: id)/projects/(int: project_id)#
Projeyi bir gruptan siler.
- Parametreler:
id (int) – Grubun kimliği
project_id (int) – Benzersiz proje kimliği
- POST /api/groups/(int: id)/languages/#
Dilleri bir grupla ilişkilendirir.
- Parametreler:
id (int) – Grubun kimliği
- Form parametreleri:
string language_code – Benzersiz dil kodu
- DELETE /api/groups/(int: id)/languages/(string: language_code)#
Dili bir gruptan siler.
- Parametreler:
id (int) – Grubun kimliği
language_code (string) – Benzersiz dil kodu
- POST /api/groups/(int: id)/componentlists/#
Bileşen listelerini bir grupla ilişkilendirir.
- Parametreler:
id (int) – Grubun kimliği
- Form parametreleri:
string component_list_id – Benzersiz bileşen listesi kimliği
- DELETE /api/groups/(int: id)/componentlists/(int: component_list_id)#
Bileşen listesini bir gruptan siler.
- Parametreler:
id (int) – Grubun kimliği
component_list_id (int) – Benzersiz bileşen listesi kimliği
Roller#
- GET /api/roles/#
Kullanıcıyla ilişkili tüm rollerin listesini görüntüler. Kullanıcı süper kullanıcıysa, var olan tüm rollerin listesini görüntüler.
Ayrıca bakınız
Roller nesnesi öznitelikleri
GET /api/roles/(int:id)/
bölümünde bulunabilir.
- POST /api/roles/#
Yeni bir rol oluşturur.
- Parametreler:
name (string) – Rol adı
permissions (array) – İzinlerin kod adı listesi
- GET /api/roles/(int: id)/#
Bir rol hakkındaki bilgileri görüntüler.
- Parametreler:
id (int) – Rol kimliği
- Yanıt JSON nesnesi:
name (string) – Rol adı
permissions (array) – izinlerin kod adı listesi
Örnek JSON verileri:
{ "name": "Access repository", "permissions": [ "vcs.access", "vcs.view" ], "url": "http://example.com/api/roles/1/", }
- PUT /api/roles/(int: id)/#
Rol parametrelerini değiştirir.
- Parametreler:
id (int) – Rolün kimliği
- Yanıt JSON nesnesi:
name (string) – Rol adı
permissions (array) – izinlerin kod adı listesi
- PATCH /api/roles/(int: id)/#
Rol parametrelerini değiştirir.
- Parametreler:
id (int) – Rolün kimliği
- Yanıt JSON nesnesi:
name (string) – Rol adı
permissions (array) – izinlerin kod adı listesi
- DELETE /api/roles/(int: id)/#
Rolü siler.
- Parametreler:
id (int) – Rolün kimliği
Diller#
- GET /api/languages/#
Tüm dillerin listesini görüntüler.
Ayrıca bakınız
Dil nesnesi öznitelikleri
GET /api/languages/(string:language)/
bölümünde bulunabilir.
- POST /api/languages/#
Yeni bir dil oluşturur.
- Parametreler:
code (string) – Dil adı
name (string) – Dil adı
direction (string) – Metin yönü
population (int) – Konuşan sayısı
plural (object) – Dil çoğul formülü ve sayısı
- GET /api/languages/(string: language)/#
Bir dil hakkındaki bilgileri görüntüler.
- Parametreler:
language (string) – Dil kodu
- Yanıt JSON nesnesi:
code (string) – Dil kodu
direction (string) – Metin yönü
plural (object) – Dil çoğul bilgisinin nesnesi
aliases (array) – Dil için takma adlar dizisi
- JSON nesnesi ister:
population (int) – Konuşan sayısı
Örnek JSON verileri:
{ "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)/#
Dil parametrelerini değiştirir.
- Parametreler:
language (string) – Dilin kodu
- JSON nesnesi ister:
name (string) – Dil adı
direction (string) – Metin yönü
population (int) – Konuşan sayısı
plural (object) – Dil çoğul ayrıntıları
- PATCH /api/languages/(string: language)/#
Dil parametrelerini değiştirir.
- Parametreler:
language (string) – Dilin kodu
- JSON nesnesi ister:
name (string) – Dil adı
direction (string) – Metin yönü
population (int) – Konuşan sayısı
plural (object) – Dil çoğul ayrıntıları
- DELETE /api/languages/(string: language)/#
Dili siler.
- Parametreler:
language (string) – Dilin kodu
- GET /api/languages/(string: language)/statistics/#
Bir dilin istatistiklerini görüntüler.
- Parametreler:
language (string) – Dil kodu
Ayrıca bakınız
Geri dönen öznitelikler İstatistikler bölümünde açıklanmıştır.
Projeler#
- GET /api/projects/#
Tüm projelerin listesini görüntüler.
Ayrıca bakınız
Proje nesnesi öznitelikleri
GET /api/projects/(string:project)/
bölümünde bulunabilir.
- POST /api/projects/#
Yeni bir proje oluşturur.
- Parametreler:
name (string) – Proje adı
slug (string) – Proje kısaltması
web (string) – Proje sitesi
- GET /api/projects/(string: project)/#
Bir proje hakkındaki bilgileri görüntüler.
- Parametreler:
project (string) – Proje adresi kısaltması
- Yanıt JSON nesnesi:
name (string) – proje adı
slug (string) – proje kısaltması
web (string) – proje sitesi
components_list_url (string) – Bileşen listesi adresi. Bilgi almak için:
GET /api/projects/(string:project)/components/
repository_url (string) – Depo durumu adresi. Bilgi almak için:
GET /api/projects/(string:project)/repository/
changes_list_url (string) – Değişiklikler listesi adresi. Bilgi almak için:
GET /api/projects/(string:project)/changes/
translation_review (boolean) – Onaylama kullanılsın
source_review (boolean) – Kaynak onaylama kullanılsın
set_language_team (boolean) – “Language-Team” üst bilgisi ayarlansın
enable_hooks (boolean) – Kancalar kullanılsın
instructions (string) – Çeviri yönergeleri
language_aliases (string) – Dil kod adları
Örnek JSON verileri:
{ "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.
Bir projeyi PATCH isteğiyle düzenler.
- Parametreler:
project (string) – Proje adresi kısaltması
component (string) – Bileşen adresinin kısaltması
- PUT /api/projects/(string: project)/#
4.3 sürümünde geldi.
Bir projeyi PUT isteğiyle düzenler.
- Parametreler:
project (string) – Proje adresi kısaltması
- DELETE /api/projects/(string: project)/#
Bir projeyi siler.
- Parametreler:
project (string) – Proje adresi kısaltması
- GET /api/projects/(string: project)/changes/#
Proje değişikliklerinin listesini görüntüler. Temelde
GET /api/changes/
kapsamıyla aynı parametreleri kabul eden bir projedir.- Parametreler:
project (string) – Proje adresi kısaltması
- Yanıt JSON nesnesi:
results (array) – bileşen nesnelerinin dizisi. Bilgi almak için:
GET /api/changes/(int:id)/
- GET /api/projects/(string: project)/repository/#
Sürüm denetimi sistemi deposunun durumu ile ilgili bilgileri görüntüler. Bu noktada, projenin tüm depoları için yalnızca genel bir özet bulunur. Daha ayrıntılı durum bilgileri almak için
GET /api/components/(string:project)/(string:component)/repository/
kullanın.- Parametreler:
project (string) – Proje adresi kısaltması
- Yanıt JSON nesnesi:
needs_commit (boolean) – işlenebilecek bekleyen değişikliklerin olup olmadığı
needs_merge (boolean) – aktarılabilecek herhangi bir yukarı akış değişikliğinin olup olmadığı
needs_push (boolean) – itilecek herhangi bir yerel değişikliğin olup olmadığı
Örnek JSON verileri:
{ "needs_commit": true, "needs_merge": false, "needs_push": true }
- POST /api/projects/(string: project)/repository/#
Sürüm denetimi sistemi deposunda belirtilen işlemi gerçekleştirir.
- Parametreler:
project (string) – Proje adresi kısaltması
- JSON nesnesi ister:
operation (string) – Yürütülecek işlem:
push
,pull
,commit
,reset
,cleanup
,file-sync
ya dafile-scan
olabilir
- Yanıt JSON nesnesi:
result (boolean) – işlemin sonucu
CURL örneği:
curl \ -d operation=pull \ -H "Authorization: Token TOKEN" \ http://example.com/api/projects/hello/repository/
JSON isteği örneği:
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 yanıtı örneği:
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/#
Belirtilen projedeki çeviri bileşenlerinin listesini görüntüler.
- Parametreler:
project (string) – Proje adresi kısaltması
- Yanıt JSON nesnesi:
results (array) – bileşen nesneleri dizisi. Bilgi almak için:
GET /api/components/(string:project)/(string:component)/
- POST /api/projects/(string: project)/components/#
4.3 sürümünde değişti: Sürüm denetimi sistemi kullanmayan bileşenler için de
zipfile
vedocfile
parametreleri kabul edilir. Bilgi almak için: Yerel dosyalar.4.6 sürümünde değişti: Kopyalanan depolar İç Weblate adresleri kullanılarak kendiliğinden bir proje içinde paylaşılabilir. Bu özelliği kapatmak için
disable_autoshare
seçeneğini kullanın.Belirtilen projede çeviri bileşenleri oluşturur.
İpucu
Tek bir sürüm denetimi sistemi deposundan birden fazla bileşen oluştururken İç Weblate adresleri seçeneğini kullanın.
Not
Bileşen oluşturma işleminin çoğu arka planda yapılır. Oluşturulan bileşenin
task_url
özniteliğini denetleyin ve oradaki ilerlemeyi izleyin.- Parametreler:
project (string) – Proje adresi kısaltması
- Form parametreleri:
file zipfile – Çevirilerin başlatılması için Weblate üzerine yüklenecek ZIP dosyası
file docfile – Çevrilecek belge
boolean disable_autoshare – İç Weblate adresleri seçeneği ile kendiliğinden depo paylaşımını devre dışı bırakır.
- JSON nesnesi ister:
object – Bileşen parametreleri. Ayrıntılı bilgi almak için
GET /api/components/(string:project)/(string:component)/
- Yanıt JSON nesnesi:
result (object) – Oluşturulan bileşen nesnesi. Bilgi almak için:
GET /api/components/(string:project)/(string:component)/
Dosyalar
zipfile
vedocfile
parametreleri kullanılarak yüklenirken JSON kullanılamaz. Veriler multipart/form-data olarak yüklenmelidir.CURL form isteği örneği:
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 isteği örneği:
curl \ --data-binary '{ "branch": "main", "file_format": "po", "filemask": "po/*.po", "name": "Weblate", "slug": "weblate", "repo": "https://github.com/WeblateOrg/hello.git", "template": "", "new_base": "po/hello.pot", "vcs": "git" }' \ -H "Content-Type: application/json" \ -H "Authorization: Token TOKEN" \ http://example.com/api/projects/hello/components/
Git üzerinden yeni bir bileşen oluşturan JSON isteği:
POST /api/projects/hello/components/ HTTP/1.1 Host: example.com Accept: application/json Content-Type: application/json Authorization: Token TOKEN Content-Length: 20 { "branch": "main", "file_format": "po", "filemask": "po/*.po", "name": "Weblate", "slug": "weblate", "repo": "https://github.com/WeblateOrg/hello.git", "template": "", "new_base": "po/hello.pot", "vcs": "git" }
Başka bir bileşenden yeni bir bileşen oluşturan JSON isteği:
POST /api/projects/hello/components/ HTTP/1.1 Host: example.com Accept: application/json Content-Type: application/json Authorization: Token TOKEN Content-Length: 20 { "file_format": "po", "filemask": "po/*.po", "name": "Weblate", "slug": "weblate", "repo": "weblate://weblate/hello", "template": "", "new_base": "po/hello.pot", "vcs": "git" }
JSON yanıtı örneği:
HTTP/1.0 200 OK Date: Tue, 12 Apr 2016 09:32:50 GMT Server: WSGIServer/0.1 Python/2.7.11+ Vary: Accept, Accept-Language, Cookie X-Frame-Options: SAMEORIGIN Content-Type: application/json Content-Language: en Allow: GET, POST, HEAD, OPTIONS { "branch": "main", "file_format": "po", "filemask": "po/*.po", "git_export": "", "license": "", "license_url": "", "name": "Weblate", "slug": "weblate", "project": { "name": "Hello", "slug": "hello", "source_language": { "code": "en", "direction": "ltr", "population": 159034349015, "name": "English", "url": "http://example.com/api/languages/en/", "web_url": "http://example.com/languages/en/" }, "url": "http://example.com/api/projects/hello/", "web": "https://weblate.org/", "web_url": "http://example.com/projects/hello/" }, "repo": "file:///home/nijel/work/weblate-hello", "template": "", "new_base": "", "url": "http://example.com/api/components/hello/weblate/", "vcs": "git", "web_url": "http://example.com/projects/hello/weblate/" }
- GET /api/projects/(string: project)/languages/#
Bir projedeki tüm diller için sayfalanmış istatistikleri görüntüler.
- Parametreler:
project (string) – Proje adresi kısaltması
- Yanıt JSON nesnesi:
results (array) – çeviri istatistiği nesneleri dizisi
language (string) – dil adı
code (string) – dil kodu
total (int) – toplam dizge sayısı
translated (int) – çevrilmiş dizge sayısı
translated_percent (float) – çevrilmiş dizge yüzdesi
total_words (int) – toplam sözcük sayısı
translated_words (int) – çevrilmiş sözcük sayısı
words_percent (float) – çevrilmiş sözcük yüzdesi
- GET /api/projects/(string: project)/statistics/#
Bir projenin istatistiklerini görüntüler.
- Parametreler:
project (string) – Proje adresi kısaltması
Ayrıca bakınız
Geri dönen öznitelikler İstatistikler bölümünde açıklanmıştır.
- GET /api/projects/(string: project)/categories/#
5.0 sürümünde geldi: Bir projenin istatistiklerini görüntüler. Alan tanımları için
GET /api/categories/(int:id)/
bölümüne bakabilirsiniz.- proje parametresi:
Proje adresi kısaltması
- proje türü:
dizge
Bileşenler#
İpucu
Yeni bileşenler oluşturmak için POST /api/projects/(string:project)/components/
kullanın.
- GET /api/components/#
Çeviri bileşenlerinin listesini görüntüler.
Ayrıca bakınız
Bileşen nesnesi özenitelikleri
GET /api/components/(string:project)/(string:component)/
bölümünde bulunabilir.
- GET /api/components/(string: project)/(string: component)/#
Çeviri bileşeni hakkındaki bilgileri görüntüler.
- Parametreler:
project (string) – Proje adresi kısaltması
component (string) – Bileşen adresinin kısaltması
- Yanıt JSON nesnesi:
project (object) – çeviri projesi. Bilgi almak için
GET /api/projects/(string:project)/
name (string) – Bileşen adı
slug (string) – Bileşen kısaltması
vcs (string) – Sürüm denetimi sistemi
repo (string) – Kaynak kod deposu
git_export (string) – Dışa aktarılmış depo adresi
branch (string) – Depo dalı
push_branch (string) – İtme işleminin yapılacağı dal
filemask (string) – Dosya maskesi
template (string) – Tek dilli temel dil dosyası
edit_template (string) – Temel 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ı anlaşması
new_lang (string) – Yeni çeviri ekleme
language_code_style (string) – Dil kodu biçemi
source_language (object) – kaynak dil nesnesi. Ayrıntılı bilgi alın
GET /api/languages/(string:language)/
push (string) – Depo itme adresi
check_flags (string) – Çeviri imleri
priority (string) – Öncelik
enforced_checks (string) – Zorunlu denetimler
restricted (string) – Kısıtlı erişim
repoweb (string) – Depo tarayıcısı
report_source_bugs (string) – Kaynak dizge hata bildirme adresi
merge_style (string) – Birleştirme biçemi
commit_message (string) – İşleme, ekleme, silme, birleştirme, eklenti ve birleştirme istek iletileri
add_message (string) – İşleme, ekleme, silme, birleştirme, eklenti ve birleştirme istek iletileri
delete_message (string) – İşleme, ekleme, silme, birleştirme, eklenti ve birleştirme istek iletileri
merge_message (string) – İşleme, ekleme, silme, birleştirme, eklenti ve birleştirme istek iletileri
addon_message (string) – İşleme, ekleme, silme, birleştirme, eklenti ve birleştirme istek iletileri
pull_message (string) – İşleme, ekleme, silme, birleştirme, eklenti ve birleştirme istek iletileri
allow_translation_propagation (string) – Çevirilerin yayılmasını sağlamak
enable_suggestions (string) – Öneriler kullanılsın
suggestion_voting (string) – Öneriler oylanabilsin
suggestion_autoaccept (string) – Öneriler kendiliğinden kabul edilsin
push_on_commit (string) – İşleme ile itme
commit_pending_age (string) – İşlenecek değişikliklerin yaşı
auto_lock_error (string) – Hata durumunda kilitlenme
language_regex (string) – Dil süzgeci
variant_regex (string) – Çeşitler kurallı ifadesi
is_glossary (bool) – Sözlük olarak kullanılsın
glossary_color (string) – Sözlük rengi
repository_url (string) – Depo durumu adresi. Bilgi almak için:
GET /api/components/(string:project)/(string:component)/repository/
translations_url (string) – Çeviri listesi adresi. Bilgi almak için:
GET /api/components/(string:project)/(string:component)/translations/
lock_url (string) – Kilit durumu adresi. Bilgi almak için:
GET /api/components/(string:project)/(string:component)/lock/
changes_list_url (string) – Değişiklik listesi adresi. Bilgi almak için:
GET /api/components/(string:project)/(string:component)/changes/
task_url (string) – Arka plan görevi (varsa) adresi. Bilgi almak için:
GET /api/tasks/(str:uuid)/
Örnek JSON verileri:
{ "branch": "main", "file_format": "po", "filemask": "po/*.po", "git_export": "", "license": "", "license_url": "", "name": "Weblate", "slug": "weblate", "project": { "name": "Hello", "slug": "hello", "source_language": { "code": "en", "direction": "ltr", "population": 159034349015, "name": "English", "url": "http://example.com/api/languages/en/", "web_url": "http://example.com/languages/en/" }, "url": "http://example.com/api/projects/hello/", "web": "https://weblate.org/", "web_url": "http://example.com/projects/hello/" }, "source_language": { "code": "en", "direction": "ltr", "population": 159034349015, "name": "English", "url": "http://example.com/api/languages/en/", "web_url": "http://example.com/languages/en/" }, "repo": "file:///home/nijel/work/weblate-hello", "template": "", "new_base": "", "url": "http://example.com/api/components/hello/weblate/", "vcs": "git", "web_url": "http://example.com/projects/hello/weblate/" }
- PATCH /api/components/(string: project)/(string: component)/#
Bir bileşeni PATCH isteği ile düzenler.
- Parametreler:
project (string) – Proje adresi kısaltması
component (string) – Bileşen adresinin kısaltması
source_language (string) – Proje kaynak dili kodu (isteğe bağlı)
- JSON nesnesi ister:
name (string) – bileşen adı
slug (string) – bileşen kısaltması
repo (string) – Sürüm denetimi sistemi deposunun adresi
CURL örneği:
curl \ --data-binary '{"name": "new name"}' \ -H "Content-Type: application/json" \ -H "Authorization: Token TOKEN" \ PATCH http://example.com/api/projects/hello/components/
JSON isteği örneği:
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 yanıtı örneği:
HTTP/1.0 200 OK Date: Tue, 12 Apr 2016 09:32:50 GMT Server: WSGIServer/0.1 Python/2.7.11+ Vary: Accept, Accept-Language, Cookie X-Frame-Options: SAMEORIGIN Content-Type: application/json Content-Language: en Allow: GET, POST, HEAD, OPTIONS { "branch": "main", "file_format": "po", "filemask": "po/*.po", "git_export": "", "license": "", "license_url": "", "name": "new name", "slug": "weblate", "project": { "name": "Hello", "slug": "hello", "source_language": { "code": "en", "direction": "ltr", "population": 159034349015, "name": "English", "url": "http://example.com/api/languages/en/", "web_url": "http://example.com/languages/en/" }, "url": "http://example.com/api/projects/hello/", "web": "https://weblate.org/", "web_url": "http://example.com/projects/hello/" }, "repo": "file:///home/nijel/work/weblate-hello", "template": "", "new_base": "", "url": "http://example.com/api/components/hello/weblate/", "vcs": "git", "web_url": "http://example.com/projects/hello/weblate/" }
- PUT /api/components/(string: project)/(string: component)/#
Bir bileşeni PUT isteği ile düzenleme.
- Parametreler:
project (string) – Proje adresi kısaltması
component (string) – Bileşen adresinin kısaltması
- JSON nesnesi ister:
branch (string) – Sürüm denetimi sistemi deposunun dalı
file_format (string) – çevirilerin dosya biçimi
filemask (string) – depodaki çeviri dosyalarının modeli
name (string) – bileşen adı
slug (string) – bileşen kısaltması
repo (string) – Sürüm denetimi sistemi deposunun adresi
template (string) – tek dilli çeviriler için temel dosya
new_base (string) – yeni çeviriler eklemek için temel dosya
vcs (string) – sürüm denetimi sistemi
- DELETE /api/components/(string: project)/(string: component)/#
Bir bileşeni siler.
- Parametreler:
project (string) – Proje adresi kısaltması
component (string) – Bileşen adresinin kısaltması
- GET /api/components/(string: project)/(string: component)/changes/#
Bileşen değişikliklerinin listesini görüntüler. Temelde
GET /api/changes/
kapsamında bir bileşendir ve aynı parametreleri kabul eder.- Parametreler:
project (string) – Proje adresi kısaltması
component (string) – Bileşen adresinin kısaltması
- Yanıt JSON nesnesi:
results (array) – bileşen nesnelerinin dizisi. Bilgi almak için:
GET /api/changes/(int:id)/
- GET /api/components/(string: project)/(string: component)/file/#
4.9 sürümünde geldi.
Bileşenle ilişkili tüm kullanılabilir çevirileri istenilen biçimdeki arşiv dosyası olarak indirir.
- Parametreler:
project (string) – Proje adresi kısaltması
component (string) – Bileşen adresinin kısaltması
- Sorgu parametreleri:
format (string) – Kullanılacak arşiv biçimi belirtilmemişse varsayılan olarak
zip
biçimi kullanılır. Desteklenen biçimler:zip
- GET /api/components/(string: project)/(string: component)/screenshots/#
Bileşen ekran görüntülerinin listesini görüntüler.
- Parametreler:
project (string) – Proje adresi kısaltması
component (string) – Bileşen adresinin kısaltması
- Yanıt JSON nesnesi:
results (array) – bileşen ekran görüntüleri dizisi. Bilgi almak için:
GET /api/screenshots/(int:id)/
- GET /api/components/(string: project)/(string: component)/lock/#
Bileşenin kilit durumunu görüntüler.
- Parametreler:
project (string) – Proje adresi kısaltması
component (string) – Bileşen adresinin kısaltması
- Yanıt JSON nesnesi:
locked (boolean) – bileşenin güncellemeler için kilitlenip kilitlenmediği
Örnek JSON verileri:
{ "locked": false }
- POST /api/components/(string: project)/(string: component)/lock/#
Bileşenin kilit durumunu ayarlar.
Yanıt
GET /api/components/(string:project)/(string:component)/lock/
ile aynıdır.- Parametreler:
project (string) – Proje adresi kısaltması
component (string) – Bileşen adresinin kısaltması
- JSON nesnesi ister:
lock – Kilitli olduğunu ya da olmadığını belirten ikili değer.
CURL örneği:
curl \ -d lock=true \ -H "Authorization: Token TOKEN" \ http://example.com/api/components/hello/weblate/repository/
JSON isteği örneği:
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 yanıtı örneği:
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/#
Sürüm denetimi sitemi deposunun durumu hakkındaki bilgileri görüntüler.
Yanıt
GET /api/projects/(string:project)/repository/
ile aynıdır.- Parametreler:
project (string) – Proje adresi kısaltması
component (string) – Bileşen adresinin kısaltması
- Yanıt JSON nesnesi:
needs_commit (boolean) – işlenebilecek bekleyen değişikliklerin olup olmadığı
needs_merge (boolean) – aktarılabilecek herhangi bir yukarı akış değişikliğinin olup olmadığı
needs_push (boolean) – itilecek herhangi bir yerel değişikliğin olup olmadığı
remote_commit (string) – Uzaktan işleme bilgileri
status (string) – Sürüm denetimi sistemi tarafından bildirilen sürüm denetimi sistemi deposunun durumu
merge_failure – Varsa aktarım hatasını açıklayan metin, yoksa null
- POST /api/components/(string: project)/(string: component)/repository/#
Sürüm denetimi sistemi deposunda belirtilen işlemi gerçekleştirir.
Belgeler için
POST /api/projects/(string:project)/repository/
adresine bakabilirsiniz.- Parametreler:
project (string) – Proje adresi kısaltması
component (string) – Bileşen adresinin kısaltması
- JSON nesnesi ister:
operation (string) – Yapılacak işlem:
push
,pull
,commit
,reset
ya dacleanup
- Yanıt JSON nesnesi:
result (boolean) – işlemin sonucu
CURL örneği:
curl \ -d operation=pull \ -H "Authorization: Token TOKEN" \ http://example.com/api/components/hello/weblate/repository/
JSON isteği örneği:
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 yanıtı örneği:
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/#
Tek dilli çeviriler için temel dosyayı indirir.
- Parametreler:
project (string) – Proje adresi kısaltması
component (string) – Bileşen adresinin kısaltması
- GET /api/components/(string: project)/(string: component)/new_template/#
Yeni çeviriler için kalıp dosyasını indirir.
- Parametreler:
project (string) – Proje adresi kısaltması
component (string) – Bileşen adresinin kısaltması
- GET /api/components/(string: project)/(string: component)/translations/#
Belirtilen bileşendeki çeviri nesnelerinin listesini görüntüler.
- Parametreler:
project (string) – Proje adresi kısaltması
component (string) – Bileşen adresinin kısaltması
- Yanıt JSON nesnesi:
results (array) – çeviri nesneleri dizisi. Bilgi almak için:
GET /api/translations/(string:project)/(string:component)/(string:language)/
- POST /api/components/(string: project)/(string: component)/translations/#
Belirtilen bileşende yeni çeviri oluşturur.
- Parametreler:
project (string) – Proje adresi kısaltması
component (string) – Bileşen adresinin kısaltması
- JSON nesnesi ister:
language_code (string) – çeviri dili kodu. Bilgi almak için:
GET /api/languages/(string:language)/
- Yanıt JSON nesnesi:
result (object) – oluşturulan yeni çeviri nesnesi
CURL örneği:
curl \ -d language_code=cs \ -H "Authorization: Token TOKEN" \ http://example.com/api/projects/hello/components/
JSON isteği örneği:
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 yanıtı örneği:
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/#
Bileşen içindeki tüm çevirilerin sayfalandırılmış istatistiklerini görüntüler.
- Parametreler:
project (string) – Proje adresi kısaltması
component (string) – Bileşen adresinin kısaltması
Ayrıca bakınız
Geri dönen öznitelikler İstatistikler bölümünde açıklanmıştır.
- GET /api/components/(string: project)/(string: component)/links/#
Bir bileşenle ilişkili projeleri görüntüler.
4.5 sürümünde geldi.
- Parametreler:
project (string) – Proje adresi kısaltması
component (string) – Bileşen adresinin kısaltması
- Yanıt JSON nesnesi:
projects (array) – ilişkili projeler. Bilgi almak için:
GET /api/projects/(string:project)/
- POST /api/components/(string: project)/(string: component)/links/#
Projeyi bir bileşenle ilişkilendirir.
4.5 sürümünde geldi.
- Parametreler:
project (string) – Proje adresi kısaltması
component (string) – Bileşen adresinin kısaltması
- Form parametreleri:
string project_slug – Proje kısaltması
- DELETE /api/components/(string: project)/(string: component)/links/(string: project_slug)/#
Bir projenin bir bileşenle ilişkisini kaldırır.
4.5 sürümünde geldi.
- Parametreler:
project (string) – Proje adresi kısaltması
component (string) – Bileşen adresinin kısaltması
project_slug (string) – Kaldırılacak projenin kısaltması
Çeviriler#
- GET /api/translations/#
Çevirilerin listesini görüntüler.
Ayrıca bakınız
Çeviri nesnesi öznitelikleri
GET /api/translations/(string:project)/(string:component)/(string:language)/
bölümünde bulunabilir.
- GET /api/translations/(string: project)/(string: component)/(string: language)/#
Bir çeviriyle ilgili bilgileri görüntüler.
- Parametreler:
project (string) – Proje adresi kısaltması
component (string) – Bileşen adresinin kısaltması
language (string) – Çeviri dili kodu
- Yanıt JSON nesnesi:
component (object) – bileşen nesnesi. Bilgi almak için:
GET /api/components/(string:project)/(string:component)/
failing_checks (int) – denetim hatası olan dizge sayısı
failing_checks_percent (float) – denetim hatası olan dizge yüzdesi
failing_checks_words (int) – denetim hatası olan sözcük sayısı
filename (string) – çeviri dosyası adı
fuzzy (int) – belirsiz (düzenlenecek olarak imlenmiş) dizge sayısı
fuzzy_percent (float) – belirsiz (düzenlenecek olarak imlenmiş) dizge yüzdesi
fuzzy_words (int) – belirsiz (düzenlenecek olarak imlenmiş) dizge sayısı
have_comment (int) – belirsiz (düzenlenecek olarak imlenmiş) dizge yüzdesi
have_suggestion (int) – önerileri olan dizge sayısı
is_template (boolean) – çeviri tabanının tek dilli olup olmadığı
language (object) – kaynak dil nesnesi. Ayrıntılı bilgi alın
GET /api/languages/(string:language)/
language_code (string) – depoda kullanılan dil kodu. Dil nesnesindeki dil kodundan farklı olabilir
last_author (string) – son yazarın adı
last_change (timestamp) – son değişiklik zaman damgası
revision (string) – dosyanın sürüm karması
share_url (string) – Etkileşim sayfasına yönlendiren paylaşım adresi
total (int) – toplam dizge sayısı
total_words (int) – toplam sözcük sayısı
translate_url (string) – Çeviri adresi
translated (int) – çevrilmiş dizge sayısı
translated_percent (float) – çevrilmiş dizge yüzdesi
translated_words (int) – çevrilmiş sözcük sayısı
repository_url (string) – Depo durumu adresi: Bilgi almak için:
GET /api/translations/(string:project)/(string:component)/(string:language)/repository/
file_url (string) – Dosya nesnesi adresi. Bilgi almak için:
GET /api/translations/(string:project)/(string:component)/(string:language)/file/
changes_list_url (string) – Değişiklik listesi adresi. Bilgi almak için:
GET /api/translations/(string:project)/(string:component)/(string:language)/changes/
units_list_url (string) – Dizge listesi adresi. Bilgi almak için:
GET /api/translations/(string:project)/(string:component)/(string:language)/units/
Örnek JSON verileri:
{ "component": { "branch": "main", "file_format": "po", "filemask": "po/*.po", "git_export": "", "license": "", "license_url": "", "name": "Weblate", "new_base": "", "project": { "name": "Hello", "slug": "hello", "source_language": { "code": "en", "direction": "ltr", "population": 159034349015, "name": "English", "url": "http://example.com/api/languages/en/", "web_url": "http://example.com/languages/en/" }, "url": "http://example.com/api/projects/hello/", "web": "https://weblate.org/", "web_url": "http://example.com/projects/hello/" }, "repo": "file:///home/nijel/work/weblate-hello", "slug": "weblate", "template": "", "url": "http://example.com/api/components/hello/weblate/", "vcs": "git", "web_url": "http://example.com/projects/hello/weblate/" }, "failing_checks": 3, "failing_checks_percent": 75.0, "failing_checks_words": 11, "filename": "po/cs.po", "fuzzy": 0, "fuzzy_percent": 0.0, "fuzzy_words": 0, "have_comment": 0, "have_suggestion": 0, "is_template": false, "language": { "code": "cs", "direction": "ltr", "population": 1303174280 "name": "Czech", "url": "http://example.com/api/languages/cs/", "web_url": "http://example.com/languages/cs/" }, "language_code": "cs", "last_author": "Weblate Admin", "last_change": "2016-03-07T10:20:05.499", "revision": "7ddfafe6daaf57fc8654cc852ea6be212b015792", "share_url": "http://example.com/engage/hello/cs/", "total": 4, "total_words": 15, "translate_url": "http://example.com/translate/hello/weblate/cs/", "translated": 4, "translated_percent": 100.0, "translated_words": 15, "url": "http://example.com/api/translations/hello/weblate/cs/", "web_url": "http://example.com/projects/hello/weblate/cs/" }
- DELETE /api/translations/(string: project)/(string: component)/(string: language)/#
Bir çeviriyi siler.
- Parametreler:
project (string) – Proje adresi kısaltması
component (string) – Bileşen adresinin kısaltması
language (string) – Çeviri dili kodu
- GET /api/translations/(string: project)/(string: component)/(string: language)/changes/#
Çeviri değişikliklerinin listesini görüntüler. Temelde aynı parametreleri kabul eden bir
GET /api/changes/
çeviri kapsamıdır.- Parametreler:
project (string) – Proje adresi kısaltması
component (string) – Bileşen adresinin kısaltması
language (string) – Çeviri dili kodu
- Yanıt JSON nesnesi:
results (array) – bileşen nesnelerinin dizisi. Bilgi almak için:
GET /api/changes/(int:id)/
- GET /api/translations/(string: project)/(string: component)/(string: language)/units/#
Çeviri birimlerinin listesini görüntüler.
- Parametreler:
project (string) – Proje adresi kısaltması
component (string) – Bileşen adresinin kısaltması
language (string) – Çeviri dili kodu
q (string) – Arama sorgusu dizgesi Arama (isteğe bağlı)
- Yanıt JSON nesnesi:
results (array) – bileşen nesneleri dizisi. Bilgi almak için:
GET /api/units/(int:id)/
- POST /api/translations/(string: project)/(string: component)/(string: language)/units/#
Yeni birim ekler.
- Parametreler:
project (string) – Proje adresi kısaltması
component (string) – Bileşen adresinin kısaltması
language (string) – Çeviri dili kodu
- JSON nesnesi ister:
key (string) – Çeviri biriminin adı (anahtar veya bağlam olarak kullanılır)
value (array) – Kaynak dizgeler (çoğul oluşturmuyorsanız tekil dizge kullanın)
state (int) – Dizge durumu. Bilgi almak için:
GET /api/units/(int:id)/
- Yanıt JSON nesnesi:
unit (object) – yeni oluşturulmuş birim. Bilgi almak için:
GET /api/units/(int:id)/
Ayrıca bakınız
- POST /api/translations/(string: project)/(string: component)/(string: language)/autotranslate/#
Kendiliğinden çeviriyi tetikler.
- Parametreler:
project (string) – Proje adresi kısaltması
component (string) – Bileşen adresinin kısaltması
language (string) – Çeviri dili kodu
- JSON nesnesi ister:
mode (string) – Kendiliğinden çeviri kipi
filter_type (string) – Kendiliğinden çeviri süzgeci türü
auto_source (string) – Kendiliğinden çeviri kaynağı -
mt
ya daothers
component (string) – Ek bileşenlere erişebilmesi için projenin paylaşılan çeviri belleğine katkıda bulunma özelliğini açar.
engines (array) – Makine çevirisi hizmetleri
threshold (string) – Skor eşiği
- GET /api/translations/(string: project)/(string: component)/(string: language)/file/#
Geçerli çeviri dosyasını sürüm denetimi sisteminde tutulduğu biçimde (
format
parametresini kullanmadan) ya da başka bir biçime dönüştürülmüş olarak indirir (bilgi almak için: Çevirileri indirmek).Not
Bu API noktası, veriler yerine tüm dosya üzerinde çalıştığından çıktı için geri kalan API işleyişinden farklı bir mantık kullanır. Kabul edilen
format
parametre kümesi farklıdır ve böyle bir parametre belirtilmediğinde sürüm denetimi sisteminde depolanmış çeviri dosyasını alır.- Sorgu parametreleri:
format – Kullanılacak dosya biçimi. Belirtilmemişse biçim dönüşümü yapılmaz. Desteklenen biçimlerle ilgili bilgi almak için: :ref:`download’
q (string) – İndirilen dizgeleri süzer. Bilgi almak için: Arama Sayfası. Yalnızca dönüşüm yapıldığında geçerlidir (
format
belirtildiğinde).
- Parametreler:
project (string) – Proje adresi kısaltması
component (string) – Bileşen adresinin kısaltması
language (string) – Çeviri dili kodu
- POST /api/translations/(string: project)/(string: component)/(string: language)/file/#
Çevirileri içeren yeni dosya yükler.
- Parametreler:
project (string) – Proje adresi kısaltması
component (string) – Bileşen adresinin kısaltması
language (string) – Çeviri dili kodu
- Form parametreleri:
string conflicts – Çakışmaların nasıl işleneceği (
ignore
,replace-translated
ya dareplace-approved
)file file – Yüklenen dosya
string email – İlgilinin e-posta adresi
string author – Katkıda bulunanın adı
string method – Yükleme yöntemi (
translate
,approve
,suggest
,fuzzy
,replace
,source
,add
). Bilgi almak için: İçe aktarma yöntemleristring fuzzy – Belirsiz (düzenlenecek olarak imlenmiş) dizgeleri işleme (empty,
process
,approve
)
CURL örneği:
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/#
Sürüm denetimi sitemi deposunun durumu hakkındaki bilgileri görüntüler.
Yanıt
GET /api/components/(string:project)/(string:component)/repository/
ile aynıdır.- Parametreler:
project (string) – Proje adresi kısaltması
component (string) – Bileşen adresinin kısaltması
language (string) – Çeviri dili kodu
- POST /api/translations/(string: project)/(string: component)/(string: language)/repository/#
Sürüm denetimi sistemi deposunda belirtilen işlemi gerçekleştirir.
Belgeler için
POST /api/projects/(string:project)/repository/
adresine bakabilirsiniz.- Parametreler:
project (string) – Proje adresi kısaltması
component (string) – Bileşen adresinin kısaltması
language (string) – Çeviri dili kodu
- JSON nesnesi ister:
operation (string) – Yapılacak işlem:
push
,pull
,commit
,reset
ya dacleanup
- Yanıt JSON nesnesi:
result (boolean) – işlemin sonucu
- GET /api/translations/(string: project)/(string: component)/(string: language)/statistics/#
Ayrıntılı çeviri istatistiklerini görüntüler.
- Parametreler:
project (string) – Proje adresi kısaltması
component (string) – Bileşen adresinin kısaltması
language (string) – Çeviri dili kodu
Ayrıca bakınız
Geri dönen öznitelikler İstatistikler bölümünde açıklanmıştır.
Bellek#
4.14 sürümünde geldi.
- GET /api/memory/#
Çeviri belleği sonuçlarının listesini görüntüler.
- DELETE /api/memory/(int: memory_object_id)/#
Bir çeviri belleği nesnesini siler
- Parametreler:
memory_object_id – Çeviri belleği nesnesi kimliği
Birimler#
Birim, bir kaynak dizgeyi karşılık gelen çevrilmiş bir dizgeyle eşleştiren ve ayrıca bazı ilgili üst verileri içeren tek bir çeviri parçasıdır. Terim, Translate Toolkit ve XLIFF kapsamından türetilmiştir.
- GET /api/units/#
Çeviri birimlerinin listesini görüntüler.
- Parametreler:
q (string) – Arama sorgusu dizgesi Arama (isteğe bağlı)
Ayrıca bakınız
Birim nesnesi öznitelikleri
GET /api/units/(int:id)/
bölümünde bulunabilir.
- GET /api/units/(int: id)/#
4.3 sürümünde değişti:
Hedef
vekaynak
çoğul dizgeleri doğru işlemek için diziye dönüştürülmüştür.Çeviri birimi hakkındaki bilgileri görüntüler.
- Parametreler:
id (int) – Birim kimliği
- Yanıt JSON nesnesi:
translation (string) – İlişkili çeviri nesnesinin adresi
source (array) – kaynak dizge
previous_source (string) – belirsiz eşleştirmesi için kullanılan önceki kaynak dizge
target (array) – hedef dizge
id_hash (string) – birimin benzersiz belirteci
content_hash (string) – kaynak dizgenin benzersiz belirteci
location (string) – birimin kaynak kodundaki konumu
context (string) – çeviri birimi bağlamı
note (string) – çeviri birimi notu
flags (string) – çeviri birimi imleri
labels (array) – çeviri birimi etiketleri, kaynak birimlerde kullanılabilir
state (int) – birim durumu, 0 - Çevrilmemiş, 10 - Düzenlenmesi gerekli, 20 - Çevrilmiş, 30 - Onaylanmış, 100 - Salt okunur
fuzzy (boolean) – birimin belirsiz ya da onaylanmayı bekliyor olarak imlenmiş olup olmadığı
translated (boolean) – birimin çevrilmiş olup olmadığı
approved (boolean) – çevirinin onaylanmış olup olmadığı
position (int) – birimin çeviri dosyasındaki konumu
has_suggestion (boolean) – birimin önerileri olup olmadığı
has_comment (boolean) – birimin yorumları olup olmadığı
has_failing_check (boolean) – birimde denetim hatası olup olmadığı
num_words (int) – kaynak sözcük sayısı
priority (int) – çeviri önceliği. Varsayılan değer: 100
id (int) – birim belirteci
explanation (string) – Dizge açıklaması. Kaynak birimlerde kullanılabilir. Bilgi almak için: Kaynak dizgeler ile ilgili ek bilgiler
extra_flags (string) – Ek dizge imleri. Kaynak birimlerde kullanılabilir. Bilgi almak için: Parametreleri kullanarak davranışı özelleştirmek
web_url (string) – Birimin düzenlenebileceği adres
source_unit (string) – Kaynak birim bağlantısı. Bilgi almak için:
GET /api/units/(int:id)/
pending (boolean) – birimin belirsiz ya da onaylanmış olarak imlenmiş olup olmadığı
timestamp (timestamp) – dizge yaşı
- PATCH /api/units/(int: id)/#
4.3 sürümünde geldi.
Çeviri birimi üzerinde bazı güncellemeler yapar.
- Parametreler:
id (int) – Birim kimliği
- JSON nesnesi ister:
state (int) – birim durumu, 0 - Çevrilmemiş, 10 - Düzenlenmesi gerekli, 20 - Çevrilmiş, 30 - Onaylanmış (gözden geçirme iş akışı etkinleştirilmelidir. Bilgi almak için: :ref:`reviews’)
target (array) – hedef dizge
explanation (string) – Dizge açıklaması. Kaynak birimlerde kullanılabilir. Bilgi almak için: Kaynak dizgeler ile ilgili ek bilgiler
extra_flags (string) – Ek dizge imleri. Kaynak birimlerde kullanılabilir. Bilgi almak için: Parametreleri kullanarak davranışı özelleştirmek
- Yanıt JSON nesnesi:
labels (array) – etiketler, kaynak birimlerde kullanılabilir
- PUT /api/units/(int: id)/#
4.3 sürümünde geldi.
Çeviri birimi üzerinde tüm güncellemeleri yapar.
- Parametreler:
id (int) – Birim kimliği
- JSON nesnesi ister:
state (int) – birim durumu, 0 - Çevrilmemiş, 10 - Düzenlenmesi gerekli, 20 - Çevrilmiş, 30 - Onaylanmış (gözden geçirme iş akışı etkinleştirilmelidir. Bilgi almak için: :ref:`reviews’)
target (array) – hedef dizge
explanation (string) – Dizge açıklaması. Kaynak birimlerde kullanılabilir. Bilgi almak için: Kaynak dizgeler ile ilgili ek bilgiler
extra_flags (string) – Ek dizge imleri. Kaynak birimlerde kullanılabilir. Bilgi almak için: Parametreleri kullanarak davranışı özelleştirmek
- Yanıt JSON nesnesi:
labels (array) – etiketler, kaynak birimlerde kullanılabilir
- DELETE /api/units/(int: id)/#
4.3 sürümünde geldi.
Bir çeviri birimini siler.
- Parametreler:
id (int) – Birim kimliği
Değişiklikler#
- GET /api/changes/#
4.1 sürümünde değişti: Değişiklikleri süzme özelliği 4.1 sürümünde sunuldu.
Çeviri değişikliklerinin listesini görüntüler.
Ayrıca bakınız
Değişiklik nesnesi öznitelikleri
GET /api/changes/(int:id)/
bölümünde bulunabilir.- Sorgu parametreleri:
user (string) – Süzülecek kullanıcının kullanıcı adı
action (int) – Süzülecek işlem, birkaç kez kullanılabilir
timestamp_after (timestamp) – Sonraki değişiklikleri listelemek için ISO 8601 biçiminde zaman damgası
timestamp_before (timestamp) – Önceki değişiklikleri listelemek için ISO 8601 biçiminde zaman damgası
- GET /api/changes/(int: id)/#
Çeviri değişikliği hakkındaki bilgileri görüntüler.
- Parametreler:
id (int) – Değişiklik kimliği
- Yanıt JSON nesnesi:
unit (string) – İlişkili birim nesnesinin adresi
translation (string) – İlişkili çeviri nesnesinin adresi
component (string) – İlişkili bileşen nesnesinin adresi
user (string) – İlişkili kullanıcı nesnesinin adresi
author (string) – İlişkili yazar nesnesinin adresi
timestamp (timestamp) – etkinlik zaman damgası
action (int) – işlemin sayısal kimliği
action_name (string) – işlemin metin açıklaması
target (string) – metin ya da ayrıntı değişikliği etkinliği
id (int) – değişiklik belirteci
Ekran görüntüleri#
- GET /api/screenshots/#
Ekran görüntüsü dizgesi bilgilerinin listesini görüntüler.
Ayrıca bakınız
Ekran görüntüsü nesnesi öznitelikleri
GET /api/screenshots/(int:id)/
bölümünde bulunabilir.
- GET /api/screenshots/(int: id)/#
Ekran görüntüsü bilgileriyle ilgili bilgileri görüntüler.
- Parametreler:
id (int) – Ekran görüntüsü kimliği
- Yanıt JSON nesnesi:
name (string) – ekran görüntüsünün adı
component (string) – İlişkili bileşen nesnesinin adresi
file_url (string) – Bir dosyayı indirme bağlantısı. Bilgi almak için:
GET /api/screenshots/(int:id)/file/
units (array) – ilişkili kaynak dizge bilgileri bağlantısı. Bilgi almak için:
GET /api/units/(int:id)/
- GET /api/screenshots/(int: id)/file/#
Ekran görüntüsünü indirir.
- Parametreler:
id (int) – Ekran görüntüsü kimliği
- POST /api/screenshots/(int: id)/file/#
Ekran görüntüsünü değiştirir.
- Parametreler:
id (int) – Ekran görüntüsü kimliği
- Form parametreleri:
file image – Yüklenen dosya
CURL örneği:
curl -X POST \ -F image=@image.png \ -H "Authorization: Token TOKEN" \ http://example.com/api/screenshots/1/file/
- POST /api/screenshots/(int: id)/units/#
Kaynak dizgeyi ekran görüntüsüyle ilişkilendir.
- Parametreler:
id (int) – Ekran görüntüsü kimliği
- Form parametreleri:
string unit_id – Birim kimliği
- Yanıt JSON nesnesi:
name (string) – ekran görüntüsünün adı
translation (string) – İlişkili çeviri nesnesinin adresi
file_url (string) – Bir dosyayı indirme bağlantısı. Bilgi almak için:
GET /api/screenshots/(int:id)/file/
units (array) – ilişkili kaynak dizge bilgileri bağlantısı. Bilgi almak için:
GET /api/units/(int:id)/
- DELETE /api/screenshots/(int: id)/units/(int: unit_id)#
Kaynak dizge ile ekran görüntüsünün ilişkilendirmesini kaldır.
- Parametreler:
id (int) – Ekran görüntüsü kimliği
unit_id – Kaynak dizge birimi kimliği
- POST /api/screenshots/#
Yeni bir ekran görüntüsü oluşturur.
- Form parametreleri:
file image – Yüklenen dosya
string name – Ekran görüntüsü adı
string project_slug – Proje kısaltması
string component_slug – Bileşen kısaltması
string language_code – Dil kodu
- Yanıt JSON nesnesi:
name (string) – ekran görüntüsünün adı
component (string) – İlişkili bileşen nesnesinin adresi
file_url (string) – Bir dosyayı indirme bağlantısı. Bilgi almak için:
GET /api/screenshots/(int:id)/file/
units (array) – ilişkili kaynak dizge bilgileri bağlantısı. Bilgi almak için:
GET /api/units/(int:id)/
- PATCH /api/screenshots/(int: id)/#
Ekran görüntüsü ile ilgili bazı bilgileri düzenler.
- Parametreler:
id (int) – Ekran görüntüsü kimliği
- Yanıt JSON nesnesi:
name (string) – ekran görüntüsünün adı
component (string) – İlişkili bileşen nesnesinin adresi
file_url (string) – Bir dosyayı indirme bağlantısı. Bilgi almak için:
GET /api/screenshots/(int:id)/file/
units (array) – ilişkili kaynak dizge bilgileri bağlantısı. Bilgi almak için:
GET /api/units/(int:id)/
- PUT /api/screenshots/(int: id)/#
Ekran görüntüsü ile ilgili tüm bilgileri düzenler.
- Parametreler:
id (int) – Ekran görüntüsü kimliği
- Yanıt JSON nesnesi:
name (string) – ekran görüntüsünün adı
component (string) – İlişkili bileşen nesnesinin adresi
file_url (string) – Bir dosyayı indirme bağlantısı. Bilgi almak için:
GET /api/screenshots/(int:id)/file/
units (array) – ilişkili kaynak dizge bilgileri bağlantısı. Bilgi almak için:
GET /api/units/(int:id)/
- DELETE /api/screenshots/(int: id)/#
Ekran görüntüsünü siler.
- Parametreler:
id (int) – Ekran görüntüsü kimliği
Eklentiler#
4.4.1 sürümünde geldi.
- GET /api/addons/#
Eklentilerin listesini görüntüler.
Ayrıca bakınız
Eklenti nesnesi öznitelikleri
GET /api/addons/(int:id)/
bölümünde bulunabilir.
- GET /api/addons/(int: id)/#
Eklentiyle ilgili bilgileri görüntüler.
- Parametreler:
id (int) – Eklenti kimliği
- Yanıt JSON nesnesi:
name (string) – bir eklentinin adı
component (string) – İlişkili bileşen nesnesinin adresi
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.
- Parametreler:
project_slug (string) – Proje kısaltması
component_slug (string) – Bileşen kısaltması
- JSON nesnesi ister:
name (string) – bir eklentinin adı
configuration (object) – İsteğe bağlı eklenti yapılandırması
- PATCH /api/addons/(int: id)/#
Eklenti ile ilgili bazı bilgileri düzenler.
- Parametreler:
id (int) – Eklenti kimliği
- Yanıt JSON nesnesi:
configuration (object) – İsteğe bağlı eklenti yapılandırması
- PUT /api/addons/(int: id)/#
Eklenti ile ilgili tüm bilgileri düzenler.
- Parametreler:
id (int) – Eklenti kimliği
- Yanıt JSON nesnesi:
configuration (object) – İsteğe bağlı eklenti yapılandırması
- DELETE /api/addons/(int: id)/#
Eklentiyi siler.
- Parametreler:
id (int) – Eklenti kimliği
Bileşen listeleri#
4.0 sürümünde geldi.
- GET /api/component-lists/#
Bileşen listelerinin listesini görüntüler.
Ayrıca bakınız
Bileşen listesi nesnesi öznitelikleri
GET /api/component-lists/(str:slug)/
bölümünde bulunabilir.
- GET /api/component-lists/(str: slug)/#
Bileşen listesi hakkındaki bilgileri görüntüler.
- Parametreler:
slug (string) – Bileşen listesi kısaltması
- Yanıt JSON nesnesi:
name (string) – bir bileşen listesinin adı
slug (string) – bir bileşen listesinin kısaltması
show_dashboard (boolean) – bir panoda görüntülenip görüntülenmeyeceği
components (array) – ilişkili bileşenlerin bağlantısı. Bilgi almak için:
GET /api/components/(string:project)/(string:component)/
auto_assign (array) – kendiliğinden atama kuralları
- PUT /api/component-lists/(str: slug)/#
Bileşen listesi parametrelerini değiştirir.
- Parametreler:
slug (string) – Bileşen listesi kısaltması
- JSON nesnesi ister:
name (string) – bir bileşen listesinin adı
slug (string) – bir bileşen listesinin kısaltması
show_dashboard (boolean) – bir panoda görüntülenip görüntülenmeyeceği
- PATCH /api/component-lists/(str: slug)/#
Bileşen listesi parametrelerini değiştirir.
- Parametreler:
slug (string) – Bileşen listesi kısaltması
- JSON nesnesi ister:
name (string) – bir bileşen listesinin adı
slug (string) – bir bileşen listesinin kısaltması
show_dashboard (boolean) – bir panoda görüntülenip görüntülenmeyeceği
- DELETE /api/component-lists/(str: slug)/#
Bileşen listesini siler.
- Parametreler:
slug (string) – Bileşen listesi kısaltması
- GET /api/component-lists/(str: slug)/components/#
5.0.1 sürümünde geldi: List components in a component list.
- kısaltma parametresi:
Bileşen listesi kısaltması
- kısaltma türü:
dizge
- form dizge bileşen kimliği:
Bileşen kimliği
- >json dizisi sonuçları:
bileşen nesneleri dizisi. Bilgi almak için:
GET /api/components/(string:project)/(string:component)/
- POST /api/component-lists/(str: slug)/components/#
Bileşeni bir bileşen listesiyle ilişkilendirir.
- Parametreler:
slug (string) – Bileşen listesi kısaltması
- Form parametreleri:
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ır.
- Parametreler:
slug (string) – Bileşen listesi kısaltması
component_slug (string) – Bileşen kısaltması
Sözlük#
4.5 sürümünde değişti: Sözlükler artık normal bileşenler, çeviriler ve dizgeler olarak kaydediliyor. Lütfen bunun yerine ilgili API uygulamasını kullanın.
Görevler#
4.4 sürümünde geldi.
- GET /api/tasks/#
Görevlerin listesi şu anda alınamıyor.
- GET /api/tasks/(str: uuid)/#
Bir görev hakkındaki bilgileri görüntüler
- Parametreler:
uuid (string) – Görev UUID
- Yanıt JSON nesnesi:
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üğü
İstatistikler#
- GET /api/(str: object)/statistics/#
Nesneler için birkaç istatistik uç noktası vardır ve bunların tümünün yapısı aynıdır.
- Parametreler:
object (string) – Adres yolu
- Yanıt JSON nesnesi:
total (int) – toplam dizge sayısı
total_words (int) – toplam sözcük sayısı
total_chars (int) – toplam karakter sayısı
last_change (timestamp) – son değişiklik tarihi
translated (int) – çevrilmiş dizge sayısı
translated_percent (float) – çevrilmiş dizge yüzdesi
translated_words (int) – çevrilmiş sözcük sayısı
translated_words_percent (float) – çevrilmiş sözcük yüzdesi
translated_chars (int) – çevrilmiş karakter sayısı
translated_chars_percent (float) – çevrilmiş karakter yüzdesi
fuzzy (int) – belirsiz (düzenlenecek olarak imlenmiş) dizge sayısı
fuzzy_percent (float) – belirsiz (düzenlenecek olarak imlenmiş) dizge yüzdesi
failing (int) – denetim hataları sayısı
failing_percent (float) – denetim hataları yüzdesi
approved (int) – onaylanmış denetim sayısı
approved_percent (float) – onaylanmış dizgelerin yüzdesi
readonly (int) – salt okunur dizgelerin sayısı
readonly_percent (float) – salt okunur dizgelerin yüzdesi
suggestions (int) – önerileri olan dizgelerin sayısı
comments (int) – yorumları olan dizgelerin sayısı
name (string) – nesne adı
url (string) – Nesneye erişme adresi (uygulanabiliyorsa)
url_translate (string) – Çeviriye erişme adresi (uygulanabiliyorsa)
code (string) – dil kodu (uygulanabiliyorsa)
Ölçümler#
- GET /api/metrics/#
Sunucu ölçümlerini görüntüler.
- Yanıt JSON nesnesi:
units (int) – Birim sayısı
units_translated (int) – Çevrilmiş 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) – Tetiklenmiş kalite denetimleri sayısı
configuration_errors (int) – Yapılandırma hataları sayısı
suggestions (int) – Bekleyen öneri sayısı
celery_queues (object) – Celery kuyruklarının uzunlukları. Bilgi almak için: Celery ile arka plan görevlerini kullanmak
name (string) – Yapılandırılmış sunucu adı
Arama#
- GET /api/search/#
4.18 sürümünde geldi.
Site genelinde arama sonuçlarını bir liste olarak döndürür. Sonuç kümesinde sayfalama yoktur. Her kategori için yalnızca ilk birkaç eşleşme döndürülür.
- Yanıt JSON nesnesi:
name (str) – Eşleşen ögenin adı.
url (str) – Eşleşen ögenin internet adresi.
category (str) – Eşleşen ögenin kategorisi.
Kategoriler#
- GET /api/categories/#
5.0 sürümünde geldi.
Kullanılabilecek kategorileri görüntüler. Alan tanımları için
GET /api/categories/(int:id)/
bölümüne bakabilirsiniz.
- POST /api/categories/#
5.0 sürümünde geldi.
Yeni bir kategori oluşturur. Alan tanımları için
GET /api/categories/(int:id)/
adresine bakabilirsiniz.
- GET /api/categories/(int: id)/#
5.0 sürümünde geldi.
- Parametreler:
id (int) – Kategori kimliği
- Yanıt JSON nesnesi:
name (str) – Kategorinin adı.
slug (str) – Kategorinin kısaltması.
project (str) – Bir proje bağlantısı ekler.
category (str) – Bir üst kategori bağlantısı ekler.
- PATCH /api/categories/(int: id)/#
5.0 sürümünde geldi: Kategori ile ilgili bazı bilgileri düzenler.
- kimlik parametresi:
Kategori kimliği
- kimlik türü:
tamsayı
- >json nesnesi yapılandırması:
İsteğe bağlı kategori yapılandırması
- PUT /api/categories/(int: id)/#
5.0 sürümünde geldi: Kategori ile ilgili tüm bilgileri düzenler.
- kimlik parametresi:
Kategori kimliği
- kimlik türü:
tamsayı
- >json nesnesi yapılandırması:
İsteğe bağlı kategori yapılandırması
- DELETE /api/categories/(int: id)/#
5.0 sürümünde geldi: Kategoriyi siler.
- kimlik parametresi:
Kategori kimliği
- kimlik türü:
tamsayı
Bildirim kancaları#
Bildirim kancaları, dış uygulamaların sürüm denetimi sistemi deposunun güncellendiğini Weblate tarafına bildirmesini sağlar.
Depoları ayrı ayrı güncellemek için proje, bileşen ve çeviri depo uç noktalarını kullanabilirsiniz. Bilgi almak için POST /api/projects/(string:project)/repository/
.
- GET /hooks/update/(string: project)/(string: component)/#
2.6 sürümünden beri kullanım dışı: Erişim denetimi listesi ile kısıtlanmış projeler için kimlik doğrulaması ile düzgün çalışan
POST /api/components/(string:project)/(string:component)/repository/
kullanın.Bir bileşenin güncellenmesini tetikler (sürüm denetimi sisteminden çekme ve çeviri değişikliklerini tarama).
- GET /hooks/update/(string: project)/#
2.6 sürümünden beri kullanım dışı: Erişim denetimi listesi ile kısıtlanmış projeler için kimlik doğrulaması ile düzgün çalışan
POST /api/projects/(string:project)/repository/
kullanın.Bir projedeki tüm bileşenlerin güncellenmesini tetikler (sürüm denetimi sisteminden çekme ve çeviri değişikliklerini tarama).
- POST /hooks/github/#
GitHub bildirimlerini işleyen ve eşleşen bileşenleri kendiliğinden güncelleyen özel kanca.
Not
GitHub, doğrudan Weblate bilgilendirmelerini destekler: Depo ayarlarından Weblate hizmet kancasını etkinleştirin ve adres olarak Weblate kurulumunuzun adresini yazın.
Ayrıca bakınız
- GitHub değişikliklerini kendiliğinden almak
GitHub bütünleştirmesini ayarlama yönergeleri için
- https://docs.github.com/en/get-started/customizing-your-github-workflow/exploring-integrations/about-webhooks
GitHub internet kancaları ile ilgili genel bilgiler
ENABLE_HOOKS
Kancaları Weblate genelinde etkinleştirmek için
- POST /hooks/gitlab/#
GitLab bildirimlerini işleyen ve eşleşen bileşenleri kendiliğinden güncelleyen özel kanca.
Ayrıca bakınız
- GitLab değişikliklerini kendiliğinden almak
GitLab bütünleştirmesini ayarlama yönergeleri için
- https://docs.gitlab.com/ee/user/project/integrations/webhooks.html
GitLab internet kancaları ile ilgili genel bilgiler
ENABLE_HOOKS
Kancaları Weblate genelinde etkinleştirmek için
- POST /hooks/bitbucket/#
Bitbucket bildirimlerini işleyen ve eşleşen bileşenleri kendiliğinden güncelleyen özel kanca.
Ayrıca bakınız
- Bitbucket değişikliklerini kendiliğinden almak
Bitbucket bütünleştirmesini ayarlama yönergeleri için
- https://support.atlassian.com/bitbucket-cloud/docs/manage-webhooks/
Bitbucket internet kancaları ile ilgili genel bilgiler
ENABLE_HOOKS
Kancaları Weblate genelinde etkinleştirmek için
- POST /hooks/pagure/#
Pagure bildirimlerini işleyen ve eşleşen bileşenleri kendiliğinden güncelleyen özel kanca.
Ayrıca bakınız
- Pagure değişikliklerini kendiliğinden almak
Pagure bütünleştirmesini ayarlama yönergeleri için
- https://docs.pagure.org/pagure/usage/using_webhooks.html
Pagure internet kancaları ile ilgili genel bilgiler
ENABLE_HOOKS
Kancaları Weblate genelinde etkinleştirmek için
- POST /hooks/azure/#
Azure DevOps bildirimlerini işleyen ve eşleşen bileşenleri kendiliğinden güncelleyen özel kanca.
Not
Lütfen Gönderilecek kaynak ayrıntıları değerinin Tümü olarak ayarlandığından emin olun. Yoksa Weblate ile Azure deponuz eşleşemez.
Ayrıca bakınız
- Azure Repos değişikliklerini kendiliğinden almak
Azure bütünleştirmesini ayarlama yönergeleri için
- https://learn.microsoft.com/en-us/azure/devops/service-hooks/services/webhooks?view=azure-devops
Azure DevOps internet kancaları ile ilgili genel bilgiler
ENABLE_HOOKS
Kancaları Weblate genelinde etkinleştirmek için
- POST /hooks/gitea/#
Gitea internet kancası bildirimlerini işleyen ve eşleşen bileşenleri kendiliğinden güncelleyen özel kanca.
Ayrıca bakınız
- Gitea depoları değişikliklerini kendiliğinden almak
Gitea bütünleştirmesini ayarlama yönergeleri için
- https://docs.gitea.io/en-us/webhooks/
Gitea internet kancaları ile ilgili genel bilgiler
ENABLE_HOOKS
Kancaları Weblate genelinde etkinleştirmek için
- POST /hooks/gitee/#
Gitee internet kancası bildirimlerini işleyen ve eşleşen bileşenleri kendiliğinden güncelleyen özel kanca.
Ayrıca bakınız
- Gitee depoları değişikliklerini kendiliğinden almak
Gitee bütünleştirmesini ayarlama yönergeleri için
- https://gitee.com/help/categories/40
Gitee internet kancaları ile ilgili genel bilgiler
ENABLE_HOOKS
Kancaları Weblate genelinde etkinleştirmek için
Dışa aktarmak#
Weblate, verileri farklı şekillerde işlemenizi sağlamak için çeşitli dışa aktarma seçenekleri sunar.
- GET /exports/stats/(string: project)/(string: component)/#
- Sorgu parametreleri:
format (string) – Çıktı biçimi:
json
ya dacsv
2.6 sürümünden beri kullanım dışı: Lütfen bunun yerine
GET /api/components/(string:project)/(string:component)/statistics/
veGET /api/translations/(string:project)/(string:component)/(string:language)/statistics/
kullanın. Erişim denetim listesi kullanılan projelere de erişilmesini sağlar.Belirli bir bileşenin istatistiklerini belirtilen biçimde alır.
Örnek istek:
GET /exports/stats/weblate/main/ HTTP/1.1 Host: example.com Accept: application/json, text/javascript
Örnek yanıt:
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 akışları#
Çevirilerdeki değişiklikler RSS akışlarında dışa aktarılır.
- GET /exports/rss/(string: project)/(string: component)/(string: language)/#
Bir çevirideki son değişikliklerin RSS akışını alır.
- GET /exports/rss/(string: project)/(string: component)/#
Bir bileşendeki son değişikliklerin RSS akışını alır.
- GET /exports/rss/(string: project)/#
Bir projedeki son değişikliklerin RSS bildirimini alır.
- GET /exports/rss/language/(string: language)/#
Bir dildeki son değişikliklerin RSS akışını alır.
- GET /exports/rss/#
Weblate kopyasındaki son değişikliklerin RSS akışını alır.
Ayrıca bakınız