Mengelola laporan

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

Pengantar

Laporan monetisasi memungkinkan Anda mengakses informasi penggunaan yang difokuskan dan aktivitas transaksi. Misalnya, Anda dapat menentukan aplikasi, developer, paket produk API, atau produk API mana yang memiliki aktivitas transaksi untuk rentang tanggal tertentu. Dengan monetisasi, Anda dapat membuat laporan ringkasan atau detail yang melacak penggunaan API.

Jenis laporan monetisasi

Anda dapat membuat jenis laporan monetisasi berikut.

Tentang retensi data

Di cloud publik Apigee Edge, retensi data monetisasi adalah hak paket. Lihat hak monetisasi di https://cloud.google.com/apigee/specsheets. Hubungi Penjualan Apigee jika Anda ingin data monetisasi disimpan setelah periode hak berakhir. Retensi data yang diperpanjang diaktifkan pada saat permintaan dan tidak dapat diaktifkan secara surut untuk menyertakan data lebih awal dari periode retensi data asli.

Tentang transaksi duplikat

Jika membandingkan laporan transaksi monetisasi dengan data Analytics, Anda mungkin melihat sejumlah kecil transaksi duplikat. Ini adalah perilaku yang diharapkan karena sistem monetisasi dapat memproses beberapa juta transaksi setiap hari dengan banyak transaksi yang diproses secara paralel pada waktu tertentu. Rata-rata, ~0,1% transaksi mungkin merupakan duplikat.

Menjelajahi halaman Laporan Monetisasi

Akses halaman Laporan Monetisasi, seperti yang dijelaskan di bawah.

Mengonfigurasi laporan

Konfigurasikan laporan menggunakan UI, seperti yang dijelaskan di bagian berikut.

Langkah-langkah untuk mengonfigurasi laporan

Konfigurasikan laporan menggunakan UI Edge atau UI Edge Klasik.

Mengonfigurasi laporan penagihan

Ikuti langkah-langkah untuk mengonfigurasi laporan dan masukkan informasi berikut di halaman laporan:

Mengonfigurasi laporan saldo prabayar

Mengonfigurasi laporan pendapatan

Ikuti langkah-langkah untuk mengonfigurasi laporan dan masukkan informasi berikut di halaman laporan:

Menyertakan atribut transaksi kustom dalam laporan ringkasan pendapatan

Kebijakan perekaman transaksi memungkinkan Anda mengambil data atribut kustom dari transaksi, dan Anda dapat menyertakan atribut kustom tersebut dalam laporan pendapatan ringkasan. Tentukan kumpulan atribut kustom default yang disertakan dalam tabel database monetisasi dengan menetapkan properti MINT.SUMMARY_CUSTOM_ATTRIBUTES untuk organisasi Anda.

Penggunaan fitur ini memerlukan beberapa pemikiran dan perencanaan, jadi tinjau pertimbangan di bawah.

Jika Anda adalah pelanggan cloud, hubungi Dukungan Apigee Edge untuk menetapkan properti. Jika Anda adalah pelanggan Apigee Edge untuk Cloud Pribadi, tetapkan tanda menggunakan permintaan PUT ke API berikut dengan kredensial System Administrator.

curl -u email:password -X PUT -H "Content-type:application/xml" http://host:port/v1/o/{myorg} -d \
"<Organization type="trial" name="MyOrganization">
    <Properties>
        <Property name="features.isMonetizationEnabled">true</Property>
        <Property name="MINT.SUMMARY_CUSTOM_ATTRIBUTES">[&quot;partner_id&quot;,&quot;tax_source&quot;]</Property>
        <Property name="features.topLevelDevelopersAreCompanies">false</Property>
    </Properties>
</Organization>"

Dalam contoh ini, panggilan API mengaktifkan fitur dan menambahkan kolom partner_id dan tax_source ke database monetisasi. Perhatikan bahwa array atribut kustom dalam panggilan API dienkode URL.

Pertimbangan untuk menyertakan atribut transaksi kustom dalam laporan

