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

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

Pengaturan dan otentikasi

Menyiapkan dan mengautentikasi dengan API Pusat AWS Mitra melibatkan tiga langkah. Berikut ikhtisar prosesnya:

Menghubungkan Anda Akun AWS ke Partner Central

Menautkan Anda Akun AWS ke Partner Central adalah prasyarat untuk menggunakan API. Untuk informasi selengkapnya, lihat Menautkan akun Pusat AWS Mitra dengan akun AWS Marketplace penjual. Anda harus masuk ke Partner Central dengan akun yang memiliki izin alliance-lead atau cloud-administrator, navigasikan ke bagian tersebutAccount Linking, dan ikuti petunjuknya.

Mengatur IAM

Untuk menggunakan API Pusat AWS Mitra, Anda memerlukan peran AWS Identity and Access Management(IAM) atau pengguna IAM untuk mulai melakukan panggilan. Untuk informasi selengkapnya, lihat Kapan saya menggunakan IAM? . Ikuti langkah-langkah untuk Membuat peran IAM dan Membuat pengguna IAM di Akun AWS panduan Anda untuk ini. Anda harus membuat IAM ini Role/User di akun Central-linked AWS Marketplace Penjual Mitra Anda. role/user Pembuatan IAM tidak menimbulkan biaya apa pun.

Mengelola AWS Marketplace penawaran

Untuk mengelola AWS Marketplace penawaran dan menautkannya ke peluang, mitra harus memberikan izin peran IAM untuk mengakses API Katalog. Pastikan role/user memiliki izin, seperti aws-marketplace:ListEntities danaws-marketplace:SearchAgreements.

Mengautentikasi panggilan API

AWS Partner Central API menggunakan Signature Version 4 (SiGv4) untuk otentikasi. Berikut cara mengimplementasikannya:

Menggunakan AWS SDK

AWS SDK secara otomatis menangani penandatanganan permintaan. Berikan AWS kredensyal Anda, dan SDK melakukan sisanya.

Otentikasi tanpa menggunakan AWS SDK

Jika AWS SDK tidak tersedia untuk bahasa pemrograman pilihan Anda, otentikasi melibatkan pembuatan permintaan kanonik secara manual, menandatangani permintaan, dan menangani token sesi.AWS menawarkan panduan komprehensif untuk menggunakan penandatanganan SiGv4. Namun, harap dicatat bahwa menggunakan AWS SDK direkomendasikan karena penandatanganan permintaan manual meningkatkan kompleksitas dan memerlukan pengelolaan token keamanan yang cermat.

Setiap permintaan untuk protokol AWSJson1_0 HARUS dikirim ke URL root (/) menggunakan metode HTTP “POST” menggunakan header berikut.

Header yang Diperlukan

Setiap permintaan API untuk protokol AWSJson1_0 HARUS dikirim ke URL root (/) menggunakan metode HTTP “POST” menggunakan header berikut.

Menandatangani panggilan Anda dengan agen pengguna khusus

Saat membuat permintaan API ke AWS Partner Central, sebaiknya X-Amzn-User-Agent sertakan header untuk membantu AWS mengidentifikasi sumber aplikasi klien, memantau penggunaan, dan kinerja audit.AWS menggunakan header ini untuk membedakan jenis aplikasi klien yang melakukan panggilan dan untuk mengumpulkan wawasan tentang tingkat keberhasilan implementasi klien yang berbeda.

Header user-agent kustom

Nama header: X-Amzn-User-Agent

Tujuan: Membedakan jenis klien yang membuat permintaan API, mengkategorikan sumber interaksi.

Format: {Integrator}|{Product}

Nilai Contoh: AWS|AWS Partner CRM Connector

Menyertakan header ini di setiap permintaan memungkinkan AWS untuk menganalisis pola permintaan, melacak integrasi, dan meningkatkan pengalaman API untuk sistem klien yang berbeda.

Menggunakan header khusus di SDK

Untuk menyertakan X-Amzn-User-Agent header dalam panggilan SDK, Anda dapat mengubah perilaku permintaan klien sebelum melakukan panggilan API. Di bawah ini adalah contoh API penjualan menggunakan AWS SDK for Python (Boto3):

import boto3

# Define service and endpoint details
service_name = "partnercentral-selling"
endpoint_url = "https://partnercentral-selling.us-east-1.api.aws"

# Create a boto3 client for Partner Central
partner_central_client = boto3.client(
service_name=service_name,
='us-east-1',
endpoint_url=endpoint_url
)

# Function to add the custom User-Agent header

def add_version_header(params, **kwargs):
params["headers"]['X-Amzn-User-Agent'] = 'AWS|AWS Partner CRM Connector'

# Register the event to modify the request before the call is made
partner_central_client.meta.events.register(
f'before-call.{service_name}.*', add_version_header
)

# Now, whenever an API call is made using this client, the custom User-Agent header will be included

Contoh ini menunjukkan cara mendaftarkan peristiwa di Boto3 SDK untuk menambahkan X-Amzn-User-Agent header secara otomatis ke setiap permintaan API. Pendekatan yang sama dapat diterapkan pada AWS SDK lain dengan memodifikasi mekanisme intersepsi permintaan masing-masing.