Créer une référence

Article
08/12/2024

Cet article explique comment créer une référence.

Prérequis

Informations d’identification, comme décrit dans l’authentification de l’API Références. Ce scénario prend en charge l’authentification avec les informations d’identification de l’application et de l’utilisateur.

Demande REST

Syntaxe de la requête

Method	URI de demande
POST	`https://api.partner.microsoft.com/v1.0/engagements/referrals`

En-têtes de requête

Pour plus d’informations, consultez En-têtes de l’API REST Partenaire.

Corps de la demande

Ce tableau décrit les propriétés de référence dans le corps de la demande pour une toute nouvelle référence.

Propriété	Type	Description
Nom	chaîne	Nom de la référence.
ExternalReferenceID	string	Identificateur externe de la référence. Par exemple, votre propre ID de prospect ou d’opportunité Dynamics 365.
État	ReferralStatus	Une énumération dont les valeurs indiquent le statut de la référence.
Sous-statut	ReferralSubstatus	Une énumération dont les valeurs indiquent le sous-statut de la référence.
StatusReason	string	Message descriptif du statut. Par exemple, expliquez pourquoi la référence a été perdue.
ReferralType	ReferralType	Représente le type de référence. Obligatoire.
Qualification	ReferralQualification	Représente la qualité de la référence.
CustomerProfile	CustomerProfile	Informations de contact du client. Obligatoire.
Consentement	Consentement	Indicateurs de consentement concernant le partage d’informations avec d’autres organisations et leur permettant de contacter les utilisateurs. .Obligatoire.
Détails	ReferralDetails	Détails du client, notes, valeur de la transaction, devise, date de clôture Obligatoire.
Team	Member	Représente les utilisateurs dans les organisations impliquées dans l’engagement des partenaires.
InviteContext	InviteContext	Représente plus d’informations qu’un utilisateur peut fournir lors de l’invitation d’une autre organisation dans l’engagement du partenaire.
Cible	ReferralTarget	Représente plus d’informations qu’un utilisateur peut fournir lors de l’invitation d’une autre organisation dans l’engagement du partenaire.
Rôle partenaire	PartnerRole	Obligatoire pour les références de co-vente des services uniquement
Domaine fonctionnel	SolutionArea	La zone Solution du client a besoin dans l’opportunité. Obligatoire pour les références de co-vente des services uniquement
Jeu de solutions	SolutionPlay	Le jeu de solutions du client a besoin dans l’opportunité. Obligatoire pour les références de co-vente des services uniquement

Exemple de requête

Important

Cet exemple de requête décrit comment créer une référence privée avec des informations minimales requises. Notez que le paramètre clé pour faire de cette référence une transaction privée est consentToShareReferralWithMicrosoftSellers.

POST https://api.partner.microsoft.com/v1.0/engagements/referrals HTTP/1.1
Authorization: Bearer <token>
Host: api.partner.microsoft.com
Content-Type: application/json

 {
	"name": "Contoso Test Deal - [Private]",
	"qualification": "SalesQualified",
	"type": "Independent",
	"customerProfile": {
		"name": "Contoso Customer Inc",
		"address": {
			"addressLine1": "One Microsoft Way",
			"addressLine2": "34",
			"city": "Redmond",
			"state": "WA",
			"postalCode": "98052",
			"country": "US"
		},
		"size": "10to50employees",
		"team": [
			{
				"firstName": "Sue",
				"lastName": "Smith",
				"phoneNumber": "1234567890",
				"email": "sue.smith@contosocustomer.com"
			}
		]
	},
	"consent": {
		"ConsentToToShareInfoWithOthers": true,
		"ConsentToContact": true,
		"ConsentToMicrosoftToContactSpecificPartners": true,
		"consentToShareReferralWithMicrosoftSellers": false
	},
	"details": {
		"notes": "Customer is looking to leverage Dynamics 365 to manage their supply chain. There's also a need to leverage a set of custom apps to enable their business processes.",
		"dealValue": 50000,
		"currency": "USD",
		"closingDateTime": "2024-11-14T00:00:00Z",
		"requirements": {
			"solutions": [
				{
					"type": "Name",
					"id": "SOL-15974-MQF",
					"name": "Contoso-Ale_Test",
					"publisherName": "Contoso_Test",
					"solutionType": "3P"
				}
			],
			"additionalRequirements": {
				"iot": {},
				"attributes": [
					{
						"id": "HaveNotDecided",
						"type": "CustomerMarketplaceIntent"
					}
				]
			}
		}
	},
	"team": [
		{
			"firstName": "John",
			"lastName": "Doe",
			"phoneNumber": "1231231234",
			"email": "john.doe@contoso.com"
		}
	],
	"target": [],
	"mpnId": "<ENTER PARTNER_ID>"
}

