Een verwijzing maken

Artikel
08/12/2024

In dit artikel wordt uitgelegd hoe u een verwijzing maakt.

Vereisten

Referenties zoals beschreven in verwijzings-API-verificatie. Dit scenario ondersteunt verificatie met app+gebruikersreferenties.

REST-aanvraag

Aanvraagsyntaxis

Wijze	Aanvraag-URI
POST	`https://api.partner.microsoft.com/v1.0/engagements/referrals`

Aanvraagheaders

Zie Rest-headers voor partner-API's voor meer informatie.

Aanvraagtekst

In deze tabel worden de verwijzingseigenschappen in de aanvraagtekst voor een gloednieuwe verwijzing beschreven.

Eigenschap	Type	Description
Naam	tekenreeks	De naam van de verwijzing.
ExternalReferenceID	tekenreeks	Een externe id voor de verwijzing. Bijvoorbeeld uw eigen Dynamics 365 lead- of verkoopkans-id.
Status	ReferralStatus	Een enum met waarden die de verwijzingsstatus aangeven.
Substatus	ReferralSubstatus	Een opsomming met waarden die de substatus van de verwijzing aangeven.
StatusReden	tekenreeks	Een beschrijvend bericht over de status. Leg bijvoorbeeld uit waarom de verwijzing is verbroken.
ReferralType	ReferralType	Vertegenwoordigt het verwijzingstype. Vereist.
kwalificatie	ReferralQualification	Vertegenwoordigt de kwaliteit van de verwijzing.
CustomerProfile	CustomerProfile	Contactgegevens van de klant. Vereist.
Toestemming	Toestemming	Toestemmingsvlagken voor het delen van informatie met andere organisaties en het toestaan van contact met gebruikers.Vereist.
DETAILS	ReferralDetails	Klantgegevens, notities, dealwaarde, sluitingsdatum van valuta. Vereist.
Team	Lid	Vertegenwoordigt gebruikers in de organisaties die betrokken zijn bij de partnerbetrokkenheid.
InviteContext	InviteContext	Vertegenwoordigt meer informatie die een gebruiker kan opgeven bij het uitnodigen van een andere organisatie bij de partnerbetrokkenheid.
Doel	ReferralTarget	Vertegenwoordigt meer informatie die een gebruiker kan opgeven bij het uitnodigen van een andere organisatie bij de partnerbetrokkenheid.
Partnerrol	PartnerRole	Alleen vereist voor collectieve verkoopverwijzingen van services
Oplossingsgebied	SolutionArea	Het gebied Oplossing van de klant nodig in de verkoopkans. Alleen vereist voor collectieve verkoopverwijzingen van services
Oplossing afspelen	SolutionPlay	Het oplossingsspel van de klant moet in de gelegenheid zijn. Alleen vereist voor collectieve verkoopverwijzingen van services

Aanvraagvoorbeeld

Belangrijk

In deze voorbeeldaanvraag wordt beschreven hoe u een privéverwijzing maakt met minimale informatie die vereist is. U ziet dat de sleutelparameter om deze verwijzing een privé-deal te maken consentToShareReferralWithMicrosoftSellers is.

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

REST-antwoord

Als dit lukt, retourneert deze methode de ingevulde verwijzingsresource in de hoofdtekst van het antwoord.

Geslaagde antwoorden en foutcodes

Elk antwoord wordt geleverd met een HTTP-statuscode die aangeeft dat het succes of de fout optreedt en meer informatie over foutopsporing. Gebruik een hulpprogramma voor netwerktracering om deze code, het fouttype en andere parameters te lezen. Zie Foutcodes voor de volledige lijst.

Responsvoorbeeld

{
	"id": "4eb82669-ccf8-4856-86fc-b9ffe116376b",
	"engagementId": "6d72b13d-8584-4bba-a642-6800b8e32330",
	"name": "Contoso Test Deal - [Private]",
	"organizationId": "11111111-2222-3333-4444-555566667777",
	"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": "11111111-2222-3333-4444-555566667777",
			"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"
		}
	}
}

