Paradigma akses terprogram untuk marketplace komersial

Diagram ini menunjukkan pola panggilan API yang digunakan untuk membuat templat laporan baru, menjadwalkan laporan kustom, dan mengambil data kegagalan.

Gambar 1: Aliran tingkat tinggi dari pola panggilan API

Daftar ini menyediakan detail selengkapnya tentang Gambar 1.

1. Aplikasi Klien dapat menentukan skema/templat laporan kustom dengan memanggil Buat API Kueri Laporan. Sebagai alternatif, Anda dapat menggunakan templat laporan (QueryId) dari daftar kueri sistem .
2. Setelah berhasil, API Buat Templat Laporan mengembalikan QueryId.
3. Aplikasi klien kemudian memanggil Create Report API menggunakan QueryID bersama dengan tanggal mulai laporan, Interval Ulangi, Pengulangan, dan URI Panggilan Balik opsional.
4. Setelah berhasil, Create Report API mengembalikan ReportID.
5. Aplikasi klien akan diberi tahu di URI panggilan balik segera setelah data laporan siap diunduh.
6. Aplikasi klien kemudian menggunakan Get Report Executions API untuk mengkueri status laporan dengan rentang Report ID dan tanggal.
7. Setelah berhasil, tautan unduhan laporan dikembalikan dan aplikasi dapat memulai pengunduhan data.

Spesifikasi bahasa kueri laporan

Meskipun kami menyediakan kueri sistem dapat Anda gunakan untuk membuat laporan, Anda juga dapat membuat kueri Anda sendiri berdasarkan kebutuhan bisnis Anda. Untuk mempelajari selengkapnya tentang kueri kustom, lihat Spesifikasi kueri kustom.

Membuat API kueri laporan

API ini membantu membuat kueri kustom yang menentukan himpunan data tempat kolom dan metrik perlu diekspor. API memberikan fleksibilitas untuk membuat templat pelaporan baru berdasarkan kebutuhan bisnis Anda.

Anda juga dapat menggunakan kueri sistem yang kami sediakan. Saat templat laporan kustom tidak diperlukan, Anda dapat memanggil Create Report API secara langsung menggunakan QueryIds dari kueri sistem yang kami sediakan.

Contoh berikut menunjukkan cara membuat kueri kustom untuk mendapatkan Penggunaan yang Dinormalisasi dan Estimasi Biaya Keuangan untuk SKU BERBAYAR dari himpunan data ISVUsage untuk bulan lalu.

sintaks permintaan

Header Permintaan

parameter Jalur

Tidak

parameter kueri

Tidak

Meminta contoh payload

{
    "Name": "ISVUsageQuery",
    "Description": "Normalized Usage and Estimated Financial Charges for PAID SKUs",
    "Query": "SELECT UsageDate, NormalizedUsage, EstimatedExtendedChargePC FROM ISVUsage WHERE SKUBillingType = 'Paid' ORDER BY UsageDate DESC TIMESPAN LAST_MONTH"
}

Glosarium

Tabel ini menyediakan definisi utama elemen dalam payload permintaan.

Respons sampel

Payload respons disusun sebagai berikut:

Kode respons: 200, 400, 401, 403, 500

Contoh payload respons:

{
  "value": [
        {
            "queryId": "78be43f2-e35f-491a-8cd5-78fe14194f9c",
            "name": " ISVUsageQuery",
            "description": "Normalized Usage and Estimated Financial Charges for PAID SKUs",
            "query": " SELECT UsageDate, NormalizedUsage, EstimatedExtendedChargePC FROM ISVUsage WHERE SKUBillingType = 'Paid' ORDER BY UsageDate DESC TIMESPAN LAST_MONTH",
            "type": "userDefined",
            "user": "142344300",
            "createdTime": "2024-01-06T05:38:34Z"
        }
    ],
    "totalCount": 1,
    "message": "Query created successfully",
    "statusCode": 200
}

Glosarium

Tabel ini menyediakan definisi utama elemen dalam respons.

Membuat API laporan

