View a markdown version of this page

Bekerja dengan Aplikasi Manfaat - AWS Pusat Partner

Referensi Pusat Partner AWS API direstrukturisasi. Untuk informasi selengkapnya tentang operasi API yang didukung, lihat Refer Pusat Partner AWS ensi API.

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

Bekerja dengan Aplikasi Manfaat

Aplikasi Manfaat memodelkan permintaan mitra untuk manfaat tertentu. Ini menangkap semua informasi yang diperlukan untuk mengevaluasi dan memproses permintaan sesuai dengan kondisi khusus manfaat. Siklus hidup aplikasi manfaat berlangsung melalui beberapa status mulai dari pembuatan draf hingga persetujuan atau penolakan akhir.

Membuat Aplikasi Manfaat

Mitra memulai proses permintaan manfaat dengan membuat aplikasi manfaat menggunakan tindakan CreateBenefitApplication API. Saat pembuatan, aplikasi memasuki PENDING_SUBMISSION status, memungkinkan mitra untuk menyiapkan informasi lengkap sebelum mengirimkan untuk ditinjau.

Saat membuat aplikasi manfaat, mitra harus menyediakan:

  • Benefit Identifier - ID atau ARN dari manfaat yang diminta

  • Jenis Pemenuhan - Bagaimana mitra mengharapkan untuk menerima manfaat (CREDITS,,,CASH, DISCOUNT ACCESSRECOGNITION, atau) RESOURCE

  • Detail Aplikasi Manfaat - Dokumen JSON yang berisi informasi khusus manfaat sebagaimana didefinisikan oleh skema permintaan manfaat

  • Token Klien - Token idempotensi unik untuk mencegah pengiriman duplikat

Mitra secara opsional dapat menyediakan:

  • Nama dan Deskripsi - Human-readable pengidentifikasi untuk aplikasi

  • Kontak Mitra - Informasi kontak untuk orang yang mengelola permintaan manfaat ini (maksimal 1 kontak)

  • Lampiran File - Dokumentasi pendukung seperti rencana proyek, SOW, bukti biaya, atau survei kepuasan pelanggan (maksimum 10 file)

  • Sumber Daya Terkait - Tautan ke peluang terkait atau alokasi manfaat yang ada (maksimum 10 sumber daya)

  • Tag - Key-value pasangan untuk organisasi sumber daya dan pelacakan (maksimum 200 tag)

CreateBenefitApplicationAPI melakukan validasi lunak, hanya memeriksa jenis dan pola bidang dasar. Validasi logika bisnis penuh terjadi selama pengiriman, memungkinkan mitra untuk menyimpan aplikasi yang tidak lengkap dan kembali nanti untuk menyelesaikannya.

Praktik Terbaik: Mitra harus menggunakan skema permintaan manfaat GetBenefit untuk memahami dengan tepat informasi apa yang diperlukan sebelum membuat aplikasi. Ini mengurangi kemungkinan kegagalan pengiriman karena data yang hilang atau tidak valid.

Memperbarui Aplikasi Manfaat

Mitra dapat memodifikasi draf aplikasi manfaat menggunakan tindakan UpdateBenefitApplication API. Hal ini memungkinkan mitra untuk memperbaiki informasi, menambahkan dokumentasi, atau memperbaiki kesalahan sebelum pengiriman.

Saat memperbarui aplikasi manfaat, mitra harus menyediakan:

  • Identifier - ID atau ARN dari aplikasi manfaat untuk diperbarui

  • Revisi - Nomor revisi saat ini untuk penguncian optimis

  • Detail Aplikasi Manfaat - Dokumen JSON yang lengkap dan diperbarui

Mitra harus menyerahkan objek aplikasi manfaat lengkap, meskipun hanya bidang tertentu yang berubah. Praktik terbaik adalah terlebih dahulu mengambil detail aplikasi terbaru menggunakanGetBenefitApplication, memodifikasi bidang yang diperlukan, kemudian mengirimkan muatan lengkap yang diperbarui ke. UpdateBenefitApplication

