Apigee Edge belgelerini görüntülüyorsunuz.
Apigee X belgelerine gidin. bilgi
Giriş
Ücret planı yayınlamadan önce kuruluş profilinize şartlar ve koşullar ("Hükümler ve Koşullar") eklemeniz gerekir. Şartlar ve koşullar, kuruluş profilinin dışında yer alır. Kuruluş profilinizde, Hükümler ve Koşullar'ın konumunu (genel URL) belirtirsiniz.
Bir ücret planı yayınladıktan sonra, Hükümler ve Koşullar'ın geçerli sürümü geliştirici portalında görüntülenir. Geliştiriciler yalnızca geçerli hüküm ve koşulları kabul ettikten sonra plan satın alabilirler.
Kullanıcı arayüzünü kullanarak şartlar ve koşullar ekleme
- Kuruluş Profili sayfasını keşfetme sayfasında açıklandığı şekilde Kuruluş Profili sayfasına erişin.
- Düzenle'yi tıklayın.
- Kuruluş Profili sayfasının Şartlar ve koşullar bölümünde Şartlar ve koşullar ekle'yi tıklayın.
Yeni şartlar ve koşullar iletişim kutusu görüntülenir
- Aşağıdaki bilgileri girin:
Alan Açıklama Geçerlilik Tarihi Hükümler ve koşulların geçerli olduğu tarih. Varsayılan değer, geçerli tarihtir. Geçerli veya gelecekteki bir tarihi girmeniz gerekir.
Sürüm Hükümler ve koşulların sürümü. Sürüm numarası, şartlar ve koşulların farklı sürümlerini takip etmenize olanak tanır.
URL Şartlar ve koşulların URL'si.
- Oluştur'u tıklayın.
Yeni şartlar 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 ile 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 şartlar ve koşulları düzenleme
Şartlar ve koşulları doğrudan düzenleyemezsiniz. Bunun yerine, düzenlemek istediğiniz şartlar ve koşulları silmeniz, ardından yeni bir şartlar ve koşullar girişi eklemeniz gerekir.
Kullanıcı arayüzünü kullanarak şartlar ve koşulları silme
- Kuruluş Profili sayfasını keşfetme sayfasında açıklandığı şekilde Kuruluş Profili sayfasına erişin.
- Kuruluş Profili sayfasında Düzenle'yi tıklayın.
- Şartlar ve Koşullar listesinde imlecinizi silmek istediğiniz koşulların ve koşulların üzerine getirin.
- simgesini tıklayın.
API'yi kullanarak hükümler ve koşulları yönetme
API'yi kullanarak şartlar ve koşulları aşağıdaki bölümlerde açıklandığı şekilde yönetin.
API kullanarak şartlar ve koşullar ekleme
/mint/organizations/{org_name}/tncs
için POST isteği göndererek şartlar ve koşulları ekleyin.
Hükümler 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 özelliklerine bakın.
Ö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ıtla ilgili bir örnek yer almaktadır:
{ "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ümler ve koşulları görüntüleme
Bir kuruluş için belirli Hüküm ve Koşullar'ı veya tüm Hükümler ve Koşullar'ı görüntüleyin.
/mint/organizations/{org_name}/tncs/{tncs_id}
için GET isteği göndererek belirli Hükümler ve Koşullar'ı görüntüleyin. Burada {tncs_id}
, belirli Hükümler ve Koşullar'ın tanımlamasıdır (Kimlik, Hükümler ve Koşullar'ı oluşturduğunuzda yanıtta 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
için bir GET isteği göndererek kuruluşun tüm hüküm ve koşullarını 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ıtla ilgili bir örnek yer almaktadır:
{
"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 şartlar ve koşullar belgesini 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, {tncs_id}
ise şartlar 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ıtla ilgili bir örnek yer almaktadır:
auditDate
, UTC olarak geçerli saate 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 şartlar ve koşulları görüntüleme
Sırasıyla aşağıdaki API'lerden birine GET isteği göndererek belirli bir geliştirici veya şirket tarafından kabul edilen şartlar 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ğidir (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ıtla ilgili bir örnek yer almaktadır:
{ "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 şartlar ve koşulları düzenleme
/mint/organizations/{org_named}/tncs/{tncs_id}
için PUT isteği göndererek Hükümler ve Koşullar'ı düzenleyin. Burada {tncs_id}
, Hükümler ve Koşullar'ın tanımlanmasıdır. Güncellemeyi yaparken istek gövdesinde güncellenen ayarları ve Şartlar ve Koşullar'ın tanımlamasını belirtmeniz gerekir. Örneğin, aşağıdaki istek, Hükümler ve Koşullar'ın 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ıtla ilgili bir örnek yer almaktadır:
{ "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ümler ve koşulları silme
/mint/organizations/{org_name}/tncs/{tncs_id}
için DELETE isteği göndererek Hükümler ve Koşullar'ı silin. Burada {tncs_id}
, Hükümler ve Koşullar'ın tanımlamasıdır. Ö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, şartlar ve koşullar için API kullanılarak ayarlanabilecek yapılandırma özellikleri özetlenmektedir.
Ad | Açıklama | Varsayılan | Zorunlu mu? |
---|---|---|---|
url |
Hükümler ve Koşullar'ın URL'si. |
Yok | Hayır |
tncText |
Hükümler ve Koşullar metni (ör. kısa bir açıklama). |
Yok | Hayır |
version |
Şartlar ve Koşullar sürümü. Sürüm numarası, Hükümler ve Koşullar'ın farklı sürümlerini takip etmenize olanak tanır. |
Yok | Evet |
startDate |
Şartlar ve Koşullar'ın geçerli olduğu tarih. |
Yok | Evet |
organization |
Şartlar ve Koşullar'ın kuruluşu. |
Yok | Hayır |
Sonraki adımlar
Desteklenen para birimlerini yönetme bölümünde kuruluşunuz için ilk kez ayarlanan para birimlerine desteklenen para birimlerini nasıl ekleyeceğinizi öğrenin.