Apigee Edge belgelerini görüntülüyorsunuz.
Apigee X belgelerine gidin. bilgi
Giriş
Bir fiyat planı yayınlamadan önce kuruluş profilinize hükümler ve koşullar ("H&K'lar") eklemeniz gerekir. Hükümler ve Koşullar, kuruluş profilinin dışında yer alır. Kuruluş profilinizde, Hükümler ve Koşullar'ın konumunu (Herkese açık URL) belirtirsiniz.
Bir fiyat planı yayınladıktan sonra, hükümler ve koşulların mevcut sürümü geliştirici portalında gösterilir. Geliştiriciler, planı yalnızca mevcut H&K'ları kabul ettikten sonra satın alabilir.
Kullanıcı arayüzünü kullanarak hüküm ve koşul ekleme
- Kuruluş profili sayfasını keşfetme bölümünde açıklandığı gibi, kuruluş profili sayfasına erişin.
- Düzenle'yi tıklayın.
- Kuruluş Profili sayfasının Hükümler ve koşullar bölümünde Hükümler ve koşullar ekle'yi tıklayın.
Yeni şartlar ve koşullar iletişim kutusu gösterilir.
- Aşağıdaki bilgileri girin:
Alan Açıklama Geçerlilik Tarihi Hüküm ve koşulların geçerli olduğu tarih. Varsayılan değer geçerli tarihtir. Bugünün tarihini veya gelecekteki bir tarihi girmeniz gerekir.
Sürüm Hükümler ve koşulların sürümü Sürüm numarası, hüküm ve koşulların farklı sürümlerini takip etmenize olanak tanır.
URL Hükümler ve koşullar URL'si.
- Oluştur'u tıklayın.
Yeni Hükümler ve Koşullar, Kuruluş Profili sayfasının Hükümler ve koşullar bölümüne eklenir.
- Başka şartlar ve koşullar eklemek için 3-5 arasındaki adımları tekrarlayın.
- Kuruluş profili değişikliklerini kaydetmek için Kaydet'i tıklayın.
Kullanıcı arayüzünü kullanarak hüküm ve koşulları düzenleme
Hükümler ve koşulları doğrudan düzenleyemezsiniz. Bunun yerine, düzenlemek istediğiniz hüküm ve koşulları silip yeni bir hüküm ve koşul girişi eklemeniz gerekir.
Kullanıcı arayüzünü kullanarak hüküm ve koşulları silme
- Kuruluş profili sayfasını keşfetme bölümünde açıklandığı gibi, kuruluş profili sayfasına erişin.
- Kuruluş profili sayfasında Düzenle'yi tıklayın.
- Hükümler ve koşullar listesinde, silmek istediğiniz hükümler ve koşulların üzerine gelin.
simgesini tıklayın.
API'yi kullanarak hüküm ve koşulları yönetme
Aşağıdaki bölümlerde açıklandığı şekilde, API'yi kullanarak hüküm ve koşulları yönetin.
API kullanarak şartlar ve koşullar ekleme
/mint/organizations/{org_name}/tncs adresine bir POST isteği göndererek Hükümler ve Koşullar'ı ekleyin.
Hüküm ve koşulları eklerken isteğe bağlı olarak şunları belirtebilirsiniz:
- URL
- Eşlik eden metin (ör. açıklama)
- Hükümler ve Koşullar'ın geçerli olduğu tarih
- Sürüm numarası
Bu seçenekler hakkında daha fazla bilgi için Hükümler ve koşullar yapılandırma özellikleri başlıklı makaleyi inceleyin.
Örneğin:
curl -X POST "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/tncs" \
-H "Content-Type: application/json" \
-d \
'{
"url":"www.testoperator/termsandconditions",
"tncText":"Sample text for the T&C",
"version":"1.1",
"startDate":"2018-09-24"
}' \
-u email:password
Aşağıda, yanıta dair bir örnek verilmiştir:
{
"id" : "6803d70a-18cc-40c8-b250-675c5e8a75c ",
"organization" : {
…
},
"startDate" : "2018-09-24 00:00:00",
"tncText" : "Sample text for the T&C",
"url" : "www.testoperator/termsandconditions",
"version" : "1.1"
}API'yi kullanarak hüküm ve koşulları görüntüleme
Belirli bir kuruluşun belirli veya tüm H&K'lerini görüntüleyebilirsiniz.
/mint/organizations/{org_name}/tncs/{tncs_id} adresine GET isteği göndererek belirli H&K'leri görüntüleyin. Burada {tncs_id}, belirli H&K'lerin tanımlayıcısıdır (H&K'leri oluşturduğunuzda yanıt içinde kimlik döndürülür). Örneğin:
curl -X GET "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/tncs/6803d70a-18cc-40c8-b250-675c5e8a75c" \
-H "Accept: application/json" \
-u email:password
/mint/organizations/{org_name}/tncs adresine bir GET isteği göndererek kuruluşun tüm H&K'lerini görüntüleyin. Örneğin:
curl -X GET "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/tncs" \
-H "Accept: application/json" \
-u email:password
Aşağıda, yanıta dair bir örnek verilmiştir:
{
"tnc" : [
{
"id" : "77193339-8d79-44a8-8af2-3593f16c158e",
"organization" :
{
...
},
"startDate" : "2018-07-01 00:00:00",
"tncText" : "Big operator text for the T&C",
"url" : "www.bigoperator/termsandconditions",
"version" : "1.0"
},
{
"id" : "6803d70a-18cc-40c8-b250-675c5e8a75c3",
"organization" : {
...
},
"startDate" : "2018-09-24 00:00:00",
"tncText" : "Sample text for the T&C",
"url" : "www.testoperator/termsandconditions",
"version" : "1.1"
}
]
"totalRecords" : 2
}API'yi kullanan bir geliştirici veya şirket için hükümler ve koşullar belgesini kabul etme
Aşağıdaki API'lerden birine POST isteği göndererek belirli bir geliştirici veya şirket için Hükümler ve Koşullar dokümanını kabul edin:
/mint/organizations/{org_name}/developers/{dev_id}/tncs/{tncs_id}/developer-tncs/mint/organizations/{org_name}/companies/{company_id}/tncs/{tncs_id}/developer-tncs
Burada {dev_id} geliştirici kimliği (e-posta adresi), {company_id} şirket kimliği ve {tncs_id} ise hükümler ve koşullar dokümanı kimliğidir.
Örneğin:
curl -X POST "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/dev2@myorg.com/tncs/5a291b86-42e3-4ae1-8db3-efe4b0877316/developer-tncs" \
-H "Content-Type: application/json" \
-d \
'{
"action":"ACCEPTED",
"auditDate":"2018-10-01 00:00:00"
}' \
-u email:password
Aşağıda, yanıta dair bir örnek verilmiştir:
auditDate, UTC'deki geçerli saat olarak ayarlanır.{ "action": "ACCEPTED", "auditDate": "2018-10-01 07:24:45", "id": "dev2@myorg.com", "tnc": { "id": "5a291b86-42e3-4ae1-8db3-efe4b0877316", ... } }
API'yi kullanan bir geliştirici veya şirket tarafından kabul edilen hüküm ve koşulları görüntüleme
Aşağıdaki API'lerden birine sırasıyla GET isteği göndererek belirli bir geliştirici veya şirket tarafından kabul edilen Hükümler ve Koşullar'ı görüntüleyin:
/mint/organizations/{org_name}/developers/{dev_id}/developer-tncs/mint/organizations/{org_name}/companies/{company_id}/developer-tncs
Burada {dev_id} geliştirici kimliği (e-posta adresi), {company_id} ise şirket kimliğidir.
Örneğin:
curl -X GET "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/dev2@myorg.com/developer-tncs" \
-H "Accept:application/json" \
-u email:password
Aşağıda, yanıta dair bir örnek verilmiştir:
{ "developerTnc": [ { "action": "ACCEPTED", "auditDate": "2018-08-29 07:24:45", "id": "dev2@myorg.com", "tnc": { "id": "26abc14c-c628-4c38-8840-a343c8ee9437", ... } }], "totalRecords": 1 }
API'yi kullanarak hüküm ve koşulları düzenleme
Şartlar ve koşulları, /mint/organizations/{org_named}/tncs/{tncs_id} adresine bir PUT isteği göndererek düzenleyin. Burada {tncs_id}, şartlar ve koşulların kimliğidir. Güncelleme yaptığınızda, istek gövdesinde güncellenen ayarları ve H&K'nin tanımlanmasını belirtmeniz gerekir. Örneğin, aşağıdaki istek, H&K'nin sürüm numarasını düzenler (güncellenen özellik örnekte vurgulanmıştır):
curl -X PUT "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/tncs/cfbb03b3-b707-495b-9b8a-ff67d71065a9" \
-H "Content-Type: application/json" \
-d {
"id":"6803d70a-18cc-40c8-b250-675c5e8a75c",
"version":"1.2"
}' \
-u email:password
Aşağıda, yanıta dair bir örnek verilmiştir:
{ "id" : "cfbb03b3-b707-495b-9b8a-ff67d71065a9", "organization" : { "address" : [ { "address1" : "Test address", "city" : "Test City", "country" : "US", "id" : "test-address", "isPrimary" : true, "state" : "CA", "zip" : "54321" } ], …" }, "startDate" : "2018-09-24 00:00:00", "tncText" : "Sample text for the T&C", "url" : "www.testoperator/termsandconditions", "version" : "1.2" }
API'yi kullanarak hüküm ve koşulları silme
/mint/organizations/{org_name}/tncs/{tncs_id} adresine bir DELETE isteği göndererek H&K'ları silin. Burada {tncs_id}, H&K'ların kimliğidir. Örneğin:
curl -X DELETE "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/tncs/6803d70a-18cc-40c8-b250-675c5e8a75c" \ -H "Accept: application/json" \ -u email:password
API için hükümler ve koşullar yapılandırma özellikleri
Aşağıdaki tabloda, hükümler ve koşullar için API kullanılarak ayarlanabilen yapılandırma özellikleri özetlenmektedir.
| Ad | Açıklama | Varsayılan | Zorunlu mu? |
|---|---|---|---|
url |
Hüküm ve Koşullar'ın URL'si. |
Yok | Hayır |
tncText |
Hükümler ve Koşullar için metin (ör. kısa bir açıklama). |
Yok | Hayır |
version |
Hükümler ve Koşullar'ın sürümü. Sürüm numarası, H&K'nin farklı sürümlerini takip etmenize olanak tanır. |
Yok | Evet |
startDate |
Hüküm ve Koşullar'ın geçerli olduğu tarih. |
Yok | Evet |
organization |
Hükümler ve Koşullar'ın kuruluşu. |
Yok | Hayır |
Sonraki adımlar
Desteklenen para birimlerini kuruluşunuz için başlangıçta ayarlananlara nasıl ekleyeceğinizi öğrenmek için Desteklenen para birimlerini yönetme başlıklı makaleyi inceleyin.