• Pastikan nama atribut yang ingin Anda gunakan sebelum membuatnya dengan API. Nama tersebut adalah nama kolom dalam database, dan data atribut kustom selalu disimpan di sana.
• Ada 10 slot atribut kustom yang tersedia di setiap kebijakan perekaman transaksi, seperti ditunjukkan pada gambar berikut. Gunakan nama dan posisi atribut yang sama persis untuk atribut yang sama di seluruh produk yang akan disertakan dalam laporan. Misalnya, dalam kebijakan perekaman transaksi berikut, atribut kustom partner_id dan tax_source masing-masing menempati kotak 4 dan 5. Ini harus berupa nama dan posisi mereka dalam semua kebijakan pencatatan transaksi agar produk disertakan dalam pelaporan.
  
  

Untuk menyertakan atribut kustom dalam laporan pendapatan ringkasan setelah Anda mengaktifkan fitur ini, gunakan API laporan dengan menambahkan transactionCustomAttributes ke MintCriteria. Lihat Opsi konfigurasi kriteria.

Mengonfigurasi laporan varians (Tidak digunakan lagi)

Ikuti langkah-langkah untuk mengonfigurasi laporan dan masukkan informasi berikut di halaman laporan:

Membuat dan mendownload laporan

Setelah membuat laporan, Anda dapat mendownload hasil laporan dalam format file CSV atau ZIP. Anda dapat membuat file CSV atau zip secara sinkron atau secara asinkron.

• Untuk laporan sinkron, Anda menjalankan permintaan laporan dan permintaan tersebut diblokir hingga server analisis memberikan respons. Namun, karena laporan mungkin perlu memproses data dalam jumlah besar (misalnya, ratusan GB), laporan sinkron mungkin gagal karena waktu tunggu habis.

  Tingkat laporan Ringkasan hanya mendukung pembuatan sinkron.

• Untuk laporan asinkron, Anda menjalankan permintaan laporan dan mengambil hasilnya di lain waktu. Beberapa situasi saat pemrosesan kueri asinkron mungkin menjadi alternatif yang baik mencakup:

  • Menganalisis dan membuat laporan yang mencakup interval waktu yang besar.
  • Menganalisis data dengan berbagai dimensi pengelompokan dan batasan lainnya yang menambah kompleksitas kueri.
  • Mengelola kueri saat Anda mendapati bahwa volume data telah meningkat secara signifikan untuk beberapa pengguna atau organisasi.

  Tingkat laporan Detail mendukung pembuatan asinkron.

Untuk membuat dan mendownload laporan dalam format file CSV atau zip, lakukan salah satu tugas berikut:

1. Akses halaman Laporan.
2. Arahkan kursor ke laporan yang ingin didownload.

3. Di kolom Diubah, klik:

   1. Ikon atau ikon (untuk laporan Ringkasan). Laporan disimpan ke file CSV atau zip secara sinkron.
   2. Kirim tugas (untuk Laporan mendetail). Tugas asinkron dimulai.

      1. Pantau status tugas di kolom Diubah.

         Ikon disk akan muncul saat laporan siap didownload:

         
      2. Setelah tugas selesai, klik ikon disk untuk mendownload laporan.

Berikut adalah contoh file CSV untuk laporan penagihan ringkasan.

Mengedit laporan

Untuk mengedit laporan:

1. Akses halaman Laporan.
2. Arahkan kursor ke laporan yang ingin diedit, lalu klik di menu tindakan.
3. Perbarui konfigurasi laporan sesuai kebutuhan.
4. Klik Perbarui laporan untuk menyimpan konfigurasi laporan yang diperbarui.

Menghapus laporan

Untuk menghapus laporan:

1. Akses halaman Laporan.
2. Arahkan kursor ke laporan yang ingin Anda hapus.
3. Klik di menu tindakan.

Mengelola laporan monetisasi menggunakan API

Bagian berikut menjelaskan cara mengelola laporan monetisasi menggunakan API.

Mengonfigurasi laporan menggunakan API

Untuk mengonfigurasi laporan bagi seluruh organisasi, buat permintaan POST ke /organizations/{org_name}/report-definitions.

