Dela via

Skapa en hänvisning

  • Artikel

Den här artikeln beskriver hur du skapar en hänvisning.

Förutsättningar

  • Autentiseringsuppgifter enligt beskrivningen i API-autentisering för hänvisningar. Det här scenariot stöder autentisering med app+användarautentiseringsuppgifter.

REST-begäran

Syntax för begäran

Metod URI för förfrågan
POST https://api.partner.microsoft.com/v1.0/engagements/referrals

Begärandehuvuden

Begärandetext

Den här tabellen beskriver referensegenskaperna i begärandetexten för en helt ny hänvisning.

Property Type Beskrivning
Name sträng Namnet på hänvisningen.
ExternalReferenceID sträng En extern identifierare för hänvisningen. Till exempel ditt eget Dynamics 365 lead- eller affärsmöjlighets-ID.
Status ReferralStatus En uppräkning med värden som anger referensstatus.
Understatus ReferralSubstatus En Uppräkning med värden som anger referensunderstatusen.
StatusReason sträng Ett beskrivande meddelande om statusen. Förklara till exempel varför hänvisningen gick förlorad.
ReferralType ReferralType Representerar referenstypen. Obligatoriska.
Kvalifikation ReferralQualification Representerar referensens kvalitet.
CustomerProfile CustomerProfile Kundkontaktinformation. Obligatoriska.
Samtycke Samtycke Medgivandeflaggor kring att dela information med andra organisationer och låta dem kontakta användare.Krävs.
Details ReferralDetails Kundinformation, anteckningar, avtalsvärde, valutastängningsdatum. Obligatoriska.
Team Medlem Representerar användare i de organisationer som är involverade i partnerengagemanget.
InviteContext InviteContext Representerar mer information som en användare kan ge när han eller hon bjuder in en annan organisation till partnerengagemanget.
Mål ReferralTarget Representerar mer information som en användare kan ge när han eller hon bjuder in en annan organisation till partnerengagemanget.
Partnerroll PartnerRole Krävs endast för hänvisningar till samförsäljning av tjänster
Lösningsområde SolutionArea Kundens lösningsområde behöver i affärsmöjligheten. Krävs endast för hänvisningar till samförsäljning av tjänster
Lösningsspel SolutionPlay Kundens lösningsspel behöver i affärsmöjligheten. Krävs endast för hänvisningar till samförsäljning av tjänster

Exempel på begäran

Viktigt!

Den här exempelbegäran beskriver hur du skapar en privat hänvisning med minimal information som krävs. Observera att nyckelparametern för att göra den här hänvisningen till en privat affär är 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>"
}

REST-svar

Om det lyckas returnerar den här metoden den ifyllda referensresursen i svarstexten.

Svarsframgång och felkoder

Varje svar levereras med en HTTP-statuskod som anger lyckad eller misslyckad och mer felsökningsinformation. Använd ett verktyg för nätverksspårning för att läsa den här koden, feltypen och andra parametrar. Den fullständiga listan finns i Felkoder.

Svarsexempel

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

Skapa ett säljsamarbete eller en delad hänvisning

Det finns två steg för att skapa en co-sell-affär eller hänvisning av den delade referenstypen:

  1. Skapa ett partnerledt avtal som är synligt för Microsoft-säljare
  2. Skapa en Microsoft-hänvisning med hjälp av partnerreferensinformation

Följande flödesschema illustrerar dessa två steg när du skapar en delad hänvisning.

Flödesdiagram som visar en delad hänvisning med två hänvisningar som är anslutna via API:et.

Steg 1: Skapa ett partnerledt avtal som är synligt för Microsoft-säljare

Skapa först ett partnerledt avtal som är synligt för Microsoft-säljare med hjälp av följande nyttolast för begäran.

Viktigt!

Observera att för att göra en hänvisning partnerledd anges consentToShareReferralWithMicrosoftSellers som sant. En aktiv privat hänvisning kan konverteras till Partnerledd bara genom att uppdatera hänvisningen för det här fältet.

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 representerar ytterligare information som en partner kan ge när de bjuder in andra organisationer till engagemanget. Här är ett exempelvärde för referens för att ange "mål" i en referens för typen SolutionProfile:

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

Kommentar

Fälttypen som anges som Oberoende eller Delad i begärandeindata är bara ett vägledande värde och det påverkar inte avtalstypen. Det faktiska värdet i tilldelat i API baserat på andra parametrar som medgivande och inviteContext.

Steg 2: Skapa en Microsoft-hänvisning med hjälp av partnerreferensinformation

Skapa sedan Microsoft-hänvisningen via ett annat API-anrop och länka den till partnerreferensen med hjälp av fältet Engagement ID som returneras från steg 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": []
}

Här är ett exempelvärde för referens för att ange ReferralTarget för en Microsoft-hänvisning:

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

Skapa möjligheter till säljsamarbete med tjänster

  1. För att skapa en möjlighet till säljsamarbete med tjänster måste PartnerRole, SolutionArea och SolutionPlay anges i ytterligare informationskrav > >.
  2. Lösningsinformation är valfria i Möjligheter till säljsamarbete med tjänster.
"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"
					}
				]
			}
		}
	}

Relaterat innehåll