Optimistic Locking: Bidang revisi memastikan bahwa pembaruan diterapkan hanya jika aplikasi tidak berubah sejak terakhir diambil. Jika revisi tidak cocok dengan nilai database saat ini, pembaruan ditolak dengan kesalahan konflik. Ini mencegah mitra dari secara tidak sengaja menimpa perubahan yang dibuat oleh proses atau sistem lain.

Pembaruan hanya dapat dilakukan saat aplikasi dalam PENDING_SUBMISSION status. Setelah dikirimkan, aplikasi memasuki proses peninjauan dan tidak dapat lagi diperbarui melalui API ini.

Mengaitkan Sumber Daya dengan Aplikasi Manfaat

Mitra dapat menautkan aplikasi manfaat ke sumber daya terkait menggunakan tindakan AssociateBenefitApplicationResource API. Ini menciptakan hubungan yang berharga antara manfaat dan konteks bisnis di mana mereka digunakan.

Jenis sumber daya yang didukung:

  • PELUANG - Tautkan aplikasi manfaat ke peluang pelanggan tertentu di. Ini sangat berguna untuk manfaat khusus peluang seperti pendanaan MAP atau kredit POC yang terkait dengan keterlibatan pelanggan.

  • BENEFIT_ALLOCATION - Tautkan ke alokasi manfaat yang ada, memungkinkan mitra untuk merantai manfaat atau menunjukkan bagaimana manfaat sebelumnya dimanfaatkan

Asosiasi sumber daya hanya dapat terjadi sebelum pengiriman. Setelah aplikasi manfaat diajukan (status berubah menjadiIN_REVIEW), tidak ada asosiasi lebih lanjut yang diizinkan. Mitra dapat mengaitkan hingga 10 sumber daya dengan setiap aplikasi manfaat.

Untuk memisahkan sumber daya, mitra menggunakan tindakan DisassociateBenefitApplicationResource API. Seperti asosiasi, disasosiasi hanya dapat terjadi dalam PENDING_SUBMISSION status.

penting

Mitra harus memiliki izin yang sesuai untuk mengakses aplikasi manfaat dan membaca sumber daya tertentu yang terkait. API memvalidasi izin ini selama operasi asosiasi.

Mengirimkan Aplikasi Manfaat

Ketika aplikasi manfaat selesai dan siap untuk AWS ditinjau, mitra mengirimkannya menggunakan tindakan SubmitBenefitApplication API. Pengajuan memicu transisi status dari PENDING_SUBMISSION ke IN_REVIEW dan memulai alur kerja persetujuan khusus manfaat.

Setelah diserahkan, API melakukan validasi komprehensif termasuk:

  • Validasi bidang wajib - Memastikan semua bidang wajib dalam detail aplikasi manfaat hadir

  • Validasi format bidang - Memverifikasi bahwa nilai bidang cocok dengan pola dan tipe data yang diharapkan

  • Validasi aturan bisnis - Menerapkan logika dan kendala bisnis khusus manfaat

  • Validasi sumber daya - Mengonfirmasi bahwa semua sumber daya terkait valid dan dapat diakses

  • Validasi file - Memverifikasi bahwa semua lampiran file telah menyelesaikan pemrosesan dengan sukses

Jika validasi gagal, API mengembalikan kode kesalahan ValidationException terperinci dan pesan yang menunjukkan bidang mana yang memerlukan koreksi. Mitra harus mengatasi masalah ini menggunakan UpdateBenefitApplication sebelum mencoba pengiriman lagi.

Persyaratan Pemrosesan File: Aplikasi manfaat tidak dapat dikirimkan jika ada file terlampir yang masih dalam PENDING status. Mitra harus menunggu pemrosesan file selesai (perubahan status keSUCCEEDED) sebelum mengirimkan. Jika file gagal diproses (statusFAILED), mitra harus mengunggah versi yang dikoreksi.

Setelah pengiriman berhasil:

  • Status aplikasi berubah menjadi IN_REVIEW

  • Tim pemilik manfaat diberitahu tentang pengajuan baru

  • Mitra tidak dapat lagi memodifikasi detail aplikasi melalui API pembaruan standar

  • Aplikasi memasuki alur kerja persetujuan yang ditentukan yang dapat mencakup persetujuan bisnis, persetujuan teknis, dan tahap persetujuan keuangan

