Kelola persyaratan dan ketentuan

Anda sedang melihat dokumentasi Apigee Edge.
Buka Dokumentasi Apigee X. info

Pengantar

Anda harus menambahkan persyaratan dan ketentuan ("S&K") ke profil organisasi sebelum memublikasikan paket tarif. Persyaratan dan Ketentuan berada di luar organisasi untuk profil. Di profil organisasi, tentukan lokasi (URL publik) Persyaratan dan Ketentuan.

Setelah Anda memublikasikan paket tarif, versi Persyaratan & Ketentuan saat ini ditampilkan di portal developer. Developer hanya dapat membeli paket setelah mereka menyetujui persyaratan yang saat ini Persyaratan dan Ketentuan.

Menambahkan persyaratan dan ketentuan menggunakan UI

1. Akses halaman Profil Organisasi, seperti yang dijelaskan di Menjelajahi halaman Profil Organisasi.
2. Klik Edit.
3. Di bagian Persyaratan dan ketentuan laman Profil Organisasi, klik Tambahkan persyaratan dan kondisi.

   Dialog Persyaratan dan ketentuan baru ditampilkan

4. Masukkan informasi berikut:

   Kolom	Deskripsi
   Tanggal Mulai Berlaku	Tanggal persyaratan dan ketentuan berlaku. Defaultnya adalah tanggal. Anda harus memasukkan tanggal saat ini atau tanggal mendatang.
   Versi	Versi persyaratan dan ketentuan. Nomor versi memungkinkan Anda untuk menyimpan melacak berbagai versi persyaratan dan ketentuan.
   URL	URL persyaratan dan ketentuan.

5. Klik Buat.

   Persyaratan dan Ketentuan baru ditambahkan ke bagian Persyaratan dan ketentuan di Profil Organisasi kami.

6. Ulangi langkah 3 sampai 5 untuk menambahkan persyaratan dan ketentuan tambahan.
7. 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 tambahkan entri persyaratan dan ketentuan baru.

Menghapus persyaratan dan ketentuan menggunakan UI

1. Akses halaman Profil Organisasi, seperti yang dijelaskan di Menjelajahi halaman Profil Organisasi.
2. Klik Edit di halaman Profil Organisasi.
3. Dalam daftar Persyaratan dan Ketentuan, posisikan kursor di atas Persyaratan dan Ketentuan yang ingin dihapus.
4. 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 pengiring (seperti deskripsi)
• Tanggal S&K diberlakukan
• Nomor versi

Lihat Properti konfigurasi persyaratan dan ketentuan untuk informasi informasi 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 ini 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 Persyaratan & Ketentuan tertentu atau semua Persyaratan dan Ketentuan untuk organisasi.

Lihat spesifik Persyaratan&Ketentuan dengan mengirimkan permintaan GET ke /mint/organizations/{org_name}/tncs/{tncs_id}, dengan {tncs_id} adalah identifikasi Persyaratan & Ketentuan tertentu (ID ditampilkan di saat Anda membuat Persyaratan & Ketentuan). 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 mengeluarkan 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 ini 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

Menerima dokumen Persyaratan&Ketentuan untuk developer atau perusahaan tertentu dengan menerbitkan POST masing-masing 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} adalah 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 ini contoh responsnya:

{
  "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&K yang disetujui oleh developer atau perusahaan tertentu dengan menerbitkan GET masing-masing 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} adalah 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 ini 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&K dengan mengeluarkan permintaan PUT untuk /mint/organizations/{org_named}/tncs/{tncs_id}, dengan {tncs_id} adalah identifikasi S&K. Saat melakukan update, Anda perlu menentukannya dalam permintaan isi pengaturan yang diperbarui dan identifikasi Persyaratan&Ketentuan. Misalnya, minta pengeditan nomor versi untuk Persyaratan & Ketentuan (properti yang diperbarui ditandai 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 ini 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 S&K dengan mengeluarkan permintaan DELETE untuk /mint/organizations/{org_name}/tncs/{tncs_id}, dengan {tncs_id} adalah 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 meringkas properti konfigurasi yang dapat ditetapkan menggunakan API untuk persyaratan dan ketentuan.

Langkah berikutnya

Pelajari cara menambahkan mata uang yang didukung ke mata uang yang pertama kali disiapkan untuk organisasi Anda di Kelola yang didukung mata uang.