Criar uma indicação

Artigo
08/12/2024

Este artigo explica como criar uma indicação.

Pré-requisitos

Credenciais, conforme descrito em Autenticação da API de referências. Este cenário dá suporte à autenticação com credenciais de aplicativo + usuário.

Solicitação REST

Sintaxe da solicitação

Método	URI da solicitação
POST	`https://api.partner.microsoft.com/v1.0/engagements/referrals`

Cabeçalhos da solicitação

Para obter mais informações, confira Cabeçalhos de API REST do Partner.

Corpo da solicitação

Esta tabela descreve as propriedades de Indicação no corpo da solicitação para uma indicação nova.

Propriedade	Type	Descrição
Nome	string	O nome da indicação.
Identificação de referência externa	string	Um identificador externo para a indicação. Por exemplo, sua própria ID de oportunidade ou cliente potencial do Dynamics 365.
Status	ReferralStatus	Uma classe Enum com valores que indicam o status da indicação.
Substatus	ReferralSubstatus	Uma classe Enum com valores que indicam o substatus da indicação.
StatusReason	string	Uma mensagem descritiva sobre o status. Por exemplo, explique por que a indicação foi perdida.
ReferralType	ReferralType	Representa o tipo de indicação. Obrigatório.
Qualificação	ReferralQualification	Representa a qualidade da indicação.
Perfil do Cliente	Perfil do Cliente	Informações de contato do cliente. Obrigatório.
Consentimento	Consentimento	Sinalizadores de consentimento em relação ao compartilhamento de informações com outras organizações e permitindo que eles entrem em contato com os usuários. Necessário.
Detalhes	ReferralDetails	Detalhes do cliente, observações, valor da negociação e data de fechamento da moeda. Obrigatório.
Team	Membro	Representa os usuários nas organizações envolvidas na participação do parceiro.
InviteContext	InviteContext	Representa mais informações que um usuário pode fornecer ao convidar outra organização para o compromisso do parceiro.
Destino	ReferralTarget	Representa mais informações que um usuário pode fornecer ao convidar outra organização para o compromisso do parceiro.
Função do parceiro	PartnerRole	Obrigatório apenas para referências de venda conjunta de Serviços
Área da solução	Área de solução	A área de solução da necessidade do cliente na oportunidade. Obrigatório apenas para referências de venda conjunta de Serviços
Jogo de solução	SoluçãoJogar	O jogo da solução da necessidade do cliente na oportunidade. Obrigatório apenas para referências de venda conjunta de Serviços

Exemplo de solicitação

Importante

Este exemplo de solicitação descreve como criar uma indicação privada com o mínimo de informações necessárias. Observe que o parâmetro principal para tornar essa indicação um negócio privado é 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>"
}

Resposta REST

Se for bem-sucedido, esse método retornará o recurso de Indicação populado no corpo da resposta.

Códigos de êxito e de erro de resposta

Cada resposta vem com um código de status HTTP que indica êxito ou falha e mais informações de depuração. Use uma ferramenta de rastreamento de rede para ler esse código, tipo de erro e outros parâmetros. Para obter a lista completa, confira Códigos de Erro.

Exemplo de resposta

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

Criar um acordo de venda conjunta ou uma indicação compartilhada

Há duas etapas para criar uma oferta de venda conjunta ou indicação do tipo Indicação compartilhada:

Criar uma oferta liderada por parceiros visível para os vendedores da Microsoft
Criar uma indicação da Microsoft usando detalhes de indicação de parceiro

O fluxograma a seguir ilustra essas duas etapas na criação de uma referência compartilhada.

Fluxograma mostrando uma referência compartilhada com duas referências conectadas por meio da API.

Etapa 1: Criar uma oferta liderada por um parceiro visível para os vendedores da Microsoft

Primeiro, crie um negócio liderado por parceiros visível para os vendedores da Microsoft usando o conteúdo de solicitação a seguir.

Importante

Observe que, para fazer uma indicação liderada por parceiros, consentToShareReferralWithMicrosoftSellers é fornecido como true. Uma indicação privada ativa pode ser convertida em Liderada por parceiro apenas atualizando a referência para esse campo.

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 representa informações adicionais que um parceiro pode fornecer ao convidar outras organizações para o compromisso. Para especificar 'target' em uma referência para o tipo SolutionProfile, aqui está um valor de exemplo para referência:

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

Observação

O tipo de campo fornecido como Independente ou Compartilhado na entrada da solicitação é apenas um valor indicativo e não afeta o tipo de negócio. O valor real é atribuído na API com base em outros parâmetros, como consent e inviteContext.

Etapa 2: Criar uma indicação da Microsoft usando detalhes de indicação de parceiro

Em seguida, crie a indicação da Microsoft por meio de outra chamada à API e vincule-a à indicação de Parceiro usando o campo ID do Compromisso retornado da Etapa 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": []
}

Para especificar ReferralTarget para uma indicação da Microsoft, aqui está um valor de exemplo para referência:

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

Criar oportunidade de venda conjunta de serviços

Para criar uma oportunidade de venda conjunta de serviços, PartnerRole, SolutionArea e SolutionPlay devem ser fornecidos em requisitos detalhados > additionalRequirements.>
Os detalhes da solução são opcionais nas oportunidades de venda conjunta de serviços.

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

Recursos de indicação

Compartilhar via

Criar uma indicação

Pré-requisitos

Solicitação REST

Sintaxe da solicitação

Cabeçalhos da solicitação

Corpo da solicitação

Exemplo de solicitação

Resposta REST

Códigos de êxito e de erro de resposta

Exemplo de resposta

Criar um acordo de venda conjunta ou uma indicação compartilhada

Etapa 1: Criar uma oferta liderada por um parceiro visível para os vendedores da Microsoft

Etapa 2: Criar uma indicação da Microsoft usando detalhes de indicação de parceiro

Criar oportunidade de venda conjunta de serviços

Comentários

Recursos adicionais

Compartilhar via

Criar uma indicação

Pré-requisitos

Solicitação REST

Sintaxe da solicitação

Cabeçalhos da solicitação

Corpo da solicitação

Exemplo de solicitação

Resposta REST

Códigos de êxito e de erro de resposta

Exemplo de resposta

Criar um acordo de venda conjunta ou uma indicação compartilhada

Etapa 1: Criar uma oferta liderada por um parceiro visível para os vendedores da Microsoft

Etapa 2: Criar uma indicação da Microsoft usando detalhes de indicação de parceiro

Criar oportunidade de venda conjunta de serviços

Conteúdo relacionado

Comentários

Recursos adicionais