Mitra dapat melacak kemajuan pengiriman dengan mengambil aplikasi dan memantau bidang Tahap, yang menunjukkan tahap persetujuan saat ini (misalnya, “Persetujuan Bisnis”, “Persetujuan Teknologi”, “Persetujuan Keuangan”).

Mengelola Aplikasi yang Dikirim

Setelah dikirimkan, mitra memiliki opsi terbatas untuk mengelola aplikasi manfaat, tetapi API menyediakan tindakan spesifik untuk skenario umum.

Mengingat Aplikasi Manfaat

Jika mitra menemukan kesalahan atau perlu membuat perubahan setelah pengiriman, mereka dapat mengingat aplikasi menggunakan tindakan RecallBenefitApplication API. Recall mentransisikan aplikasi kembali ke PENDING_SUBMISSION status, memungkinkan pembaruan dan pengiriman ulang.

Saat mengingat aplikasi, mitra harus menyediakan:

  • Identifier - ID atau ARN dari aplikasi manfaat untuk ditarik kembali

  • Alasan - Penjelasan opsional untuk penarikan (maksimum 1000 karakter)

Bidang alasan memungkinkan penelusuran yang lebih baik dan membantu AWS memahami masalah umum yang mengarah pada penarikan kembali, menginformasikan perbaikan masa depan untuk proses aplikasi manfaat.

Setelah penarikan kembali, mitra dapat menggunakan UpdateBenefitApplication untuk membuat perubahan yang diperlukan, lalu mengirim ulang menggunakan SubmitBenefitApplication saat siap.

penting

Ingat biasanya hanya tersedia selama tahap peninjauan awal. Aplikasi yang telah berkembang ke tahap persetujuan selanjutnya atau telah disetujui mungkin tidak memenuhi syarat untuk ditarik kembali.

Mengubah Aplikasi Manfaat

Untuk koreksi kecil setelah pengiriman, mitra dapat menggunakan tindakan AmendBenefitApplication API untuk memperbarui bidang tertentu tanpa mengingat seluruh aplikasi. Ini sangat berguna ketika AWS pengulas meminta klarifikasi atau koreksi selama proses peninjauan.

Amandemen menggunakan Patch-style pendekatan JSON di mana mitra menentukan:

  • Path - Ekspresi JsonPath mengidentifikasi bidang untuk memperbarui (misalnya,) $.CreditDisbursementDetails.AwsAccountIdForCredits

  • Nilai - Nilai baru untuk bidang

  • Operasi - Operasi untuk melakukan (saat REPLACE ini hanya didukung)

Mitra dapat mengirimkan hingga 10 amandemen dalam satu panggilan API. Setiap amandemen harus menyertakan nomor revisi yang diperbarui untuk penguncian optimis.

Amandemen harus digunakan untuk koreksi kecil. Untuk perubahan besar, mitra harus menggunakan RecallBenefitApplication untuk mengembalikan aplikasi ke status draf untuk pembaruan komprehensif.

Membatalkan Aplikasi Manfaat

Jika mitra tidak lagi membutuhkan manfaat atau ingin menarik aplikasi mereka, mereka dapat membatalkannya menggunakan tindakan CancelBenefitApplication API. Pembatalan mentransisikan aplikasi ke CANCELED status, mengakhiri proses aplikasi secara permanen.

Saat membatalkan aplikasi, mitra harus menyediakan:

  • Identifier - ID atau ARN dari aplikasi manfaat untuk dibatalkan

  • Alasan - Penjelasan opsional untuk pembatalan (maksimum 1000 karakter)

Setelah dibatalkan, aplikasi tidak dapat diaktifkan kembali. Jika pasangan kemudian memutuskan mereka membutuhkan manfaat, mereka harus membuat aplikasi manfaat baru.

Alasan umum untuk pembatalan meliputi:

  • Peluang pelanggan hilang atau tertunda

  • Kendala kapasitas mitra berubah

  • Prioritas bisnis bergeser

  • Manfaat tidak lagi diperlukan untuk tujuan yang dimaksudkan

