Se reestructuró la referencia de la Centro de socios de AWS API. Para obtener más información sobre las operaciones de API compatibles, consulta la referencia de la Centro de socios de AWS API.
Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.
Configuración y autenticación
La configuración y la autenticación con la API de AWS Partner Central constan de tres pasos. A continuación, se ofrece un resumen del proceso:
-
Vincula tu cuenta de AWS Marketplace vendedor a Partner Central.
-
Configura los permisos mediante IAM.
-
Autentica tus llamadas a la API con la versión 4 de Signature (SiGv4).
Vinculando tu Cuenta de AWS a Partner Central
La vinculación Cuenta de AWS a Partner Central es un requisito previo para utilizar la API. Para obtener más información, consulte Cómo vincular las cuentas de AWS Partner Central con las cuentas de AWS Marketplace vendedor. Debe iniciar sesión en Partner Central con una cuenta que tenga permisos de administrador en la nube o de líder de una alianza, ir a la Account Linking sección y seguir las instrucciones.
Configuración de IAM
Para utilizar la API de AWS Partner Central, necesitará un rol AWS Identity and Access Management(de IAM) o un usuario de IAM para empezar a realizar llamadas. Para obtener más información, consulte ¿Cuándo uso IAM? . Para ello, siga los pasos para crear funciones de IAM y Crear un usuario de IAM que aparecen en sus Cuenta de AWS guías. Debes crear este IAM Role/User en tu cuenta de vendedor asociado Central-linked AWS Marketplace. La role/user creación del IAM no conlleva ningún coste.
-
Cree un IAM Role/User
Inicie sesión en Consola de administración de AWS, navegue hasta el servicio de IAM y siga los pasos para crear un rol de IAM o un usuario de IAM.
-
Asigne políticas:
Adjunte políticas administradas o cree políticas personalizadas según sea necesario. Para modificar o ampliar los permisos, aplique políticas adicionales a la función de IAM en lugar de copiar y combinar el contenido
AWSPartnerCentralOpportunityManagementcon otros permisos. Evite duplicar las políticas administradas, ya que al hacerlo evitará que obtenga acceso automático a las nuevas funciones a medida que se publiquen y tendrá que actualizar las políticas manualmente en el futuro. Para obtener más información sobre las políticas de acceso, consulta la documentación de control de acceso.
Administración AWS Marketplace ofertas
Para gestionar las AWS Marketplace ofertas y vincularlas a las oportunidades, los socios deben conceder permiso al rol de IAM para acceder a las API del catálogo. Asegúrese de role/user que tiene permisos, como aws-marketplace:ListEntities yaws-marketplace:SearchAgreements.
Autenticar las llamadas a la API
AWS La API de Partner Central utiliza la versión 4 de Signature (SigV4) para la autenticación. A continuación, le indicamos cómo implementarlo:
Uso de AWS SDK
AWS Los SDK gestionan automáticamente la firma de las solicitudes. Proporcione sus AWS credenciales y el SDK se encargará del resto.
-
Para Java, consulta Proporcionar credenciales temporales al AWS SDK for Java.
-
Para JavaScript (Node.js), consulte Configurar credenciales en. Node.js
-
Para .NET, consulte Resolución de credenciales y perfiles.
-
Para ver otros lenguajes de programación y más ejemplos, consulta las herramientas sobre AWS las que construir
.
Autenticación sin usar el AWS SDK
Si no hay un AWS SDK disponible para el lenguaje de programación elegido, la autenticación implica crear manualmente una solicitud canónica, firmar la solicitud y gestionar los tokens de sesión.AWS ofrece una guía completa sobre el uso de la firma SiGv4. Sin embargo, ten en cuenta que se recomienda usar el AWS SDK, ya que la firma manual de las solicitudes aumenta la complejidad y requiere una gestión cuidadosa de los tokens de seguridad.
Todas las solicitudes del protocolo AWSJSON1_0 DEBEN enviarse a la URL raíz (/) mediante el método HTTP «POST» con los siguientes encabezados.
Encabezados obligatorios
Todas las solicitudes de API para el protocolo AWSJSON1_0 DEBEN enviarse a la URL raíz (/) mediante el método HTTP «POST» con los siguientes encabezados.
| Encabezado | Obligatorio | Description (Descripción) |
|---|---|---|
| Content-Type | true | Este encabezado tiene un valor estático de. application/x-amz-json-1.0 |
| Content-Length | true | El Content-Length encabezado estándar definido por el RFC 9110 #section -8.6 |
| X-Amz-Target | verdadero para las solicitudes | Por ejemplo, el valor del funcionamiento CreatePartner del servicio PartnerCentralAccount esPartnerCentralAccount.CreatePartner. |
Firmar las llamadas con un agente de usuario personalizado
Al realizar solicitudes de API a AWS Partner Central, recomendamos incluir el X-Amzn-User-Agent encabezado para ayudar a AWS identificar el origen de la aplicación cliente, supervisar el uso y auditar el rendimiento.AWS utiliza este encabezado para distinguir el tipo de aplicación cliente que realiza la llamada y para recopilar información sobre la tasa de éxito de las distintas implementaciones de clientes.
Encabezado de agente de usuario personalizado
Nombre del encabezado: X-Amzn-User-Agent
Propósito: distingue el tipo de cliente que realiza la solicitud de API y clasifica la fuente de la interacción.
Formato: {Integrator}|{Product}
Valor de ejemplo: AWS|AWS Partner CRM Connector
La inclusión de este encabezado en cada solicitud permite AWS analizar los patrones de las solicitudes, realizar un seguimiento de las integraciones y mejorar la experiencia de la API para los diferentes sistemas de clientes.
Usar encabezados personalizados en los SDK
Para incluir el X-Amzn-User-Agent encabezado en las llamadas al SDK, puedes modificar el comportamiento de las solicitudes del cliente antes de realizar la llamada a la API. A continuación se muestra un ejemplo de API de venta que utiliza el AWS SDK para 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
En este ejemplo, se muestra cómo registrar un evento en el SDK de Boto3 para añadir automáticamente el X-Amzn-User-Agent encabezado a cada solicitud de API. El mismo enfoque se puede aplicar a otros AWS SDK modificando sus respectivos mecanismos de interceptación de solicitudes.
nota
Se ha simplificado el formato X-Amzn-User-Agent del encabezado. Se recomienda utilizar el nuevo formato. El formato anterior (CompanyName|ProductName|CRMName|ProductVersion) sigue siendo compatible con versiones anteriores. Las integraciones existentes seguirán funcionando sin modificaciones.