Uygulama tanımlayıcısı, Crowdin uygulamalarının temel yapı taşlarından biridir. Uygulama tanımlayıcısı, uygulamanın çalışmak veya genişletmek istediği modüllerinin yanı sıra uygulamanın genel bilgilerini içeren bir JSON dosyasıdır (örneğin, manifest.json). Uygulamanın nasıl çalışacağını, hangi kaynakların kullanılacağını, vb. açıklar. Aşağıda bir örnek görebilirsiniz.
{
"identifier": "uygulama-tanımlayıcınız",
"name": "Uygulamanız",
"description": "Uygulama açıklaması",
"logo": "/assets/logos/uyg-logo.png",
"baseUrl": "http://ornek.com",
"authentication": {
"type": "authorization_code",
"clientId": "istemci-kimliğiniz"
},
"events": {
"installed": "/hooks/installed"
},
"scopes": [
"project"
],
"modules": {
"project-integrations": [
{
"key": "modül-anahtarınız",
"name": "Modül Adı",
"description": "Modül açıklaması",
"logo": "/assets/logos/modul-logo.png",
"url": "/page/integration"
"environments": [
"crowdin", "crowdin-enterprise"
]
}
]
}
}
identifier | Tür: Not: Uygulama tanımlayıcısında büyük harf kullanmayın. Zorunlu: evet Açıklama: Uygulamayı tanımlamak için benzersiz bir anahtar. Bu tanımlayıcı şöyle olmak zorundadır: <= 255 characters. |
name | Tür: Zorunlu: evet Açıklama: Uygulamanın okunabilir adı. |
baseUrl | Tür: Zorunlu: evet Açıklama: Uygulama örneğine geri gönderilen tüm iletişimler için kullanılan uzak uygulamanın temel URL’si. Bu önemlidir: Uygulamanızı herkese açık hale getirmeden önce baseUrl’nizi akıllıca seçin. Not: Her uygulamanın benzersiz bir baseUrl’si olmak zorunda. Eğer aynı anamakineden birden fazla uygulama sunmak istiyorsanız, |
authentication | Tür: Zorunlu: evet Açıklama: Anamakine uygulaması ile Crowdin uygulaması arasındaki istekleri imzalarken kullanılacak kimlik doğrulama türünü belirtir. |
description | Tür: Açıklama: Uygulamanın ne yaptığının okunabilir açıklaması. |
logo | Tür: Açıklama: Crowdin kullanıcı arayüzünde görüntülenecek olan uygulamanın temel URL’sine ait resim URL’si. |
events | Tür: Açıklama: Uygulamanın, uygulama olay bildirimlerine kaydolmasını sağlar. |
scopes | Tür: [ Açıklama: Bu uygulama tarafından talep edilen kapsamlar grubu. |
modules | Tür: Açıklama: Bu uygulamanın sağladığı modüllerin listesi. |
environments | Tür: [ İzin verilen değerler: Açıklama: Modülün yüklenebildiği ortamlar kümesi. |
Anamakine uygulamasından Crowdin uygulamasına istekleri imzalarken kullanılacak kimlik doğrulama türünü belirtir. Crowdin Uygulamaları iki tür kimlik doğrulamayı destekler:
crowdin_app değeri)none değeri)Crowdin uygulamanızın herhangi bir zamanda Crowdin API’ye erişim gerektirmesi durumunda, crowdin_app’i kullanmanız önerilir, diğer durumlarda none’ı kullanmaktan çekinmeyin. Kimlik doğrulama türü none, crowdin_app’in yanı sıra Crowdin API’ye de erişim sağlar, ancak sadece Crowdin uygulaması kullanıcı tarafında yürütüldüğünde, örneğin iframe açıldığında.
Örnek:
{
"authentication": {
"type": "crowdin_app",
"clientId": "istemci-kimliğiniz"
}
}
Özellikler:
type | Tür: Varsayılanı: İzin verilen değerler: Açıklama: Kullanılacak kimlik doğrulama türü. |
clientId | Tür: Açıklama: |
Modüller, uygulamaların Crowdin’i genişletme ve onunla etkileşime girme şeklidir. Modülleri kullanarak uygulamanız aşağıdaki şeyleri yapabilir:
KA Modülleri ve Dosya İşleme Modülleri hakkında daha fazlasını okuyun.
Bir uygulamanın, çalışma alanında gerçekleşen olaylar için geri çağrıları kaydetmesine izin verin. Bir olay tetiklendiğinde, olay için kaydedilen uygun URL’ye bir POST isteği yapılacaktır. Installed geri çağrısı, bir uygulamanın kurulum işleminin ayrılmaz bir parçasıdır, oysa geri kalan olaylar aslında web kancalarıdır. Bu nesnedeki her özellik, uygulamanın temel URL’sine ait bir URL’dir.
Örnek:
{
"events": {
"installed": "/hook/installed",
"uninstall": "/hook/uninstall"
}
}
Özellikler:
installed | Tür: Açıklama: Bir kullanıcı uygulamayı Crowdin’e yükledikten sonra bir uygulamaya gönderilen olay.
|
uninstall | Tür: Açıklama: Crowdin’den uygulamayı kaldırılmadan önce bir uygulamaya gönderilen olay. |
Installed olayı, kullanıcı uygulamayı Crowdin’e yüklediğinde Crowdin’den uzak uygulamaya gönderilir. Installed olayı, Crowdin Uygulamasının yüklü olduğu Crowdin çalışma alanı veya profili hakkında bilgileri, bir API belirteci almak için kimlik bilgilerinin yanı sıra uygulamanın kendisi hakkındaki bilgileri içerir.
Installed Olayı Akışı hakkında daha fazlasını okuyun.
Yük örnekleri:
{
"appId": "uygulama-tanımlayıcınız",
"appSecret": "dbfg....asdffgg",
"clientId": "istemci-kimliğiniz",
"userId": 1,
"organizationId": 1,
"domain": null,
"baseUrl": "https://crowdin.com"
}
{
"appId": "uygulama-tanımlayıcınız",
"appSecret": "dbfg....asdffgg",
"clientId": "istemci-kimliğiniz",
"userId": 1,
"organizationId": 1,
"domain": "{etki_alanı}",
"baseUrl": "https://{etki_alanı}.crowdin.com"
}
Özellikler:
appId | Tür: Açıklama: Uygulama tanımlayıcı dosyasında bildirilen uygulamanın tanımlayıcısı. |
appSecret | Tür: Açıklama: Crowdin uygulamanızın yetkilendirilmesi için kullanılan benzersiz gizli anahtar. |
clientId | Tür: Açıklama: Uygulama tanımlayıcı dosyasında bildirilen OAuth istemci tanımlayıcısı. |
userId | Tür: Açıklama: Uygulamayı Crowdin Enterprise’a yükleyen kullanıcının sayısal tanımlayıcısı. |
organizationId | Tür: Açıklama: Uygulamanın yüklendiği kuruluşun sayısal tanımlayıcısı. |
domain | Tür: Açıklama: Uygulamanın yüklendiği Crowdin Enterprise’daki kuruluşun adı. Crowdin için etki alanı değeri her zaman null’dur |
baseUrl | Tür: Açıklama: Uygulamanın yüklendiği Crowdin Enterprise’daki kuruluşun temelUrl’si. Crowdin için baseUrl değeri her zaman "https://crowdin.com"dur |
Uninstall olayı, kullanıcı uygulamayı Crowdin Enterprise’dan kaldırdığında Crowdin Enterprise’dan uzak Crowdin uygulamasına gönderilir. Uninstall olayı, installed olayı gibi, Crowdin Uygulamasının yüklü olduğu Crowdin çalışma alanı veya hesabı ve uygulamanın kendisi hakkındaki bilgileri içerir. Uninstall olayını aldıktan sonra, uygulamanın kaldırıldığı Crowdin çalışma alanı veya hesabı ile ilgili tüm verileri bulmak ve kaldırmak gerekir.
Yük örnekleri:
{
"appId": "uygulama-tanımlayıcınız",
"clientId": "istemci-kimliğiniz",
"organizationId": 1,
"domain": null,
"baseUrl": "https://crowdin.com"
}
{
"appId": "uygulama-tanımlayıcınız",
"clientId": "istemci-kimliğiniz",
"organizationId": 1,
"domain": "{domain}",
"baseUrl": "https://{domain}.crowdin.com"
}
Özellikler:
appId | Tür: Açıklama: Uygulama tanımlayıcı dosyasında bildirilen uygulamanın tanımlayıcısı. |
clientId | Tür: Açıklama: Uygulama tanımlayıcı dosyasında bildirilen OAuth istemci tanımlayıcısı. |
organizationId | Tür: Açıklama: Uygulamanın kaldırıldığı kuruluşun sayısal tanımlayıcısı. |
domain | Tür: Açıklama: Uygulamanın kaldırıldığı Crowdin Enterprise’daki kuruluşun adı. Crowdin için etki alanı değeri her zaman null’dur |
baseUrl | Tür: Açıklama: Uygulamanın kaldırıldığı Crowdin Enterprise’daki kuruluşun temelUrl’si. Crowdin için baseUrl değeri her zaman "https://crowdin.com"dur |