Melihat Detail Aplikasi Manfaat

Mitra dapat mengambil informasi lengkap tentang aplikasi manfaat menggunakan tindakan GetBenefitApplication API. Ini memberikan pandangan komprehensif dari aplikasi termasuk:

Metadata Aplikasi:

  • Pengenal unik (ID) dan Nama Sumber Daya Amazon (ARN)

  • Pengidentifikasi manfaat terkait

  • Nama dan deskripsi aplikasi

  • Status saat ini (PENDING_SUBMISSION,IN_REVIEW,ACTION_REQUIRED,APPROVED,REJECTED, atauCANCELED)

  • Tahap pemrosesan saat ini

Informasi Status:

  • Alasan Status - Human-readable penjelasan status saat ini

  • Kode Alasan Status - Kode terstruktur yang menunjukkan masalah atau persyaratan tertentu (mis., “Daftar Periksa Tidak Lengkap”, “Rencana Proyek Hilang”, “Desain Menang Hilang”)

Konten Aplikasi:

  • Detail aplikasi manfaat lengkap dokumen JSON

  • Informasi kontak mitra

  • Lampiran file dengan status pemrosesan

  • Sumber daya terkait (peluang atau alokasi)

  • Tag sumber daya

Informasi Audit:

  • Stempel waktu pembuatan

  • Stempel waktu modifikasi terakhir

  • Nomor revisi saat ini

Kode alasan status sangat berharga ketika aplikasi dalam ACTION_REQUIRED status. Kode-kode ini memberikan panduan spesifik dan dapat ditindaklanjuti tentang apa yang perlu ditangani oleh mitra agar aplikasi dapat dilanjutkan.

Daftar Aplikasi Manfaat

Mitra dapat melihat semua aplikasi manfaat mereka menggunakan tindakan ListBenefitApplications API. Ini mengembalikan daftar ringkasan aplikasi paginasi dengan kemampuan penyaringan yang kuat.

Mitra dapat memfilter aplikasi dengan:

  • Program - Lihat aplikasi untuk program tertentu (MAP, MDF, Sandbox, POC, dll.)

  • Jenis Pemenuhan - Filter dengan metode pengiriman (CREDITS,CASH,ACCESS, dll.)

  • Benefit Identifier - Lihat aplikasi untuk manfaat tertentu

  • Status - Filter berdasarkan status aplikasi (PENDING_SUBMISSION,IN_REVIEW,APPROVED,REJECTED,CANCELED)

  • Tahap - Filter berdasarkan tahap persetujuan (Persetujuan Bisnis, Persetujuan Teknologi, Persetujuan Keuangan)

  • ARN Sumber Daya Terkait - Temukan aplikasi yang terkait dengan peluang atau alokasi tertentu

Tanggapan daftar mencakup informasi ringkasan penting seperti:

  • ID Aplikasi, ARN, dan nama

  • ID manfaat terkait

  • Program dan jenis pemenuhan

  • Status dan panggung saat ini

  • Cap waktu pembuatan dan modifikasi

  • Sumber daya terkait

  • Nomor revisi saat ini

  • Bidang yang dipilih dari detail aplikasi manfaat (sebagaimana didefinisikan oleh pemilik manfaat)

Mitra dapat mengonfigurasi pengurutan hasil menggunakan parameter Urutkan, dengan opsi untuk mengurutkan berdasarkan tanggal pembuatan, status, program, atau pengenal manfaat dalam urutan naik atau turun.

Dashboard Building: ListBenefitApplications API dirancang untuk mendukung pembuatan dasbor mitra. Dengan memfilter dan menyortir aplikasi, mitra dapat membangun tampilan seperti:

  • Aplikasi yang membutuhkan tindakan (ACTION_REQUIREDstatus)

  • Aplikasi yang baru saja dikirimkan (diurutkan berdasarkan tanggal pembuatan, IN_REVIEW status)

  • Aplikasi yang disetujui menunggu alokasi (APPROVEDstatus)

  • Aplikasi berdasarkan program (disaring oleh program tertentu)