Anda sedang melihat dokumentasi Apigee Edge.
Buka
dokumentasi Apigee X. info
Pengantar
Anda harus menambahkan persyaratan dan ketentuan ("S&C") ke profil organisasi sebelum memublikasikan paket tarif. Persyaratan & Ketentuan berada di luar profil organisasi. Di profil organisasi, Anda menentukan lokasi (URL publik) Persyaratan & Ketentuan.
Setelah Anda memublikasikan paket tarif, versi Persyaratan & Ketentuan saat ini akan ditampilkan di portal developer. Developer dapat membeli paket hanya setelah menyetujui S&K saat ini.
Menambahkan persyaratan dan ketentuan menggunakan UI
- Akses halaman Profil Organisasi, seperti yang dijelaskan di Menjelajahi halaman Profil Organisasi.
- Klik Edit.
- Di bagian Persyaratan dan ketentuan di halaman Profil Organisasi, klik Tambahkan persyaratan dan
ketentuan.
Dialog Persyaratan dan ketentuan baru ditampilkan
- Masukkan informasi berikut:
Kolom Deskripsi Tanggal Mulai Berlaku Tanggal persyaratan dan ketentuan berlaku. Defaultnya adalah tanggal saat ini. Anda harus memasukkan tanggal saat ini atau tanggal mendatang.
Versi Versi persyaratan dan ketentuan. Nomor versi memungkinkan Anda memantau berbagai versi persyaratan dan ketentuan.
URL URL persyaratan dan ketentuan.
- Klik Create.
Persyaratan dan Ketentuan baru akan ditambahkan ke bagian Persyaratan dan ketentuan di halaman Profil Organisasi.
- Ulangi langkah 3 hingga 5 untuk menambahkan persyaratan dan ketentuan lainnya.
- Klik Simpan untuk menyimpan perubahan profil organisasi.
Mengedit persyaratan dan ketentuan menggunakan UI
Anda tidak dapat mengedit Persyaratan dan ketentuan secara langsung. Sebagai gantinya, Anda harus menghapus persyaratan dan ketentuan yang ingin diedit, lalu menambahkan entri persyaratan dan ketentuan baru.
Menghapus persyaratan dan ketentuan menggunakan UI
- Akses halaman Profil Organisasi, seperti yang dijelaskan di Menjelajahi halaman Profil Organisasi.
- Klik Edit di halaman Profil Organisasi.
- Dalam daftar Persyaratan & Ketentuan, posisikan kursor di atas Persyaratan & Ketentuan yang ingin dihapus.
- Klik .
Mengelola persyaratan dan ketentuan menggunakan API
Kelola persyaratan dan ketentuan menggunakan API, seperti yang dijelaskan di bagian berikut.
Menambahkan persyaratan dan ketentuan menggunakan API
Tambahkan Persyaratan & Ketentuan dengan mengeluarkan permintaan POST ke /mint/organizations/{org_name}/tncs
.
Saat menambahkan Persyaratan & Ketentuan, Anda dapat secara opsional menentukan:
- URL
- Teks pelengkap (seperti deskripsi)
- Tanggal saat Persyaratan & Ketentuan mulai berlaku
- Nomor versi
Lihat Properti konfigurasi persyaratan dan ketentuan untuk informasi tambahan tentang opsi ini.
Contoh:
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
Berikut adalah contoh responsnya:
{ "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" }
Melihat persyaratan dan ketentuan menggunakan API
Melihat S&K tertentu atau semua S&K untuk organisasi.
Lihat Persyaratan & Ketentuan spesifik dengan mengeluarkan permintaan GET ke /mint/organizations/{org_name}/tncs/{tncs_id}
, di mana {tncs_id}
merupakan identifikasi S&K tertentu (ID ditampilkan dalam respons saat Anda membuat S&K). Contoh:
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
Lihat semua S&K untuk organisasi dengan mengajukan permintaan GET ke
/mint/organizations/{org_name}/tncs
. Contoh:
curl -X GET "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/tncs" \ -H "Accept: application/json" \ -u email:password
Berikut adalah contoh responsnya:
{
"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 }
Menyetujui dokumen persyaratan dan ketentuan untuk developer atau perusahaan yang menggunakan API
Setujui dokumen T&C untuk developer atau perusahaan tertentu dengan mengeluarkan permintaan POST ke salah satu API berikut:
/mint/organizations/{org_name}/developers/{dev_id}/tncs/{tncs_id}/developer-tncs
/mint/organizations/{org_name}/companies/{company_id}/tncs/{tncs_id}/developer-tncs
Dengan {dev_id}
sebagai ID developer (alamat email), {company_id}
adalah ID perusahaan, dan {tncs_id}
adalah ID dokumen persyaratan dan ketentuan.
Contoh:
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
Berikut adalah contoh responsnya:
auditDate
disetel ke waktu saat ini dalam UTC.{ "action": "ACCEPTED", "auditDate": "2018-10-01 07:24:45", "id": "dev2@myorg.com", "tnc": { "id": "5a291b86-42e3-4ae1-8db3-efe4b0877316", ... } }
Melihat persyaratan dan ketentuan yang disetujui oleh developer atau perusahaan yang menggunakan API
Lihat S&C yang disetujui oleh developer atau perusahaan tertentu dengan mengajukan permintaan GET ke salah satu API berikut:
/mint/organizations/{org_name}/developers/{dev_id}/developer-tncs
/mint/organizations/{org_name}/companies/{company_id}/developer-tncs
Dengan {dev_id}
sebagai ID developer (alamat email) dan {company_id}
adalah ID perusahaan.
Contoh:
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
Berikut adalah contoh responsnya:
{ "developerTnc": [ { "action": "ACCEPTED", "auditDate": "2018-08-29 07:24:45", "id": "dev2@myorg.com", "tnc": { "id": "26abc14c-c628-4c38-8840-a343c8ee9437", ... } }], "totalRecords": 1 }
Mengedit persyaratan dan ketentuan menggunakan API
Edit S&C dengan mengeluarkan permintaan PUT ke
/mint/organizations/{org_named}/tncs/{tncs_id}
, dengan {tncs_id}
sebagai
identifikasi S&C. Saat melakukan pembaruan, Anda harus menentukan setelan yang diperbarui dan identifikasi S&C dalam isi permintaan. Misalnya, permintaan berikut mengedit nomor versi S&C (properti yang diperbarui disorot dalam contoh):
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
Berikut adalah contoh responsnya:
{ "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" }
Menghapus persyaratan dan ketentuan menggunakan API
Hapus Persyaratan & Ketentuan dengan mengeluarkan permintaan HAPUS ke
/mint/organizations/{org_name}/tncs/{tncs_id}
, dengan {tncs_id}
sebagai
identifikasi S&K. Contoh:
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
Properti konfigurasi persyaratan dan ketentuan untuk API
Tabel berikut merangkum properti konfigurasi yang dapat ditetapkan menggunakan API untuk persyaratan dan ketentuan.
Nama | Deskripsi | Default | Wajib diisi? |
---|---|---|---|
url |
URL Persyaratan & Ketentuan. |
T/A | Tidak |
tncText |
Teks (seperti deskripsi singkat) untuk Persyaratan & Ketentuan. |
T/A | Tidak |
version |
Versi Persyaratan & Ketentuan. Nomor versi memungkinkan Anda melacak berbagai versi S&K. |
T/A | Ya |
startDate |
Tanggal S&C mulai berlaku. |
T/A | Ya |
organization |
Organisasi untuk Persyaratan & Ketentuan. |
T/A | Tidak |
Langkah berikutnya
Pelajari cara menambahkan mata uang yang didukung ke mata uang yang pertama kali disiapkan untuk organisasi Anda di bagian Mengelola mata uang yang didukung.