La référence de AWS Partner Central l'API a été restructurée. Pour plus d'informations sur les opérations d'API prises en charge, consultez la référence des AWS Partner Central API.

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Notifications pour le AWS API de vente centralisée pour les partenaires

Les événements de l'API de vente fournissent des notifications en temps réel concernant les changements de statut ou les détails des opportunités. Ces événements permettent de synchroniser vos systèmes avec AWS Partner Central et de garantir des réponses et des mises à jour en temps opportun.

Remplissez les conditions préalables pour surveiller les événements

Les utilisateurs ont besoin des autorisations IAM appropriées pour accéder aux événements publiés par l'API de vente Partner Central et les gérer. Pour plus d'informations sur les actions, les ressources et les clés de condition disponibles pour EventBridge, consultez la section Utilisation des conditions de politique IAM dans Amazon EventBridge dans le guide de l' EventBridge utilisateur Amazon. L'une des clés de condition est la events:detail-type suivante : elle peut être utilisée pour étendre les autorisations à des types d'événements spécifiques.

L'exemple de politique suivant montre comment personnaliser et définir les autorisations pour les événements proposés. L'AllowPutRuleForPartnercentralSellingEventsinstruction permet de créer des règles, mais uniquement pour les événements provenant de la aws.partnercentral-selling source.

JSON

{
  "Version":"2012-10-17",
  "Statement": {
    "Sid": "AllowPutRuleForPartnercentralSellingEvents",
    "Effect": "Allow",
    "Action": "events:PutRule",
    "Resource": "*",
    "Condition": {
      "ForAllValues:StringEquals": {
        "events:source": "aws.partnercentral-selling"
      }
    }
  }
}

Configurer Amazon EventBridge pour surveiller les événements

Pour surveiller les événements de l'API de vente, vous créez une EventBridge règle qui correspond aux événements que vous souhaitez capturer. Vous pouvez utiliser le Console de gestion AWS ou les AWS SDK pour créer et gérer des règles. Les sections suivantes expliquent comment créer des règles à l'aide des deux méthodes. Quelle que soit la méthode que vous utilisez, vous devez créer la règle dans la us-east-1 région USA Est (Virginie du Nord).

Console de gestion AWS configuration

Pour configurer une EventBridge règle à l'aide de Console de gestion AWS, suivez les étapes décrites dans le Guide de l' EventBridge utilisateur Amazon EventBridge dans la section Création de règles réagissant aux événements survenus sur Amazon. Lors de la création de la règle, vous devez définir le bus d'événements par défaut et créer la règle dans la us-east-1 région USA Est (Virginie du Nord).

Voici un exemple de règle d'événement :

{
    "source": ["aws.partnercentral-selling"],
    "detail": {
        "catalog": ["AWS"]
    }
}

AWS Configuration du SDK

Vous pouvez utiliser les AWS kits SDK pour créer et gérer des EventBridge règles par programmation. Pour plus d'informations, consultez PutRule le manuel Amazon EventBridge API Reference.

L'exemple suivant utilise le AWS SDK pour 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'])

En savoir plus sur la vente d'événements liés à l'API

Les sections suivantes décrivent les types d'événements de l'API de vente, les scénarios qui les déclenchent et des exemples d'événements.

Types d’événements

Vous trouverez ci-dessous les types d'événements et leurs déclencheurs.

Scénarios d'événements

Le tableau suivant décrit le fonctionnement des événements selon différents scénarios. Les hypothèses suivantes sont formulées pour ces scénarios :

Exemples d’événements

Les sections suivantes fournissent des exemples des événements répertoriés plus haut dans la section précédente.

Opportunité créée

Les partenaires profitent de cet événement pour :

L'exemple suivant illustre un événement Opportunity Created typique.

{
    "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"
        }
    }
}

Opportunité actualisée

Les partenaires profitent de cet événement pour :

L'exemple suivant montre un événement Opportunity Updated typique.

{
    "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"
        }
    }
}

Invitation d'engagement créée

Les partenaires profitent de cet événement pour :

L'exemple suivant montre un événement typique de création d'une invitation d'engagement.

{
    "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
      }
    }
}

Invitation à l'engagement acceptée

Les partenaires profitent de cet événement pour :

L'exemple suivant montre un événement type d'invitation de fiançailles acceptée.

{
    "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
        }
    }
}

Invitation à l'engagement rejetée

Les partenaires profitent de cet événement pour :

L'exemple suivant montre un événement typique de rejet d'une invitation à un engagement.

{
    "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 
        } 
    }
}

Invitation d'engagement expirée

Les partenaires profitent de cet événement pour :

L'exemple suivant montre un événement typique d'expiration d'une invitation de fiançailles.

{
    "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
      }  
    }
}

Membre d'engagement ajouté

Les partenaires profitent de cet événement pour :

L'exemple suivant montre un événement typique d'Engagement Member Added.

{
    "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"
      }
    }
}

Instantané des ressources d'engagement créé

Les partenaires utilisent cet événement pour suivre les modifications apportées aux ressources associées à un engagement et déclencher des flux de travail automatisés, tels que la mise à jour des systèmes CRM ou la notification des équipes commerciales. Le modèle de capture d'écran détermine le type de mise à jour :

L'exemple suivant montre un événement typique de création d'un instantané des ressources d'engagement.

{
    "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"
      }
    }
}

Engagement créé

Les partenaires profitent de cet événement pour :

L'exemple suivant illustre un événement typique d'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"]
            
        }
    }
}

Engagement mis à jour

Les partenaires profitent de cet événement pour :

L'exemple suivant montre un événement Engagement Updated typique.

{
    "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"]
        }
    }
}