Een collectieve verkoopdeal of een gedeelde verwijzing maken

Er zijn twee stappen voor het maken van een collectieve verkoopdeal of verwijzing van het type gedeelde verwijzing:

Een door partners geleide deal maken die zichtbaar is voor Microsoft-verkopers
Een Microsoft-verwijzing maken met partnerverwijzingsgegevens

Het volgende stroomdiagram illustreert deze twee stappen bij het maken van een gedeelde verwijzing.

Stroomdiagram met een gedeelde verwijzing met twee verwijzingen die zijn verbonden via de API.

Stap 1: Een door een partner geleide deal maken die zichtbaar is voor Microsoft-verkopers

Maak eerst een door partners geleide deal die zichtbaar is voor Microsoft-verkopers met behulp van de volgende nettolading van aanvragen.

Belangrijk

Houd er rekening mee dat toestemmingToShareReferralWithMicrosoftSellers wordt geleverd als waar om een verwijzingspartner te maken. Een actieve privéverwijzing kan worden geconverteerd naar partnergestuurd door de verwijzing voor dit veld bij te werken.

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

ReferralTarget vertegenwoordigt aanvullende informatie die een partner kan bieden bij het uitnodigen van andere organisaties bij de betrokkenheid. Als u doel wilt opgeven in een verwijzing voor het type SolutionProfile, ziet u hier een voorbeeldwaarde voor referentie:

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

Notitie

Het veldtype dat is opgegeven als Onafhankelijk of Gedeeld in de aanvraaginvoer, is slechts een indicatief waarde en heeft geen invloed op het dealtype. De werkelijke waarde die is toegewezen in de API op basis van andere parameters, zoals toestemming en inviteContext.

Stap 2: Een Microsoft-verwijzing maken met behulp van partnerverwijzingsgegevens

Maak vervolgens de Microsoft-verwijzing via een andere API-aanroep en koppel deze aan de partnerverwijzing met behulp van het veld Afspraak-id dat is geretourneerd uit stap 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": []
}

Als u ReferralTarget wilt opgeven voor een Microsoft-verwijzing, ziet u hier een voorbeeldwaarde ter referentie:

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

Collectieve verkoopkans voor services maken

Als u een verkoopkans voor services voor collectieve verkoop wilt maken, moeten PartnerRole, SolutionArea en SolutionPlay worden opgegeven in gedetailleerde > vereisten > , aanvullende vereisten.
Oplossingsdetails zijn optioneel in collectieve verkoopkansen van 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"
					}
				]
			}
		}
	}

Verwijzingsbronnen

Delen via

Een verwijzing maken

Vereisten

REST-aanvraag

Aanvraagsyntaxis

Aanvraagheaders

Aanvraagtekst

Aanvraagvoorbeeld

REST-antwoord

Geslaagde antwoorden en foutcodes

Responsvoorbeeld

Een collectieve verkoopdeal of een gedeelde verwijzing maken

Stap 1: Een door een partner geleide deal maken die zichtbaar is voor Microsoft-verkopers

Stap 2: Een Microsoft-verwijzing maken met behulp van partnerverwijzingsgegevens

Collectieve verkoopkans voor services maken

Feedback

Aanvullende resources

Delen via

Een verwijzing maken

Vereisten

REST-aanvraag

Aanvraagsyntaxis

Aanvraagheaders

Aanvraagtekst

Aanvraagvoorbeeld

REST-antwoord

Geslaagde antwoorden en foutcodes

Responsvoorbeeld

Een collectieve verkoopdeal of een gedeelde verwijzing maken

Stap 1: Een door een partner geleide deal maken die zichtbaar is voor Microsoft-verkopers

Stap 2: Een Microsoft-verwijzing maken met behulp van partnerverwijzingsgegevens

Collectieve verkoopkans voor services maken

Gerelateerde inhoud

Feedback

Aanvullende resources