Apigee Edge belgelerini görüntülüyorsunuz.
.
Git:
Apigee X belgeleri. bilgi
Giriş
Bir ücret planı yayınlamadan önce kuruluş profilinize şartlar ve koşullar ("Hükümler ve Koşullar") eklemeniz gerekir. Şartlar ve koşullar kuruluşun dışındadır seçin. Kuruluş profilinizde, web sitesinin konumunu (herkese açık URL) Şartlar ve koşullar.
Bir ücret planını yayınladıktan sonra, Hüküm ve Koşullar'ın mevcut sürümü geliştirici portalına gidin. Geliştiriciler bir planı yalnızca geçerli şartları kabul ettikten sonra satın alabilirler Şartlar ve koşullar.
Kullanıcı arayüzünü kullanarak şartlar ve koşullar ekleme
- Kuruluş Profili sayfasını keşfetme bölümünde 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 ekle ve
koşulları hakkında daha fazla bilgi edinin.
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 yürürlükte olduğu tarihtir. Varsayılan ayar, geçerli tarihi. Geçerli veya gelecekteki bir tarihi 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ı versiyonlarını takip etmek
URL Hükümler ve koşulların URL'si.
- Oluştur'u tıklayın.
Yeni şartlar ve koşullar, Kuruluş Profili'nin Hükümler ve Koşullar bölümüne eklenir sayfasını ziyaret edin.
- 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
Şartlar ve koşulları doğrudan düzenleyemezsiniz. Bunun yerine hükümler ve koşulları silmeniz gerekir şartlar ve koşullar girişi ekleyin ve ardından yeni bir şartlar ve koşullar girişi ekleyin.
Kullanıcı arayüzünü kullanarak şartlar 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.
- T&C'ler listesinde imlecinizi, silmek istediğiniz Şartlar ve Koşullar'ın üzerine getirin.
- simgesini tıklayın.
Şartlar ve koşulları API'yi kullanarak 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
adlı iş ortağına POST isteği göndererek Şartlar ve Koşullar'ı ekleyin.
Şartlar ve Koşullar'ı eklerken isteğe bağlı olarak şunları belirtebilirsiniz:
- URL
- Eşlik eden metin (ör. açıklama)
- Şartlar ve koşulların yürürlükte olduğu tarih
- Sürüm numarası
Ek bilgiler için Hükümler ve koşulları yapılandırma özellikleri daha fazla bilgi edineceksiniz.
Ö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.
Spesifik göster
/mint/organizations/{org_name}/tncs/{tncs_id}
adlı alıcıya bir GET isteği göndererek Şartlar ve Koşullar'ı
{tncs_id}
, belirli şartlar ve koşulların kimliğidir (kimlik
, Şartlar ve Koşullar'ı oluşturduğunuzda yanıt vermelidir). Ö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
Kuruluşun tüm şartları ve koşulları, şuna bir GET isteği göndererek
/mint/organizations/{org_name}/tncs
Ö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ıtın bir örneği 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 kullanan bir geliştirici veya şirketin hükümler ve koşullar belgesini kabul etmek
POST yayınlayarak belirli bir geliştirici veya şirket için Şartlar ve Koşullar belgesini kabul etme aşağıdaki API'lerden birine istek gönderebilirsiniz:
/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ıtın bir örneği verilmiştir:
auditDate
, geçerli zamana (UTC) 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
Belirli bir geliştirici veya şirket tarafından kabul edilen Şartlar ve Koşullar'ı GET yazarak görüntüleme aşağıdaki API'lerden birine istek gönderebilirsiniz:
/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ıtın bir örneği 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 }
Şartlar ve koşulları API'yi kullanarak düzenleme
Şu kullanıcıya bir PUT isteği göndererek Şartlar ve Koşullar'ı düzenleyin:
/mint/organizations/{org_named}/tncs/{tncs_id}
, burada {tncs_id}
değeri
tanımlaması gerekir. Güncellemeyi yaptığınızda istekte belirtmeniz gerekir.
güncellenen ayarları ve Hükümler ve Koşullar'ın tanımını içerir. Örneğin,
isteği, Şartlar ve Koşullar'ın sürüm numarasını düzenler (güncellenmiş özellik sayfada vurgulanmıştır)
örnek):
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ıtın bir örneği 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" }
Şartlar ve koşulları API'yi kullanarak silme
Şartlar ve Koşullar'ı,
/mint/organizations/{org_name}/tncs/{tncs_id}
, burada {tncs_id}
değeri
tanımlaması gerekir. Ö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 şartlar 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 |
Şartlar ve koşulların URL'si. |
Yok | Hayır |
tncText |
Hüküm 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ı, farklı sürümleri izlemeniz için sürümleri için de geçerlidir. |
Yok | Evet |
startDate |
Şartlar ve koşulların yürürlükte olduğu tarih. |
Yok | Evet |
organization |
Hüküm ve Koşullar'ın kuruluşu. |
Yok | Hayır |
Sonraki adımlar
Kuruluşunuz için başlangıçta ayarlanan para birimlerine desteklenen para birimlerini nasıl ekleyeceğinizi öğrenin. Desteklenenleri yönetin para birimleri için geçerli değildir.