Referensi AWS Partner Central API direstrukturisasi. Untuk informasi selengkapnya tentang operasi API yang didukung, lihat Referensi AWS Partner Central API.
Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.
Pemberitahuan untuk AWS API Penjualan Sentral Mitra
Acara untuk API penjualan memberikan pemberitahuan real-time tentang perubahan status atau detail peluang. Acara ini membantu menjaga sistem Anda tetap sinkron dengan AWS Partner Central, dan membantu memastikan respons dan pembaruan tepat waktu.
Topik
Lengkapi prasyarat untuk memantau acara
Pengguna memerlukan izin IAM yang sesuai untuk mengakses dan mengelola acara yang diterbitkan oleh API penjualan Partner Central. Untuk informasi selengkapnya tentang tindakan, sumber daya, dan kunci kondisi yang tersedia EventBridge, lihat Menggunakan kondisi kebijakan IAM di Amazon EventBridge di Panduan EventBridge Pengguna Amazon. Salah satu kunci kondisi adalahevents:detail-type, yang dapat digunakan untuk cakupan izin untuk jenis peristiwa tertentu.
Contoh kebijakan berikut menunjukkan cara menyesuaikan dan cakupan izin untuk acara yang diusulkan. AllowPutRuleForPartnercentralSellingEventsPernyataan tersebut memungkinkan pembuatan aturan, tetapi hanya untuk acara dari aws.partnercentral-selling sumbernya.
Konfigurasikan Amazon EventBridge untuk memantau peristiwa
Untuk memantau penjualan peristiwa API, Anda membuat EventBridge aturan yang cocok dengan peristiwa yang ingin Anda tangkap. Anda dapat menggunakan Konsol Manajemen AWS atau AWS SDK untuk membuat dan mengelola aturan. Bagian berikut menjelaskan cara membuat aturan menggunakan kedua metode. Terlepas dari metode yang Anda gunakan, Anda harus membuat aturan di us-east-1 Wilayah AS Timur (Virginia N.).
Konsol Manajemen AWS mempersiapkan
Untuk menyiapkan EventBridge aturan menggunakan Konsol Manajemen AWS, ikuti langkah-langkah dalam Membuat aturan yang bereaksi terhadap peristiwa di Amazon EventBridge di Panduan EventBridge Pengguna Amazon. Saat membuat aturan, Anda harus mengatur bus acara ke default, dan membuat aturan di us-east-1 Wilayah AS Timur (Virginia N.).
Berikut ini adalah contoh aturan acara:
{ "source": ["aws.partnercentral-selling"], "detail": { "catalog": ["AWS"] } }
AWS Pengaturan SDK
Anda dapat menggunakan AWS SDK untuk membuat dan mengelola EventBridge aturan secara terprogram. Untuk informasi selengkapnya, lihat PutRuledi Referensi Amazon EventBridge API.
Contoh berikut menggunakan AWS SDK for Python (Boto3):
import boto3 client = boto3.client('events', region_name='us-east-1') response = client.put_rule( Name='MyOpportunityCreatedRule', EventPattern= '{ "source": ["aws.partnercentral-selling"], "detail-type": ["Opportunity Created"], "detail": {"catalog": ["AWS"]} }', State='ENABLED' ) print('Rule ARN:', response['RuleArn'])
Pelajari selengkapnya tentang menjual event API
Bagian berikut menjelaskan jenis peristiwa API penjualan, skenario yang memicunya, dan contoh peristiwa.
Tipe peristiwa
Berikut ini adalah jenis acara dan pemicunya.
-
Peluang Dibuat: Dipicu ketika peluang baru dibuat.
-
Peluang Diperbarui: Dipicu ketika peluang (Peluang atau Ringkasan AWS Peluang yang sesuai) diperbarui.
-
Undangan Keterlibatan Dibuat: Dipicu saat undangan AWS Referral dibuat.
-
Undangan Keterlibatan Diterima: Dipicu ketika mitra menerima AWS Undangan Keterlibatan, menegaskan minat mereka untuk berkolaborasi dengan AWS kesempatan tersebut.
-
Undangan Keterlibatan Ditolak: Dipicu ketika pasangan menolak AWS Undangan Keterlibatan.
-
Undangan Keterlibatan Kedaluwarsa: Acara ini dipicu ketika Mitra menolak. EngagementInvitation Ini memberi tahu mitra pengirim dan penerima bahwa undangan telah kedaluwarsa.
-
Anggota Keterlibatan Ditambahkan: Acara ini dipicu ketika anggota baru bergabung dengan Keterlibatan setelah menerima undangan. Ini memberi tahu semua anggota Keterlibatan saat ini tentang anggota baru yang ditambahkan ke Keterlibatan.
-
Snapshot Sumber Daya Keterlibatan Dibuat: Peristiwa ini dipicu saat revisi baru Snapshot sumber daya (seperti peluang) yang terkait dengan Keterlibatan dibuat. Ini memberi tahu semua anggota Keterlibatan saat ini tentang perubahan pada Snapshot sumber daya terkait.
-
Keterlibatan Dibuat: Dipicu saat keterlibatan baru dibuat.
-
Keterlibatan Diperbarui: Dipicu saat keterlibatan diperbarui.
Skenario acara
Tabel berikut menjelaskan bagaimana peristiwa beroperasi di bawah skenario yang berbeda. Asumsi berikut dibuat untuk skenario ini:
-
AWS juga merupakan mitra dalam skenario ini.
-
ResourceSnapshotJobdikonfigurasi dengan benar oleh mitra. -
Bidang yang diperbarui pada peluang juga ada di template peluang untuk Resource Snapshot.
| Tindakan oleh Anda sebagai mitra | Acara yang diterima | Jenis peserta |
|---|---|---|
| Anda menciptakan peluang | Peluang Diciptakan | |
Anda gunakan StartEngagementFromOpportunityTask untuk mengirimkan kesempatan |
Peluang Diperbarui, Keterlibatan Dibuat, Snapshot Sumber Daya Keterlibatan Dibuat, Anggota Keterlibatan Ditambahkan, Undangan Keterlibatan Dibuat | |
| AWS menyetujui kesempatan yang Anda kirimkan | Undangan Keterlibatan Diterima, Anggota Keterlibatan Ditambahkan, Peluang Diperbarui, Snapshot Sumber Daya Keterlibatan Dibuat | |
| AWS menolak kesempatan yang Anda kirimkan | Undangan Keterlibatan Ditolak, Peluang Diperbarui, Snapshot Sumber Daya Keterlibatan Dibuat | |
| Anda mengaitkan AWS Marketplace penawaran dengan peluang | Kesempatan Diperbarui | |
| Anda mengasosiasikan solusi dengan peluang | Peluang Diperbarui, Snapshot Sumber Daya Keterlibatan Dibuat | |
| Anda memperbarui peluang | Peluang Diperbarui, Snapshot Sumber Daya Keterlibatan Dibuat (Opsional jika ResourceSnapshotJob diatur dan pembaruan bidang ada di template) |
|
| AWS memperbarui kesempatan Anda | Peluang Diperbarui, Snapshot Sumber Daya Keterlibatan Dibuat | |
| Anda mengundang pasangan lain ke pertunangan | Undangan Keterlibatan Dibuat | Sender |
| Undangan Anda untuk bergabung dengan pertunangan diterima oleh mitra | Undangan Keterlibatan Diterima, Anggota Keterlibatan Ditambahkan | Sender |
| Undangan Anda untuk bergabung dengan pertunangan ditolak oleh pasangan | Undangan Pertunangan Ditolak | Sender |
| Undangan Anda untuk bergabung dengan pertunangan tidak ditindaklanjuti oleh mitra selama 15 hari | Undangan Keterlibatan Kedaluwarsa | Sender |
| Anda menerima undangan dari mitra lain untuk bergabung dengan pertunangan | Undangan Keterlibatan Dibuat | Penerima |
Anda menerima undangan dari mitra lain untuk bergabung dengan pertunangan melalui StartEngagementByAcceptingInvitationTask |
Undangan Keterlibatan Diterima, Anggota Keterlibatan Ditambahkan, Peluang Dibuat, Peluang Diperbarui, Snapshot Sumber Daya Keterlibatan Dibuat | Penerima |
| Anda menolak undangan untuk bergabung dengan pertunangan dari mitra lain | Undangan Pertunangan Ditolak | Penerima |
| Anda tidak bertindak atas undangan untuk bergabung dengan pertunangan dari mitra lain selama 15 hari | Undangan Keterlibatan Kedaluwarsa | Penerima |
| Anda membuat keterlibatan | Keterlibatan Dibuat | Sender |
| Anda memperbarui pertunangan | Keterlibatan Diperbarui | Pengirim, Penerima |
Contoh peristiwa
Bagian berikut memberikan contoh peristiwa yang tercantum sebelumnya di bagian sebelumnya.
Topik
Peluang Diciptakan
Mitra menggunakan acara ini untuk:
-
Beri tahu pengguna mereka bahwa Peluang baru telah dibuat.
-
Memicu alur kerja otomatis seperti memperbarui sistem CRM atau memberi tahu tim penjualan tentang kreasi peluang baru.
Contoh berikut menunjukkan acara khas yang Dibuat Peluang.
{ "version": "1", "id": "01234567-0123-0123-0123-0123456789ab", "source": "aws.partnercentral-selling", "detail-type": "Opportunity Created", "time": "2023-04-16T15:23:45Z", "region": "us-east-1", "account": "123456789012", "detail": { "schemaVersion": "<version number>", "catalog": "<Sandbox | AWS>", "opportunity": { "identifier": "String" } } }
Kesempatan Diperbarui
Mitra menggunakan acara ini untuk:
-
Beri tahu pengguna mereka bahwa Peluang yang ada telah diperbarui.
-
Memicu alur kerja otomatis seperti memperbarui sistem CRM atau memberi tahu tim penjualan.
Contoh berikut menunjukkan acara Opportunity Updated yang khas.
{ "version": "1", "id": "01234567-0123-0123-0123-0123456789ab", "source": "aws.partnercentral-selling", "detail-type": "Opportunity Updated", "time": "2023-04-16T15:23:45Z", "region": "us-east-1", "account": "123456789012", "detail": { "schemaVersion": "<version number>", "catalog": "<Sandbox | AWS>", "opportunity": { "identifier": "String" } } }
Undangan Keterlibatan Dibuat
Mitra menggunakan acara ini untuk:
-
Beri tahu pengguna mereka tentang hal baru yang telah EngagementInvitation mereka terima.
-
Memicu alur kerja otomatis untuk menerima atau menolak undangan, seperti memperbarui sistem CRM atau memberi tahu tim penjualan.
Contoh berikut menunjukkan acara khas Undangan Keterlibatan Dibuat.
{ "version": "0", "id": "01234567-0123-0123-0123-0123456789ab", "detail-type": "Engagement Invitation Created", "source": "aws.partnercentral-selling", "account": "123456789012", "time": "2023-04-15T12:34:56Z", "region": "us-east-1", "resources": [ "arn:aws:partnercentral:us-east-1::catalog/AWS/engagement-invitation/engi-v7p8z56whnauo" ], "detail": { "catalog": "AWS", "engagementInvitation": { "arn": "arn:aws:partnercentral:us-east-1::catalog/AWS/engagement-invitation/engi-v7p8z56whnauo", "id": "engi-v7p8z56whnauo", "engagementId": "eng-12345678901234", "senderAccountId": "string", "receiverAccountId": "string", "senderCompanyName": "string", "expirationDate": "string", "participantType": "Enum", //Sender/Receiver "payloadType": "LeadInvitation" //OpportunityInvitation|LeadInvitation } } }
Undangan Keterlibatan Diterima
Mitra menggunakan acara ini untuk:
-
Beri tahu pengguna mereka bahwa EngagementInvitation telah diterima.
-
Perbarui catatan internal mereka untuk mencerminkan mitra baru dalam Keterlibatan.
-
Picu alur kerja otomatis untuk menyinkronkan data atau memberi tahu anggota tim lain tentang anggota Keterlibatan baru.
Contoh berikut menunjukkan acara khas Undangan Keterlibatan Diterima.
{ "version": "0", "id": "01234567-0123-0123-0123-0123456789ab", "detail-type": "Engagement Invitation Accepted", "source": "aws.partnercentral-selling", "account": "123456789012", "time": "2023-04-16T15:23:45Z", "region": "us-east-1", "resources": ["arn:aws:partnercentral:us-east-1::catalog/AWS/engagement-invitation/engi-v7p8z56whnauo"], "detail": { "catalog": "AWS", "engagementInvitation": { "arn": "arn:aws:partnercentral:us-east-1::catalog/AWS/engagement-invitation/engi-v7p8z56whnauo", "id": "engi-v7p8z56whnauo", "engagementId": "eng-12356whnauo", "participantType": "Enum", //Sender/Receiver "senderAccountId": "string", "receiverAccountId": "string", "payloadType": "LeadInvitation" //OpportunityInvitation|LeadInvitation } } }
Undangan Pertunangan Ditolak
Mitra menggunakan acara ini untuk:
-
Beri tahu pengguna mereka bahwa EngagementInvitation telah ditolak.
-
Perbarui catatan internal mereka untuk mencerminkan undangan yang ditolak.
-
Picu alur kerja yang diperlukan, seperti memberi tahu tim penjualan tentang penolakan.
Contoh berikut menunjukkan acara khas Undangan Keterlibatan Ditolak.
{ "version": "0", "id": "01234567-0123-0123-0123-0123456789ab", "detail-type": "Engagement Invitation Rejected", "source": "aws.partnercentral-selling", "account": "123456789012", "time": "2023-04-17T09:48:27Z", "region": "us-east-1", "resources": ["arn:aws:partnercentral:us-east-1::catalog/AWS/engagement-invitation/engi-v7p8z56whnauo"], "detail": { "catalog": "AWS", "engagementInvitation": { "arn": "arn:aws:partnercentral:us-east-1::catalog/AWS/engagement-invitation/engi-v7p8z56whnauo", "id": "engi-v7p8z56whnauo", "engagementId": "eng-12356whnauo", "participantType": "Enum", //Sender/Receiver "senderAccountId": "string", "receiverAccountId": "string", "payloadType": "LeadInvitation" //OpportunityInvitation|LeadInvitation } } }
Undangan Keterlibatan Kedaluwarsa
Mitra menggunakan acara ini untuk:
-
Beri tahu pengguna mereka bahwa EngagementInvitation telah kedaluwarsa dan tidak dapat lagi ditindaklanjuti.
-
Perbarui catatan internal mereka untuk mencerminkan undangan yang kedaluwarsa.
-
Picu alur kerja yang diperlukan, seperti memberi tahu tim penjualan tentang undangan yang kedaluwarsa.
Contoh berikut menunjukkan acara Kedaluwarsa Undangan Keterlibatan yang khas.
{ "version": "0", "id": "01234567-0123-0123-0123-0123456789ab", "detail-type": "Engagement Invitation Expired", "source": "aws.partnercentral-selling", "account": "123456789012", "time": "2023-04-18T18:20:15Z", "region": "us-east-1", "resources": [ "arn:aws:partnercentral:us-east-1::catalog/AWS/engagement-invitation/engi-v7p8z56whnauo" ], "detail": { "catalog" : "AWS", "engagementInvitation": { "arn": "arn:aws:partnercentral:us-east-1::catalog/AWS/engagement-invitation/engi-v7p8z56whnauo", "id": "engi-v7p8z56whnauo", "engagementId": "eng-12356whnauo", "participantType": "Enum", //Sender/Receiver "senderAccountId": "string", "receiverAccountId": "string", "payloadType": "LeadInvitation" //OpportunityInvitation|LeadInvitation } } }
Anggota Keterlibatan Ditambahkan
Mitra menggunakan acara ini untuk:
-
Beri tahu pengguna mereka tentang perubahan pada keanggotaan Keterlibatan.
-
Perbarui catatan internal mereka untuk mencerminkan anggota Keterlibatan baru.
-
Picu alur kerja apa pun yang diperlukan, seperti memberi tahu anggota tim tentang perubahan tersebut.
Contoh berikut menunjukkan acara Added Anggota Keterlibatan yang khas.
{ "version": "0", "id": "01234567-0123-0123-0123-0123456789ab", "detail-type": "Engagement Member Added", "source": "aws.partnercentral-selling", "account": "123456789012", "time": "2023-04-16T15:23:45Z", "region": "us-east-1", "resources": [ "arn:aws:partnercentral:us-east-1::catalog/AWS/engagement/eng-v7p8z56whnauo" ], "detail": { "catalog" : "AWS", "engagement": { "id": "eng-v7p8z56whnauo" }, "engagementMember": { "accountId": "string", "companyName": "string" } } }
Snapshot Sumber Daya Keterlibatan Dibuat
Mitra menggunakan acara ini untuk melacak perubahan pada sumber daya yang terkait dengan keterlibatan dan memicu alur kerja otomatis, seperti memperbarui sistem CRM atau memberi tahu tim penjualan. Template snapshot menentukan jenis pembaruan:
OpportunitySummaryView-
-
Beri tahu semua anggota tentang keterlibatan bahwa keterlibatan telah diperbarui.
-
AwsOpportunitySummaryFullView-
-
Lacak pembaruan yang dibuat secara khusus oleh AWS ke peluang dalam keterlibatan.
-
Pemberitahuan dan snapshot ini hanya dapat dilihat oleh pemilik peluang.
-
Termasuk pembaruan ukuran kesepakatan, yang tidak tersedia melalui
OpportunitySummaryViewtemplate.
-
Contoh berikut menunjukkan acara khas Engagement Resource Snapshot Created.
{ "version": "0", "id": "01234567-0123-0123-0123-0123456789ab", "detail-type": "Engagement Resource Snapshot Created", "source": "aws.partnercentral-selling", "account": "123456789012", "time": "2023-04-18T18:20:15Z", "region": "us-east-1", "resources": [ "arn:aws:partnercentral:us-east-1::catalog/AWS/engagement/eng-v7p8z56whnauo" ], "detail": { "catalog" : "AWS", "resourceSnapshot": { "arn": "arn:aws:partnercentral-selling:us-east-1::catalog/AWS/engagement/eng-v7p8z56whnauo/resource/Opportunity/o-12312/template/temp-name/snapshot/snapshot-19232", "engagementId": "eng-v7p8z56whnauo", "resourceType": "Opportunity", "resourceId" : "O123211231", "createdBy": "123123123123", "targetMemberAccounts": ["123123123123", "aws"], "resourceSnapshotTemplateName": "temp-name" } } }
Keterlibatan Dibuat
Mitra menggunakan acara ini untuk:
-
Beri tahu pengguna mereka bahwa Keterlibatan baru telah dibuat.
-
Memicu alur kerja otomatis seperti memperbarui sistem CRM atau memberi tahu tim penjualan tentang kreasi keterlibatan baru.
Contoh berikut menunjukkan event khas Engagement Created.
{ "version": "0", "id": "01234567-0123-0123-0123-0123456789ab", "detail-type": "Engagement Created", "source": "aws.partnercentral-selling", "account": "123456789012", "time": "2023-04-18T18:20:15Z", "region": "us-east-1", "resources": [ "arn:aws:partnercentral:us-east-1::catalog/AWS/engagement/eng-567a1j5hxp35lo" ], "detail": { "catalog": "AWS", "engagement": { "engagementArn": "arn:aws:partnercentral:us-east-1::catalog/AWS/engagement/eng-567a1j5hxp35lo", "engagementId": "eng-567a1j5hxp35lo", "CreatedAt": "2023-04-18T18:20:15Z", "CreatedBy": "aws", "ContextTypes": ["Lead"] } } }
Keterlibatan Diperbarui
Mitra menggunakan acara ini untuk:
-
Beri tahu pengguna mereka bahwa Keterlibatan yang ada telah diperbarui.
-
Memicu alur kerja otomatis seperti memperbarui sistem CRM atau memberi tahu tim penjualan.
Contoh berikut menunjukkan acara Engagement Updated yang khas.
{ "version": "0", "id": "01234567-0123-0123-0123-0123456789ab", "detail-type": "Engagement Updated", "source": "aws.partnercentral-selling", "account": "123456789012", "time": "2023-04-18T18:20:15Z", "region": "us-east-1", "resources": [ "arn:aws:partnercentral:us-east-1::catalog/AWS/engagement/eng-567a1j5hxp35lo" ], "detail": { "catalog": "AWS", "engagement": { "engagementArn": "arn:aws:partnercentral:us-east-1::catalog/AWS/engagement/eng-567a1j5hxp35lo", "engagementId": "eng-567a1j5hxp35lo", "LastModifiedAt": "2023-04-18T18:20:15Z", "LastModifiedBy": "aws", "ContextTypes": ["Lead", "CustomerProject"] } } }