Untuk mengonfigurasi laporan bagi developer tertentu, buat permintaan POST ke /organizations/{org_name}/developers/{dev_id}/report-definitions, dengan {dev_id} adalah identifikasi developer.

Saat membuat permintaan, Anda harus menentukan nama dan jenis laporan. Jenisnya adalah salah satu dari berikut: BILLING, REVENUE, VARIANCE (tidak digunakan lagi), atau PREPAID_BALANCE. Selain itu, Anda dapat menentukan kriteria di properti mintCriteria yang mengonfigurasi laporan lebih lanjut. Ada berbagai kriteria yang dapat Anda tentukan. Hal ini memberi Anda banyak fleksibilitas dalam mengonfigurasi laporan. Beberapa hal yang dapat Anda tentukan sebagai kriteria adalah:

• Untuk laporan penagihan atau saldo prabayar, bulan penagihan untuk laporan
• Untuk laporan pendapatan, jenis transaksi yang tercakup dalam laporan, seperti transaksi pembelian, transaksi tagihan, dan pengembalian dana
• Untuk laporan saldo prabayar, developer yang menjadi tujuan laporan
• Untuk laporan pendapatan, paket produk API (atau paket API), produk, paket tarif, dan aplikasi yang menjadi cakupan laporan
• Untuk laporan pendapatan atau varians, mata uang yang berlaku untuk laporan
• Untuk laporan penagihan, saldo prabayar, atau pendapatan, baik laporan tersebut berupa laporan ringkasan maupun laporan mendetail
• Untuk laporan ringkasan pendapatan, sertakan atribut transaksi kustom dalam laporan

Lihat Opsi konfigurasi laporan untuk mengetahui daftar lengkap kriteria laporan.

Misalnya, kode berikut membuat laporan pendapatan yang merangkum aktivitas transaksi untuk bulan Juli 2015. Laporan ini mencakup berbagai jenis transaksi yang ditentukan dalam properti transactionTypes, dan berlaku khusus untuk paket produk Payment API dan produk Payment API. Karena tidak ada developer atau aplikasi tertentu yang ditentukan dalam definisi laporan, laporan ini berlaku untuk semua developer dan aplikasi. Selain itu, karena properti currencyOption ditetapkan ke LOCAL, setiap baris laporan akan ditampilkan menggunakan mata uang paket tarif yang berlaku. Selain itu, properti groupBy menentukan bahwa kolom dalam laporan akan dikelompokkan dalam urutan berikut: PAKET, PRODUK, DEVELOPER, APLIKASI, dan RATEPLAN (termasuk nama dan ID paket tarif dalam laporan).

$ curl -H "Content-Type: application/json" -X POST -d \
'{
      "name": "July 2015 revenue report",
      "description": " July 2015 revenue report for Payment product",
      "type": "REVENUE",     
      "mintCriteria":{
         "fromDate":"2015-07-01 00:00:00",
         "toDate":"2015-08-01 13:35:00",
         "showTxDetail":true,
         "showSummary":true,
         "transactionTypes":[
            "PURCHASE",
            "CHARGE",
            "REFUND",
            "CREDIT",
            "SETUPFEES",
            "TERMINATIONFEES",
            "RECURRINGFEES"
         ],
         "monetizationPackageIds":[
            "payment"
         ],
         "productIds":[
            "payment"
         ],
         "currencyOption":"LOCAL",
         "groupBy":[
            "PACKAGE",
            "PRODUCT",
            "DEVELOPER",
            "APPLICATION",
            "RATEPLAN"
         ]
      }
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/report-definitions" \
-u email:password

Berikut adalah cara membuat laporan penagihan mendetail yang menunjukkan aktivitas developer DEV FIVE untuk Juni 2015.

$ curl -H "Content-Type:application/json" -X POST -d \
'{
      "name": "June billing report, DEV FIVE",
      "description": "June billing report, DEV FIVE",
      "type": "BILLING",      
      "mintCriteria":{
         "billingMonth": "JUNE",
         "billingYear": 2015,
         "showTxDetail":true,
         "showSummary":false,         
         "currencyOption":"LOCAL"         
      },
      "devCriteria":[{
         "id":"RtHAeZ6LtkSbEH56",
         "orgId":"myorg"}]
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/5cTWgdUvdr6JW3xU/report-definitions" \
-u email:password