Pada pembuatan templat laporan kustom dengan sukses dan menerima QueryID sebagai bagian dari respons Buat Kueri Laporan, API ini dapat dipanggil untuk menjadwalkan kueri yang akan dijalankan secara berkala. Anda dapat mengatur frekuensi dan jadwal untuk laporan yang akan dikirimkan. Untuk kueri sistem yang kami berikan, API Buat Laporan juga dapat dipanggil dengan QueryId.

sintaks permintaan

Header Permintaan

parameter Jalur

Tidak

Parameter kueri

Tidak

Meminta contoh payload

{
  "ReportName": "ISVUsageReport",
  "Description": "Normalized Usage and Estimated Financial Charges for PAID SKUs",
  "QueryId": "78be43f2-e35f-491a-8cd5-78fe14194f9c ",
  "StartTime": "2021-01-06T19:00:00Z ",
  "executeNow": false,
  "RecurrenceInterval": 48,
  "RecurrenceCount": 20,
  "Format": "csv",
  "CallbackUrl": "https://<SampleCallbackUrl>"
  "callbackMethod": "GET",
}

Glosarium

Tabel ini menyediakan definisi utama elemen dalam payload permintaan.

Contoh respons

Payload respons disusun sebagai berikut:

Kode respons: 200, 400, 401, 403, 404, 500

Muatan Respons

{
  "Value": [
    {
            "reportId": "72fa95ab-35f5-4d44-a1ee-503abbc88003",
            "reportName": "ISVUsageReport",
            "description": "Normalized Usage and Estimated Financial Charges for PAID SKUs",
            "queryId": "78be43f2-e35f-491a-8cd5-78fe14194f9c",
            "query": "SELECT UsageDate, NormalizedUsage, EstimatedExtendedChargePC FROM ISVUsage WHERE SKUBillingType = 'Paid' ORDER BY UsageDate DESC TIMESPAN LAST_MONTH",
            "user": "142344300",
            "createdTime": "2024-01-06T05:46:00Z",
            "modifiedTime": null,
            "startTime": "2024-01-06T19:00:00Z",
            "reportStatus": "Active",
            "recurrenceInterval": 48,
            "recurrenceCount": 20,
            "callbackUrl": "https://<SampleCallbackUrl>",
            "callbackMethod": "GET",
            "format": "csv"
    }
  ],
  "TotalCount": 1,
  "Message": "Report created successfully",
  "StatusCode": 200
}

Glosarium

Tabel ini menyediakan definisi utama elemen dalam respons.

Mendapatkan API eksekusi laporan

Anda dapat menggunakan metode ini untuk mengkueri status eksekusi laporan menggunakan ReportId yang diterima dari Create Report API. Metode mengembalikan tautan unduhan laporan jika laporan siap diunduh. Jika tidak, fungsi tersebut akan mengembalikan status. Anda juga dapat menggunakan API ini untuk mendapatkan semua eksekusi yang telah terjadi untuk laporan tertentu.

sintaks permintaan

Header Permintaan

parameter Jalur

Tidak

parameter Kueri

Permintaan payload

Tidak

Respons sampel

Payload respons disusun sebagai berikut:

Kode respons: 200, 400, 401, 403, 404, 500

Contoh payload respons:

{
    "value": [
        {
            "executionId": "a0bd78ad-1a05-40fa-8847-8968b718d00f",
            "reportId": "72fa95ab-35f5-4d44-a1ee-503abbc88003",
            "recurrenceInterval": 4,
            "recurrenceCount": 10,
            "callbackUrl": null,
            "format": "csv",
            "executionStatus": "Completed",
            "reportAccessSecureLink": "https://<path to report for download>",
            "reportExpiryTime": null,
            "reportGeneratedTime": "2021-01-13T14:40:46Z"
        }
    ],
    "totalCount": 1,
    "message": null,
    "statusCode": 200
}

Setelah eksekusi laporan selesai, status eksekusi Completed ditampilkan. Anda dapat mengunduh laporan dengan memilih URL di reportAccessSecureLink.

Glosarium

Definisi utama elemen dalam respons.

Anda dapat mencoba API melalui URL API Swagger.

Konten terkait

• Lakukan panggilan API pertama Anda untuk laporan Wawasan Marketplace