Réponse REST

En cas de réussite, cette méthode retourne la ressource de référence renseignée dans le corps de la réponse.

Codes d’erreur et de réussite de la réponse

Chaque réponse est fournie avec un code d’état HTTP qui indique la réussite ou l’échec et plus d’informations de débogage. Utilisez un outil de suivi réseau pour lire ce code, le type d’erreur et d’autres paramètres. Pour obtenir la liste complète, consultez Codes d’erreur.

Exemple de réponse

{
	"id": "4eb82669-ccf8-4856-86fc-b9ffe116376b",
	"engagementId": "6d72b13d-8584-4bba-a642-6800b8e32330",
	"name": "Contoso Test Deal - [Private]",
	"organizationId": "00aa00aa-bb11-cc22-dd33-44ee44ee44ee",
	"organizationName": "Contoso Pvt Ltd",
	"lastModifiedVia": "4990cffe-04e8-4e8b-808a-1175604b879f",
	"target": [],
	"createdDateTime": "2024-07-27T14:57:00.0952954Z",
	"updatedDateTime": "2024-07-27T14:57:00.0952954Z",
	"status": "Active",
	"substatus": "Accepted",
	"qualification": "SalesQualified",
	"type": "Independent",
	"customerProfile": {
		"name": "Contoso Customer Inc",
		"address": {
			"addressLine1": "One Microsoft Way",
			"addressLine2": "34",
			"city": "Redmond",
			"state": "WA",
			"postalCode": "98052",
			"country": "US"
		},
		"size": "10to50employees",
		"team": [
			{
				"contactPreference": {
					"locale": "en-us",
					"disableNotifications": false
				},
				"firstName": "Sue",
				"lastName": "Smith",
				"phoneNumber": "1234567890",
				"email": "sue.smith@contosocustomer.com",
				"emailValidationStatus": "None",
				"phoneValidationStatus": "None"
			}
		],
		"ids": [],
		"isMatchingComplete": false
	},
	"consent": {
		"consentToToShareInfoWithOthers": true,
		"consentToContact": true,
		"ConsentToMicrosoftToContactSpecificPartners": true,
		"consentToShareReferralWithMicrosoftSellers": false
	},
	"details": {
		"notes": "Customer is looking to leverage Dynamics 365 to manage their supply chain. There's also a need to leverage a set of custom apps to enable their business processes.",
		"dealValue": 50000.0,
		"currency": "USD",
		"closingDateTime": "2024-11-14T00:00:00Z",
		"requirements": {
			"industries": [],
			"products": [],
			"services": [],
			"solutions": [
				{
					"name": "Contoso-Ale_Test",
					"type": "Name",
					"publisherName": "Contoso_Test",
					"solutionType": "3P",
					"id": "SOL-15974-MQF"
				}
			],
			"additionalRequirements": {
				"iot": {
					"azureCertifiedDevice": false,
					"attachServices": false
				},
				"attributes": [
					{
						"type": "CustomerMarketplaceIntent",
						"id": "HaveNotDecided"
					}
				]
			}
		}
	},
	"team": [
		{
			"contactPreference": {
				"locale": "en-us",
				"disableNotifications": false
			},
			"firstName": "John",
			"lastName": "Doe",
			"phoneNumber": "1231231234",
			"email": "john.doe@contoso.com",
			"emailValidationStatus": "None",
			"phoneValidationStatus": "None"
		}
	],
	"inviteContext": {
		"invitedBy": {
			"organizationId": "00aa00aa-bb11-cc22-dd33-44ee44ee44ee",
			"organizationName": "Contoso Pvt Ltd"
		},
		"assistanceRequestCode": "Unknown",
		"invitedMpnId": "<PARTNER_ID>"
	},
	"favorite": false,
	"trackingInfo": {},
	"direction": "Outgoing",
	"mpnId": "<PARTNER_ID>",
	"dealSensitivity": "None",
	"createdVia": "4990cffe-04e8-4e8b-808a-1175604b879f",
	"acceptedDateTime": "2024-07-27T14:56:59.2938209Z",
	"registrationStatus": "None",
	"links": {
		"relatedReferrals": {
			"uri": "https://api.partner.microsoft.com/v1.0/engagments/referrals?$filter=engagementId eq '6d72b13d-8584-4bba-a642-6800b8e32330'",
			"method": "GET"
		},
		"self": {
			"uri": "https://api.partner.microsoft.com/v1.0/engagments/referrals/4eb82669-ccf8-4856-86fc-b9ffe116376b",
			"method": "GET"
		}
	}
}