Melihat konfigurasi laporan menggunakan API

Anda dapat melihat konfigurasi laporan tertentu atau semua konfigurasi laporan untuk organisasi. Anda juga dapat melihat konfigurasi laporan untuk setiap developer.

Untuk melihat konfigurasi laporan tertentu bagi organisasi, buat permintaan GET ke /organizations/{org_name}/report-definitions/{report_definition_id}, dengan {report_definition_id} adalah identifikasi konfigurasi laporan tertentu (ID ditampilkan dalam respons saat Anda membuat konfigurasi laporan). Contoh:

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/report-definitions/1f7fa53b-de5a-431d-9438-62131e1396c5" \
-u email:password

Untuk melihat semua konfigurasi laporan untuk organisasi, buat permintaan GET ke /organizations/{org_name}/report-definitions.

Anda dapat meneruskan parameter kueri berikut untuk memfilter dan mengurutkan hasil:

Misalnya, kode berikut menampilkan konfigurasi laporan untuk organisasi dan membatasi pengambilan hingga maksimum lima konfigurasi laporan:

$ curl -H "Accept:application/json" -X GET \ 
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/report-definitions?size=5" \ 
-u email:password

Responsnya akan terlihat seperti ini (hanya sebagian respons yang ditampilkan):

{
  "reportDefinition" : [ {
    "description" : "Test revenue report",
    "developer" : null,
    "id" : "1f7fa53b-de5a-431d-9438-62131e1396c5",
    "lastModified" : "2015-08-27 15:44:03",
    "mintCriteria" : {
      "asXorg" : false,
      "currencyOption" : "LOCAL",
      "fromDate" : "2015-07-01 00:00:00",
      "groupBy" : [ "PACKAGE", "PRODUCT", "DEVELOPER", "APPLICATION", "RATEPLAN" ],
      "monetizationPackageIds" : [ "payment" ],
      "productIds" : [ "payment" ],
      "showRevSharePct" : false,
      "showSummary" : true,
      "showTxDetail" : true,
      "showTxType" : false,
      "toDate" : "2015-08-01 00:05:00",
      "transactionTypes" : [ "PURCHASE", "CHARGE", "REFUND", "CREDIT", "SETUPFEES", "TERMINATIONFEES", "RECURRINGFEES" ]
    },
    "name" : "Test revenue report",
    "organization" : {
      ...
    },
    "type" : "REVENUE"
  }, {
    "description" : "June billing report, DEV FIVE",
    "developer" : null,
    "id" : "fedac696-ce57-469b-b62c-a77b535fd0eb",
    "lastModified" : "2015-08-27 17:13:20",
    "mintCriteria" : {
      "asXorg" : false,
      "billingMonth" : "JUNE",
      "billingYear" : 2015,
      "currencyOption" : "LOCAL",
      "showRevSharePct" : false,
      "showSummary" : false,
      "showTxDetail" : true,
      "showTxType" : false
    },
    "name" : "June billing report, DEV FIVE",
    "organization" : {
      ...
    },
    "type" : "BILLING"
  } ],
  "totalRecords" : 2
}

Untuk melihat konfigurasi laporan bagi developer tertentu, buat permintaan GET ke /organizations/{org_name}/developers/{dev_id}/report-definitions, dengan {dev_id} adalah identifikasi developer. Saat membuat permintaan, Anda dapat menentukan parameter kueri yang dijelaskan di atas untuk memfilter dan mengurutkan data.

Misalnya, kode berikut menampilkan konfigurasi laporan untuk developer tertentu dan mengurutkan respons berdasarkan nama laporan:

$ curl -H "Accept:application/json" -X GET \ 
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/5cTWgdUvdr6JW3xUreport-definitions?sort=name" \ 
-u email:password

Memperbarui konfigurasi laporan menggunakan API

