Apigee Edge belgelerini görüntülüyorsunuz.
Apigee X belgelerine gidin. info
Giriş
Bir ücret planı yayınlamadan önce kuruluş profilinize şartlar ve koşullar ("Hükümler ve Koşullar") eklemeniz gerekir. Hükümler ve Koşullar, kuruluş profilinin dışındadır. Kuruluş profilinizde Hükümler ve Koşullar'ın konumunu (herkese açık URL) belirtirsiniz.
Bir ücret planı yayınladıktan sonra, Hüküm ve Koşullar'ın mevcut sürümü geliştirici portalında gösterilir. Geliştiriciler ancak mevcut şartlar ve koşulları kabul ettikten sonra plan satın alabilirler.
Kullanıcı arayüzünü kullanarak hükümler ve koşullar ekleme
- Kuruluş Profili sayfasını keşfetme bölümünde açıklandığı şekilde Kuruluş Profili sayfasına gidin.
- 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. Mevcut veya gelecekteki bir tarih girmeniz gerekir.
Sürüm Şartlar ve koşulların sürümü. Sürüm numarası, hükümler ve koşulların farklı sürümlerini takip etmenize olanak tanır.
URL Hükümler ve koşulların 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 şartlar ve koşulları düzenleme
Hükümler ve Koşullar'ı doğrudan düzenleyemezsiniz. Bunun yerine, düzenlemek istediğiniz hükümler ve koşulları silmeniz, ardından yeni bir hükümler ve koşullar girişi eklemeniz gerekir.
Kullanıcı arayüzünü kullanarak hükümler ve koşulları silme
- Kuruluş Profili sayfasını keşfetme bölümünde açıklandığı şekilde Kuruluş Profili sayfasına erişin.
- Kuruluş Profili sayfasında Düzenle'yi tıklayın.
- Hükümler ve Koşullar listesinde, imleci silmek istediğiniz hükümler 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 hükümler ve koşullar ekleme
/mint/organizations/{org_name}/tncs
adlı iş ortağına 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 (açıklama gibi)
- 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ıtın bir örneği 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ümler ve koşulları görüntüleme
Bir kuruluşun belirli T&C'lerini veya tüm Hüküm ve Koşulları'nı görüntüleyin.
/mint/organizations/{org_name}/tncs/{tncs_id}
adresine 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 kimliğidir (Hükümler ve Koşullar'ı oluşturduğunuzda kimlik 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
adresine bir GET isteği göndererek kuruluşun tüm Hükümler 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ı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 sırasıyla POST isteği göndererek belirli bir geliştirici veya şirket için Hükümler 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 belgesinin 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 mevcut 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 hükümler 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ği (e-posta adresi) ve {company_id}
, ş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ümler ve koşulları düzenleme
/mint/organizations/{org_named}/tncs/{tncs_id}
adresine PUT isteği göndererek hükümler ve koşulları düzenleyin. Bu adreste {tncs_id}
, hükümler ve koşulların kimliğidir. Güncelleme yaparken istek gövdesinde güncellenen ayarları ve Hükümler ve Koşullar'ın kimliğini 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ı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ümler ve koşulları silme
Hükümler ve Koşullar'ı /mint/organizations/{org_name}/tncs/{tncs_id}
adresine DELETE isteği göndererek silin. {tncs_id}
, Hükümler ve Koşullar'ı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'nin 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 özetlenmiştir.
Ad | Açıklama | Varsayılan | Zorunlu mu? |
---|---|---|---|
url |
Şartlar ve koşulların URL'si. |
Yok | Hayır |
tncText |
Hükümler ve Koşullar metni (kısa açıklama gibi). |
Yok | Hayır |
version |
Hükümler ve Koşullar'ın 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 yürürlükte olduğu tarih. |
Yok | Evet |
organization |
Hükümler ve Koşullar'ın düzenlendiği kuruluş. |
Yok | Hayır |
Sonraki adımlar
Desteklenen para birimlerini yönetme bölümünden, kuruluşunuz için başlangıçta belirlenen para birimlerine desteklenen para birimlerini nasıl ekleyeceğinizi öğrenin.