Créer une transaction de co-vente ou une référence partagée

Il existe deux étapes pour créer une transaction de co-vente ou une référence du type de référence partagé :

Créer une offre dirigée par un partenaire visible par les vendeurs Microsoft
Créer une référence Microsoft à l’aide des détails de la référence de partenaire

L’organigramme suivant illustre ces deux étapes de création d’une référence partagée.

Organigramme montrant une référence partagée avec deux références connectées via l’API.

Étape 1 : Créer une offre dirigée par un partenaire visible par les vendeurs Microsoft

Tout d’abord, créez une offre pilotée par un partenaire visible par les vendeurs Microsoft à l’aide de la charge utile de demande suivante.

Important

Notez que pour faire référence à un partenaire dirigé par un partenaire, consentToShareReferralWithMicrosoftSellers est fourni comme vrai. Une référence privée active peut être convertie en partenaire uniquement en mettant à jour la référence pour ce champ.

POST https://api.partner.microsoft.com/v1.0/engagements/referrals HTTP/1.1
Authorization: Bearer <token>
Host: api.partner.microsoft.com
Content-Type: application/json

 {
	"name": "Contoso Test Deal - [PartnerLed]",
	"qualification": "SalesQualified",
	"type": "Shared",
	"customerProfile": {
		"name": "Contoso Customer Inc",
		"address": {
			"addressLine1": "One Microsoft Way",
			"addressLine2": "34",
			"city": "Redmond",
			"state": "WA",
			"postalCode": "98052",
			"country": "US"
		},
		"size": "10to50employees",
		"team": [
			{
				"firstName": "Sue",
				"lastName": "Smith",
				"phoneNumber": "1234567890",
				"email": "sue.smith@contosocustomer.com"
			}
		]
	},
	"consent": {
		"ConsentToToShareInfoWithOthers": true,
		"ConsentToContact": true,
		"ConsentToMicrosoftToContactSpecificPartners": true,
		"consentToShareReferralWithMicrosoftSellers": true
	},
	"details": {
		"notes": "Customer is looking to leverage Dynamics 365 to manage their supply chain. There's also a need to leverage a set of custom apps to enable their business processes.",
		"dealValue": 50000,
		"currency": "USD",
		"closingDateTime": "2024-11-14T00:00:00Z",
		"requirements": {
			"solutions": [
				{
					"type": "Name",
					"id": "SOL-15974-MQF",
					"name": "Contoso-Ale_Test",
					"publisherName": "Contoso_Test",
					"solutionType": "3P"
				}
			],
			"additionalRequirements": {
				"iot": {},
				"attributes": [
					{
						"id": "HaveNotDecided",
						"type": "CustomerMarketplaceIntent"
					}
				]
			}
		}
	},
	"team": [
		{
			"firstName": "John",
			"lastName": "Doe",
			"phoneNumber": "1231231234",
			"email": "john.doe@contoso.com"
		}
	],
	"target": [],
	"mpnId": "<ENTER PARTNER_ID>"
}

RéférenceTarget représente des informations supplémentaires qu’un partenaire peut fournir lors de l’invitation d’autres organisations dans l’engagement. Pour spécifier « target » dans une référence pour type SolutionProfile, voici un exemple de valeur pour référence :

"target": [
        {
            "type": "SolutionProfile",
            "id": "SOL-ABC-DEF"
        }
    ]

Remarque

Le type de champ fourni en tant qu’indépendant ou partagé dans l’entrée de requête n’est qu’une valeur indicative et n’a pas d’impact sur le type de transaction. Valeur réelle dans l’API affectée en fonction d’autres paramètres tels que le consentement et inviteContext.

Étape 2 : Créer une référence Microsoft à l’aide des détails de la référence de partenaire