Untuk memperbarui konfigurasi laporan, keluarkan permintaan PUT ke /organizations/{org_name}/report-definitions/{report_definition_id}, dengan {report_definition_id} adalah identifikasi konfigurasi laporan tertentu. Saat melakukan pembaruan, Anda harus menentukan nilai konfigurasi yang diperbarui dan ID konfigurasi laporan dalam isi permintaan. Misalnya, permintaan berikut memperbarui laporan ke laporan ringkasan (properti yang diperbarui ditandai):

$ curl -H "Content-Type: application/json" -X PUT -d \
 '{
       "id": "fedac696-ce57-469b-b62c-a77b535fd0eb",
       "name": "June billing report, DEV FIVE",
       "description": "June billing report, DEV FIVE",
       "type": "BILLING",      
       "mintCriteria":{      
         "billingMonth": "JUNE",
         "billingYear": 2015,
         "showTxDetail":false,
         "showSummary":true    
        }     
 }' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/report-definitions/fedac696-ce57-469b-b62c-a77b535fd0eb" \
-u email:password

Responsnya akan terlihat seperti ini (hanya sebagian respons yang ditampilkan):

{
 "description" : "June billing report, DEV FIVE",
  "developer" : null,
  "id" : "fedac696-ce57-469b-b62c-a77b535fd0eb",
  "lastModified" : "2015-08-27 17:47:29",
  "mintCriteria" : {
    "asXorg" : false,
    "billingMonth" : "JUNE",
    "billingYear" : 2015,
    "showRevSharePct" : false,
    "showSummary" : true,
    "showTxDetail" : false,
    "showTxType" : false
  },
  "name" : "June billing report, DEV FIVE",
  "organization" : {
    ... 
  },
  "type" : "BILLING"
}

Menghapus konfigurasi laporan menggunakan API

Untuk menghapus konfigurasi laporan, buat permintaan DELETE ke /organizations/{org_namer}/report-definitions/{report_definition_id}, dengan {report_definition_id} adalah identifikasi konfigurasi laporan yang akan dihapus. Contoh:

$ curl -H "Accept:application/json" -X DELETE \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/report-definitions/fedac696-ce57-469b-b62c-a77b535fd0eb" \
-u email:password

Membuat laporan menggunakan API

Setelah mengonfigurasi laporan, Anda dapat membuat laporan dalam format file nilai yang dipisahkan koma (CSV) untuk dilihat.

Untuk membuat laporan, buat permintaan POST ke organizations/{org_id}/{report_type}, dengan {report_type} menentukan jenis laporan yang ingin Anda buat. Jenisnya adalah:

• billing-reports
• revenue-reports
• prepaid-balance-reports
• variance-reports

Misalnya, untuk membuat laporan penagihan, buat permintaan POST ke organizations/{org_name}/billing-reports.

Dalam isi permintaan (untuk semua jenis laporan), tentukan kriteria penelusuran untuk laporan. Gunakan properti mintCriteria untuk menentukan kriteria penelusuran. Lihat Opsi konfigurasi kriteria untuk mengetahui detail selengkapnya.

Misalnya, permintaan berikut menelusuri laporan pendapatan berdasarkan berbagai kriteria seperti tanggal mulai dan akhir laporan serta jenis transaksi.

$ curl -H "Content-Type:application/json" -H "Accept: application/octet-stream" -X POST -d \
'{
      "fromDate":"2015-07-01 00:00:00",
      "toDate":"2015-08-01 13:35:00",
      "showTxDetail":true,
      "showSummary":true,                
      "transactionTypes":[
        "PURCHASE",
        "CHARGE",
        "REFUND",
        "CREDIT",
        "SETUPFEES",
        "TERMINATIONFEES",
        "RECURRINGFEES"
      ],
      "currencyOption":"LOCAL",
      "groupBy":[
        "PACKAGE",
        "PRODUCT",
        "DEVELOPER",
        "APPLICATION",
        "RATEPLAN"]
 }' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/revenue-reports" \
-u email:password

Jika ditemukan, laporan pendapatan akan dibuat dalam format file CSV. Berikut adalah contoh output laporan:

Reporting Period:,From:,2015-07-01,  To:,2015-07-31
API Product:,All
Developer:,All
Application:,All
Currency:,Local
Type of Report:,Summary Revenue Report

Monetization Package,Package ID,API Product,Product ID,Developer Name,Developer ID,Application Name,Application ID,Rate Plan,Plan ID,Currency,Transaction Type,Provider Status,Total Volume,Charged Rate,
Location,location,foo_product,foo_product,Apigee,QQ7uxeMGf3w9W08B,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,
Location,location,foo_product,foo_product,BarCompany,barcompany,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,
Location,location,foo_product,foo_product,fremont,fremont,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,
Location,location,foo_product,foo_product,Juan's Taco Shack,juan-s-taco-sha,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,

Menyertakan atribut kustom developer dalam laporan pendapatan menggunakan API

Khusus untuk laporan pendapatan, Anda dapat menyertakan atribut kustom dalam laporan, jika atribut kustom ditentukan untuk developer. Anda menentukan atribut kustom saat menambahkan developer ke organisasi, seperti yang dijelaskan dalam Mengelola developer aplikasi.

Untuk menyertakan atribut kustom dalam laporan pendapatan, buat permintaan POST ke organizations/{org_name}/revenue-reports dan sertakan array devCustomAttributes dalam isi permintaan:

"devCustomAttributes": [
    "custom_attribute1",
    "custom_attribute2",
    ...
]

Catatan: Jangan tentukan atribut MINT_* dan ADMIN_* yang telah ditentukan sebelumnya dalam array devCustomAttributes.

Misalnya, contoh berikut menyertakan tiga atribut kustom, BILLING_TYPE, SFID, dan ORG_EXT, dalam laporan (jika ditentukan untuk developer):

$ curl -H "Content-Type:application/json" -H "Accept: application/octet-stream" -X POST -d \
'{
      "fromDate":"2015-07-01 00:00:00",
      "toDate":"2015-08-01 13:35:00",
      "showTxDetail":true,
      "showSummary":true,                
      "transactionTypes":[
        "PURCHASE",
        "CHARGE",
        "REFUND",
        "CREDIT",
        "SETUPFEES",
        "TERMINATIONFEES",
        "RECURRINGFEES"
      ],
      "currencyOption":"LOCAL",
      "groupBy":[
        "PACKAGE",
        "PRODUCT",
        "DEVELOPER",
        "APPLICATION",
        "RATEPLAN"
      ],
      "devCustomAttributes": [
         "BILLING_TYPE",
         "SFID",
         "ORG_EXT"
      ]
 }' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/revenue-reports" \
-u email:password

Berikut adalah contoh output laporan yang menyertakan nilai untuk dua atribut kustom:

Reporting Period:,From:,2015-07-01,  To:,2015-07-31
API Product:,All
Developer:,All
Application:,All
Currency:,Local
Type of Report:,Summary Revenue Report

Monetization Package,Package ID,API Product,Product ID,Developer Name,Developer ID,Application Name,Application ID,Rate Plan,Plan ID,Currency,Transaction Type,Provider Status,Total Volume,Charged Rate,BILLING_TYPE,SFID,ORG_EXT 
Location,location,foo_product,foo_product,Apigee,QQ7uxeMGf3w9W08B,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,PREPAID,123,3AA,
Location,location,foo_product,foo_product,BarCompany,barcompany,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,PREPAID,123,3AA,
Location,location,foo_product,foo_product,fremont,fremont,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,PREPAID,123,3AA,
Location,location,foo_product,foo_product,Juan's Taco Shack,juan-s-taco-sha,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,PREPAID,123,3AA,

Melaporkan aktivitas transaksi menggunakan API

Anda dapat melihat aktivitas transaksi untuk organisasi dengan mengeluarkan permintaan POST ke /organizations/{org_name}/transaction-search. Saat membuat permintaan, Anda perlu menentukan kriteria untuk pengambilan. Beberapa hal yang dapat Anda tentukan sebagai kriteria adalah:

• ID satu atau beberapa produk API yang transaksinya diterbitkan.
• Bulan dan tahun penagihan transaksi.
• Developer yang menerbitkan transaksi.
• Jenis transaksi seperti pembelian dan biaya penyiapan.
• Status transaksi seperti berhasil dan gagal.

Lihat Opsi konfigurasi kriteria untuk mengetahui daftar lengkap kriteria.

Misalnya, kode berikut menampilkan transaksi yang dikeluarkan oleh developer tertentu untuk bulan penagihan Juni 2015:

$ curl -H "Content-Type:application/json" -X POST -d \
 '{        
    "billingMonth": "JUNE",
    "billingYear": 2015,
    "devCriteria": [{
      "id": "RtHAeZ6LtkSbEH56",
      "orgId":"myorg"}],
    "transactionTypes": ["PURCHASE", "CHARGE", "SETUPFEES"],
    "transactionStatus": ["SUCCESS", "FAILED"]
    }'
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/transaction-search \
-u email:password

Anda juga dapat menentukan aplikasi, developer, paket produk API, atau produk API mana yang memiliki aktivitas transaksi dalam rentang tanggal tertentu. Anda melihat informasi ini secara terpisah untuk setiap jenis objek. Misalnya, Anda dapat melihat informasi secara khusus tentang aplikasi yang mengakses API dalam paket produk API yang dimonetisasi dalam tanggal mulai dan tanggal akhir yang ditentukan.

Untuk melihat informasi tentang aktivitas transaksi, berikan permintaan GET ke salah satu resource berikut:

Saat membuat permintaan, Anda harus menentukan tanggal mulai dan tanggal akhir sebagai parameter kueri untuk rentang tanggal. Misalnya, permintaan berikut menampilkan transaksi developer selama bulan Agustus 2015.

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers-with-transactions?START_DATE=2015-08-01&END_DATE=2015-08-31" \
-u email:password

Responsnya akan terlihat seperti ini (hanya sebagian respons yang ditampilkan):

{
  "developer" : [ {
    "address" : [ {
      "address1" : "Dev Five Address",
      "city" : "Pleasanton",
      "country" : "US",
      "id" : "0917f15f-9521-4e69-9376-07aa7b7b32ca",
      "isPrimary" : true,
      "state" : "CA",
      "zip" : "94588"
    } ],
    "approxTaxRate" : 0.0900,
    "billingType" : "POSTPAID",
    "broker" : false,
    "developerRole" : [ ],
    "email" : "dev5@myorg.com",
    "hasSelfBilling" : false,
    "id" : "tJZG6broTpGGGeLV",
    "legalName" : "DEV FIVE",
    "name" : "Dev Five",
    "organization" : {
      ...
    },
    "registrationId" : "dev5",
    "status" : "ACTIVE",
    "type" : "UNTRUSTED"
  }, {
    "address" : [ {
      "address1" : "Dev Seven Address",
      "city" : "Pleasanton",
      "country" : "US",
      "id" : "f86d8c9f-6ed1-4323-b050-6adf494096c9",
      "isPrimary" : true,
      "state" : "CA",
      "zip" : "94588"
    } ],
    "approxTaxRate" : 0.0900,
    "billingType" : "POSTPAID",
    "broker" : false,
    "developerRole" : [ ],
    "email" : "dev7@myorg.com",
    "hasSelfBilling" : false,
    "id" : "VI3l8m8IPAvJTvjS",
    "legalName" : "DEV SEVEN",
    "name" : "Dev Seven",
    "organization" : {
      ...
    },
    "registrationId" : "dev7",
    "status" : "ACTIVE",
    "type" : "UNTRUSTED"
  }, ...
  ]
}

Opsi konfigurasi laporan untuk API

Opsi konfigurasi laporan berikut tersedia untuk API:

Opsi konfigurasi kriteria

Opsi konfigurasi berikut tersedia untuk laporan melalui properti mintCriteria:

"devCriteria":[{
    "id":"RtHAeZ6LtkSbEH56",
    "orgId":"my_org"}
]
                

"devCustomAttributes": [
    "custom_attribute1",
    "custom_attribute2",
    ...
]