A referência Central de Parceiros da AWS da API foi reestruturada. Para obter mais informações sobre as operações de API suportadas, consulte a Referência Central de Parceiros da AWS da API.

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

Configuração e autenticação

A configuração e a autenticação com a API do AWS Partner Central envolvem três etapas. Aqui está uma visão geral do processo:

Vinculando seu Conta da AWS para a Central de Parceiros

Vincular você Conta da AWS ao Partner Central é um pré-requisito para usar a API. Para obter mais informações, consulte Vinculando contas do AWS Partner Central às contas AWS Marketplace do vendedor. Você deve entrar no Partner Central com uma conta que tenha permissões de líder de aliança ou administrador de nuvem, navegar até a Account Linking seção e seguir as instruções.

Configurar o IAM

Para usar a API do AWS Partner Central, você precisará de uma função AWS Identity and Access Management (IAM) ou de um usuário do IAM para começar a fazer chamadas. Para obter mais informações, consulte Quando eu uso o IAM? . Siga as etapas para criar funções do IAM e Criar um usuário do IAM em seus Conta da AWS guias para isso. Você deve criar esse IAM Role/User em sua conta de Central-linked AWS Marketplace vendedor parceiro. A role/user criação do IAM não gera nenhum custo.

Gerenciamento AWS Marketplace ofertas

Para gerenciar AWS Marketplace ofertas e vinculá-las a oportunidades, os parceiros devem dar permissão à função do IAM para acessar as APIs do catálogo. Verifique role/user se o tem permissões, como aws-marketplace:ListEntities aws-marketplace:SearchAgreements e.

Autenticação de chamadas de API

AWS A API do Partner Central usa o Signature Version 4 (SigV4) para autenticação. Veja como implementá-lo:

Usar o AWS SDK

AWS Os SDKs gerenciam automaticamente a assinatura de solicitações. Forneça suas AWS credenciais e o SDK fará o resto.

Autenticação sem usar o AWS SDK

Se um AWS SDK não estiver disponível para a linguagem de programação escolhida, a autenticação envolve a criação manual de uma solicitação canônica, a assinatura da solicitação e o tratamento dos tokens da sessão. AWS oferece orientação abrangente para o uso da assinatura SigV4. No entanto, observe que o uso do AWS SDK é recomendado, pois a assinatura manual de solicitações aumenta a complexidade e exige um gerenciamento cuidadoso dos tokens de segurança.

Cada solicitação para o protocolo AWSJson1_0 DEVE ser enviada para a URL raiz (/) usando o método HTTP “POST” usando os cabeçalhos a seguir.

Cabeçalhos obrigatórios

Cada solicitação de API para o protocolo AWSJson1_0 DEVE ser enviada para a URL raiz (/) usando o método HTTP “POST” usando os cabeçalhos a seguir.

Assinando suas chamadas com um agente de usuário personalizado

Ao fazer solicitações de API para o AWS Partner Central, recomendamos incluir o X-Amzn-User-Agent cabeçalho para ajudar a AWS identificar a origem do aplicativo cliente, monitorar o uso e auditar o desempenho. AWS usa esse cabeçalho para distinguir o tipo de aplicativo cliente que está fazendo a chamada e para obter informações sobre a taxa de sucesso de diferentes implementações do cliente.

Cabeçalho personalizado do agente de usuário

Nome do cabeçalho: X-Amzn-User-Agent

Objetivo: distingue o tipo de cliente que faz a solicitação da API, categorizando a fonte da interação.

Formato: {Integrator}|{Product}

Exemplo de valor: AWS|AWS Partner CRM Connector

Incluir esse cabeçalho em cada solicitação AWS permite analisar padrões de solicitação, rastrear integrações e melhorar a experiência da API para diferentes sistemas de clientes.

Usando cabeçalhos personalizados em SDKs

Para incluir o X-Amzn-User-Agent cabeçalho nas chamadas do SDK, você pode modificar o comportamento da solicitação do cliente antes de fazer a chamada de API. Abaixo está um exemplo de API de venda usando o AWS SDK para Python (Boto3):

# Requires the 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,
region_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

Este exemplo demonstra como registrar um evento no SDK do Boto3 para anexar automaticamente o X-Amzn-User-Agent cabeçalho a cada solicitação de API. A mesma abordagem pode ser aplicada a outros AWS SDKs modificando seus respectivos mecanismos de interceptação de solicitações.