Ensuite, créez la référence Microsoft via un autre appel d’API et liez-la à la référence partenaire à l’aide du champ ID d’engagement retourné à l’étape 1.

POST https://api.partner.microsoft.com/v1.0/engagements/referrals HTTP/1.1
Authorization: Bearer <token>
Host: api.partner.microsoft.com
Content-Type: application/json

{
    "engagementId": "<ENGAGEMENT_ID (FROM PARTNER REFERRAL)>",
    "organizationId": "msft",
    "organizationName": "Microsoft",
    "name": "Contoso Test Deal",
    "type": "Shared",
    "qualification": "SalesQualified",
    "customerProfile": {
		"name": "Contoso Customer Inc",
		"address": {
			"addressLine1": "One Microsoft Way",
			"addressLine2": "34",
			"city": "Redmond",
			"state": "WA",
			"postalCode": "98052",
			"country": "US"
		},
		"size": "10to50employees",
		"team": [
			{
				"firstName": "Sue",
				"lastName": "Smith",
				"phoneNumber": "1234567890",
				"email": "sue.smith@contosocustomer.com",
				"emailValidationStatus": "None",
				"phoneValidationStatus": "None"
			}
		],
		"isMatchingComplete": false
	},
    "consent": {
        "consentToToShareInfoWithOthers": true,
        "consentToContact": true,
        "ConsentToMicrosoftToContactSpecificPartners": true,
        "consentToShareReferralWithMicrosoftSellers": true
    },
    "details": {
        "notes": "Test notes to Microsoft.",
        "dealValue": 50000.0,
	"currency": "USD",
        "closingDateTime": "2024-11-14T00:00:00Z"
    },
    "team": [],
    "inviteContext": {
        "notes": "Proof of concept / Demo , Test notes to Microsoft.",
        "invitedBy": {
            "organizationId": "<ORGANIZATION_ID (FROM PARTNER REFERRAL)>",
            "organizationName": "<ORGANIZATION_NAME (FROM PARTNER REFERRAL)>"
        },
        "assistanceRequestCode": "ProofOfConceptOrDemo"
    },
    "target": []
}

Pour spécifier ReferenceTarget pour une référence Microsoft, voici un exemple de valeur pour référence :

"target": [
        {
            "type": "BusinessProfileLocation",
            "id": "msft"
        }
    ]

Créer une opportunité de co-vente de services

Pour créer une opportunité de co-vente de services, PartnerRole, SolutionArea et SolutionPlay doivent être fournis dans > les conditions > requises supplémentaires.
Les détails de la solution sont facultatifs dans les opportunités de co-vente des services.

"details": {
		"dealValue": 123456,
		"currency": "USD",
		"closingDateTime": "2025-01-21T18:30:00.000Z",
		"notes": "Test Notes",
		"requirements": {
			"solutions": [],
			"additionalRequirements": {
				"attributes": [
					{
						"id": "Adoption and change management",
						"type": "PartnerRole"
					},
					{
						"id": "Data and AI",
						"type": "SolutionArea"
					},
					{
						"id": "Enable Unified Data Governance",
						"type": "SolutionPlay"
					}
				]
			}
		}
	}

Ressources de référence

Partager via

Créer une référence

Prérequis

Demande REST

Syntaxe de la requête

En-têtes de requête

Corps de la demande

Exemple de requête

Réponse REST

Codes d’erreur et de réussite de la réponse

Exemple de réponse

Créer une transaction de co-vente ou une référence partagée

Étape 1 : Créer une offre dirigée par un partenaire visible par les vendeurs Microsoft

Étape 2 : Créer une référence Microsoft à l’aide des détails de la référence de partenaire

Créer une opportunité de co-vente de services

Commentaires

Ressources supplémentaires

Partager via

Créer une référence

Prérequis

Demande REST

Syntaxe de la requête

En-têtes de requête

Corps de la demande

Exemple de requête

Réponse REST

Codes d’erreur et de réussite de la réponse

Exemple de réponse

Créer une transaction de co-vente ou une référence partagée

Étape 1 : Créer une offre dirigée par un partenaire visible par les vendeurs Microsoft

Étape 2 : Créer une référence Microsoft à l’aide des détails de la référence de partenaire

Créer une opportunité de co-vente de services

Contenu connexe

Commentaires

Ressources supplémentaires