Criar uma indicação
Este artigo explica como criar uma referência. Existem dois tipos de ReferralType:
Independente: quando uma indicação é visível para um parceiro.
Compartilhado: quando uma referência é visível para duas partes que estão trabalhando juntas. Por exemplo, se a Microsoft e um parceiro estiverem trabalhando juntos em um negócio de venda conjunta, uma indicação poderá ser compartilhada entre as duas partes. Para obter mais informações, consulte a seção Criar uma indicação compartilhada.
Observação
Os recursos de qualificação do MACC e de correspondência de clientes não estão disponíveis com o uso da integração de API.
Tipos de negócio
Existem três tipos de oportunidades de covenda (ou ofertas ou referências) que podem ser criadas a partir do Partner Center - Private, Partner-Led e Co-sell. Normalmente, a partir da interface do usuário do Partner Center, essas opções são apresentadas ao usuário, mas ao criá-las a partir da API, há outras etapas a serem executadas. Na interface do usuário de referências do Partner Center, quando você cria um novo negócio, há uma Ajuda necessária na seção Microsoft , onde essas opções são apresentadas ao usuário.
- Negócio privado: você opta por não compartilhar o acordo com a Microsoft, seleciona "Nenhuma ajuda necessária" e responde "não" à pergunta: "Você gostaria de compartilhar o negócio com os vendedores da Microsoft?"
- Liderado por parceiros: você escolhe "Sem necessidade de ajuda", mas responde "sim" à pergunta: "Você gostaria de compartilhar o acordo com os vendedores da Microsoft?"
- Co-venda: Você escolhe obter ajuda da Microsoft e também responde "sim" à pergunta: "Você gostaria de compartilhar o acordo com os vendedores da Microsoft?"
Pré-requisitos
- Credenciais conforme descrito em Autenticação de API do Partner. 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. |
| ExternalReferenceID | 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. |
| Equipe | 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 | Necessário apenas para referências de co-venda de Serviços | Pode ser um dos seguintes valores - Previsão de pré-vendas, Design de solução, Prova de conceito, Estratégia de negócios, Serviços de implantação, Adoção e gerenciamento de mudanças, Transação, Serviços gerenciados |
| Área da solução | Necessário apenas para referências de co-venda de Serviços | A área de Solução do Cliente precisa na oportunidade. Consulte a tabela a seguir para obter os valores. |
| Jogar a solução | Necessário apenas para referências de co-venda de Serviços | A solução joga a necessidade do cliente na oportunidade. Consulte a tabela a seguir para obter os valores. |
Área da Solução e valores do Jogo da Solução
A tabela a seguir mostra os valores dos campos Área de Solução e Reprodução de Solução para FY 24.
| Área da solução | Jogar a solução |
|---|---|
| Aplicativos de negócios | Acelere a inovação com Low Code |
| Aplicativos de negócios | Acelere a geração de receita |
| Aplicativos de negócios | Modernize o serviço |
| Aplicativos de negócios | Otimize as finanças e a cadeia de suprimentos |
| Aplicativos de negócios | Operações de negócios em escala SMB |
| Dados e IA | Potencialize as decisões de negócios com o Cloud Scale Analytics |
| Dados e IA | Crie e modernize aplicativos de IA |
| Inovação Digital e de Aplicações | Migrar aplicativos empresariais |
| Inovação Digital e de Aplicações | Crie e modernize aplicativos de IA |
| Inovação Digital e de Aplicações | Acelerar a produtividade do desenvolvedor |
| Inovação Digital e de Aplicações | Acelere a inovação com o Integration Services |
| Infraestrutura | Migrar e proteger o Windows Server e o SQL Server |
| Infraestrutura | Migrar o SAP |
| Infraestrutura | Inove com HPC, infraestrutura de IA |
| Infraestrutura | Migrar o Linux Estate |
| Infraestrutura | Migrar o Oracle |
| Trabalho moderno | Trabalhadores da linha de frente |
| Trabalho moderno | Experiência do Colaborador |
| Trabalho moderno | Produtividade segura |
| Trabalho moderno | Comunicações convergentes |
| Trabalho moderno | Pontos de extremidade na nuvem |
| Trabalho moderno | Modernizar com o Surface |
| Segurança | Proteção contra ameaças com XDR e SIEM |
| Segurança | Segurança Multi Cloud |
| Segurança | Segurança de dados |
| Segurança | Governança de dados |
| Segurança | Sec Ops moderno |
| Segurança | Identidade segura e takeout Okta e Ping |
| Suporte Unificado | Construa uma base sólida com o Unified |
| Suporte Unificado | Impulsione o sucesso na nuvem com soluções aprimoradas |
Estados de transição de status e substatus
| Status | Transição de status permitido | Substatus permitido |
|---|---|---|
| Novo | Novo, Ativo, Fechado | Pendente, Recebido |
| Ativa | Ativo, Fechado | Aceito |
| Fechadas | Fechadas | Ganho, Perdido, Recusado, Expirado |
Exemplo de solicitação
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": "Test Cosell Invite_20",
"status": "New",
"substatus": "Pending",
"statusReason": "Customer engagement was a success!",
"qualification": "SalesQualified",
"type": "Shared",
"target": [
{
"type": "SolutionProfile",
"id": "SOL-34104-EBB"
}
],
"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@contoso.com"
},
{
"contactPreference": {
"locale": "en-us",
"disableNotifications": false
},
"firstName": "Joe",
"lastName": "Hansen",
"phoneNumber": "4035698759",
"email": "joe.hansen@contoso.com"
}
],
"ids": []
},
"consent": {
"consentToToShareInfoWithOthers": true,
"consentToContact": 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": "2018-11-14T00:00:00Z",
"requirements": {
"industries": [
{
"id": "Manufacturing"
}
],
"products": [
{
"id": "Dynamics365Enterprise"
}
],
"services": [
{
"id": "DeploymentOrMigration"
}
],
"solutions": [
{
"name": "Dynamics 365 for Field Service",
"type": "Category",
"id": "Dynamics365forFieldService"
}
]
}
},
"team": [
{
"contactPreference": {
"locale": "en-us",
"disableNotifications": false
},
"firstName": "John",
"lastName": "Doe",
"phoneNumber": "1231231234",
"email": "john.doe@microsoft.com"
}
],
"inviteContext": {
"notes": "Hi ABC Partner, hoping you can help this customer. Thanks, John @ Microsoft",
"invitedBy": {
"organizationId": "msft"
}
}
}
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 sucesso 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": "4111fffc-f9ee-4d53-bba6-569135228642",
"engagementId": "37ef26aa-1d15-4533-9f93-a69bd33ab1e5",
"organizationId": "7d23e5ca-19dc-4eaa-aac8-5e6b559f0d1d",
"organizationName": "Contoso Company",
"name": "Test Cosell Invite_20",
"externalReferenceId": null,
"createdDateTime": "2019-02-23T02:05:23.2931817Z",
"updatedDateTime": "2019-02-23T02:05:23.2931817Z",
"expirationDateTime": null,
"status": "Active",
"substatus": "Accepted",
"statusReason": "Customer engagement was a success!",
"qualification": "SalesQualified",
"type": "Shared",
"eTag": "\"00006d10-0000-0000-0000-5c70aa630000\"",
"target": [
{
"type": "SolutionProfile",
"id": "SOL-34104-EBB"
}
],
"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@contoso.com"
},
{
"contactPreference": {
"locale": "en-us",
"disableNotifications": false
},
"firstName": "Joe",
"lastName": "Hansen",
"phoneNumber": "4035698759",
"email": "joe.hansen@contoso.com"
}
],
"ids": []
},
"consent": {
"consentToToShareInfoWithOthers": true,
"consentToContact": true
},
"details": {
"notes": "Customer is looking to leverage Dynamics 365 to manage their supply chain. There is also a need to leverage a set of custom apps to enable their business processes.",
"dealValue": 50000,
"currency": "USD",
"requirements": {
"industries": [
{
"id": "Manufacturing"
}
],
"products": [
{
"id": "Dynamics365Enterprise"
}
],
"services": [
{
"id": "DeploymentOrMigration"
}
],
"solutions": [
{
"name": "Dynamics 365 for Field Service",
"type": "Category",
"id": "Dynamics365forFieldService"
}
]
}
},
"team": [
{
"contactPreference": {
"locale": "en-us",
"disableNotifications": false
},
"firstName": "John",
"lastName": "Doe",
"phoneNumber": "1231231234",
"email": "john.doe@microsoft.com"
}
],
"inviteContext": {
"notes": "Hi ABC Partner, hoping you can help this customer. Thanks, John @ Microsoft",
"invitedBy": {
"organizationId": "msft"
}
},
"links": {
"relatedReferrals": {
"uri": "https://api.partner.microsoft.com/v1.0/engagments/referrals?$filter=engagementId eq '37ef26aa-1d15-4533-9f93-a69bd33ab1e5'",
"method": "GET"
},
"self": {
"uri": "https://api.partner.microsoft.com/v1.0/engagments/referrals/4111fffc-f9ee-4d53-bba6-569135228642",
"method": "GET"
}
}
}
Upgrade de acordo Private/Partner-led para Co-sell
Para criar um negócio de co-venda através da API, você precisa primeiro criar um negócio privado ou liderado por parceiro e, em seguida, criar a segunda referência e conectá-la com a primeira. As etapas são descritas na seção a seguir.
Etapa 1: Criar um negócio liderado por parceiro visível para os vendedores da Microsoft
Primeiro, crie um negócio liderado pelo parceiro visível para os vendedores da Microsoft usando a carga de solicitação a seguir.
POST https://api.partner.microsoft.com/v1.0/engagements/referrals
{
"name": "TEST Contoso Cosell Deal",
"externalReferenceId": "",
"campaignId": "",
"customerProfile": {
"isMatchingComplete": true,
"name": "Contoso Test Test",
"address": {
"addressLine1": "One Microsoft Way",
"addressLine2": "",
"city": "Redmond",
"state": "",
"region": "",
"country": "US"
},
"size": "",
"team": [
{
"firstName": "John",
"lastName": "Doe",
"phoneNumber": "123345667",
"email": "john@doe.com",
"title": "",
"phoneValidationStatus": "None",
"emailValidationStatus": "None",
"contactPreference": {
"disableNotifications": true
}
}
],
"ids": [
{
"profileType": "external",
"id": "9-XIPFFGUQI"
}
],
"type": ""
},
"consent": {
"ConsentToToShareInfoWithOthers": true,
"ConsentToContact": true,
"ConsentToMicrosoftToContactSpecificPartners": true,
"consentToShareReferralWithMicrosoftSellers": true
},
"details": {
"dealValue": 100000,
"currency": "USD",
"closingDateTime": "2024-11-23T18:30:00.000Z",
"notes": "",
"requirements": {
"solutions": [
{
"type": "Name",
"id": "SOL-8163-XCJ",
"name": "Contoso Solution",
"publisherName": "Contoso-ISV",
"price": null,
"currency": null,
"quantity": null,
"solutionType": "3P"
}
],
"additionalRequirements": {
"iot": {},
"attributes": [
{
"id": "HaveNotDecided",
"type": "CustomerMarketplaceIntent"
}
]
}
}
},
"team": [
{
"firstName": "John",
"lastName": "Doe",
"phoneNumber": "12345667",
"email": "john@doe.com",
"title": "",
"phoneValidationStatus": "None",
"emailValidationStatus": "None"
}
],
"type": "Shared",
"qualification": "SalesQualified",
"attributes": {
"objectType": "Referral"
},
"target": [],
"mpnId": "<ENTER PARTNER_MPN_ID>",
"trackingInfo": {}
}
Etapa 2: Criar uma referência da Microsoft usando detalhes de referência de parceiro
Em seguida, crie a referência da Microsoft por meio de outra chamada de API e vincule-a à referência de parceiro usando o campo ID do Compromisso retornado da Etapa 1.
POST https://api.partner.microsoft.com/v1.0/engagements/referrals
{
"engagementId": "<ENTER_ENGAGEMENT_ID_OF_PARTNER_REFERRAL>",
"organizationId": "msft",
"organizationName": "Microsoft",
"name": "TEST Contoso Cosell Deal",
"customerProfile": {
"name": "Contoso Test Test",
"size": "",
"isMatchingComplete": true,
"isMaccEligible": null,
"address": {
"addressLine1": "One Microsoft Way",
"addressLine2": "",
"city": "Redmond",
"state": "",
"postalCode": null,
"country": "US",
"region": ""
},
"team": [
{
"firstName": "John",
"lastName": "Doe",
"phoneNumber": "123345667",
"email": "john@doe.com",
"title": "",
"emailValidationStatus": "None",
"phoneValidationStatus": "None",
"linkedInProfileUrl": null,
"contactPreference": {
"disableNotifications": true
}
}
],
"ids": [
{
"profileType": "External",
"id": "9-XIPFFGUQI"
}
],
"activities": null
},
"consent": {
"consentToToShareInfoWithOthers": true,
"consentToContact": true,
"consentToShareReferralWithMicrosoftSellers": true
},
"details": {
"notes": "Test notes to Microsoft.",
"dealValue": 100000,
"currency": "USD",
"closingDateTime": "2024-11-23T18:30:00Z",
"requirements": {
"solutions": [],
"additionalRequirements": {
"iot": {},
"attributes": []
}
}
},
"team": [],
"inviteContext": {
"notes": "Proof of concept / Demo , Test notes to Microsoft.",
"invitedBy": {
"organizationId": "<PARTNER_ORGANIZATION_ID (ACCOUNT_ID GUID)>",
"organizationName": "<INVITING_PARTNERS_ORGANIZATION_NAME>"
},
"assistanceRequestCode": "ProofOfConceptOrDemo"
},
"type": "Shared",
"qualification": "SalesQualified",
"attributes": {
"objectType": "Referral"
},
"target": [],
"dealSensitivity": "None",
"trackingInfo": {}
}
Criar uma indicação compartilhada
Há duas etapas para criar uma referência do tipo de referência compartilhada:
O fluxograma a seguir ilustra essas duas etapas na criação de uma referência compartilhada.
Criar sua indicação
- Crie uma indicação com ReferralType definido como compartilhado.
- Copie o engagementID da resposta de retorno.
Exemplo de ReferralTarget para indicação
"target": [
{
"type": "SolutionProfile",
"id": "SOL-ABC-DEF"
}
]
Criar uma indicação conectada
- Crie outra indicação para a Microsoft.
- Inclua o enagementID de sua referência para que eles fiquem ligados.
Exemplo de ReferralTarget para indicação à Microsoft
"target": [
{
"type": "BusinessProfileLocation",
"id": "msft"
}
]
Próximas etapas
Comentários
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulte https://aka.ms/ContentUserFeedback.
Enviar e exibir comentários de