Not
Bu sayfaya erişim yetkilendirme gerektiriyor. Oturum açmayı veya dizinleri değiştirmeyi deneyebilirsiniz.
Bu sayfaya erişim yetkilendirme gerektiriyor. Dizinleri değiştirmeyi deneyebilirsiniz.
Bu makalede referans oluşturma açıklanmaktadır.
Önkoşullar
- Referanslar API kimlik doğrulaması bölümünde açıklandığı gibi kimlik bilgileri. Bu senaryo, App+User kimlik bilgileriyle kimlik doğrulamayı destekler.
REST İsteği
İstek söz dizimi
Metot | İstek URI'si |
---|---|
POST | https://api.partner.microsoft.com/v1.0/engagements/referrals |
İstek başlıkları
- Daha fazla bilgi için bkz . İş Ortağı API'si REST üst bilgileri.
İstek gövdesi
Bu tablo, yepyeni bir referans için istek gövdesindeki Referans özelliklerini açıklamaktadır.
Özellik | Türü | Açıklama |
---|---|---|
Ad | Dize | Referansın adı. |
DışReferansNo | Dize | Referans için bir dış tanımlayıcı. Örneğin, kendi Dynamics 365 müşteri adayınız veya fırsat kimliğiniz. |
Durum | Yönlendirme Durumu | Referans durumunu gösteren değerler içeren bir Enum. |
Alt Durum | Yönlendirme Alt Durumu | Referans alt durumunu gösteren değerlere sahip bir Enum. |
Durum Sebebi | Dize | Durum hakkında açıklayıcı bir ileti. Örneğin, referansın neden kaybolduğunu açıklayın. |
Yönlendirme Türü | Yönlendirme Türü | Başvuru türünü temsil eder. |
Nitelik | Referans Niteleme | Referansın kalitesini temsil eder. |
Müşteri profili | Müşteri profili | Müşteri iletişim bilgileri. |
Onay | İzin | Diğer kuruluşlarla bilgi paylaşımı ve kullanıcılarla iletişim kurmasına olanak sağlayan onay bayrakları.Gerekli. |
Ayrıntılar | ReferansDetayları | Müşteri ayrıntıları, notlar, anlaşma değeri, para birimi kapanış tarihi. |
Takım | Üye | kuruluşlardaki iş ortağı katılımına katılan kullanıcıları temsil eder. |
InviteContext | DavetBağlamı | Bir kullanıcının iş ortağı katılımına başka bir kuruluş davet ederken sağlayabilecekleri daha fazla bilgiyi temsil eder. |
Hedef | Yönlendirme Hedefi | Bir kullanıcının iş ortağı katılımına başka bir kuruluş davet ederken sağlayabilecekleri daha fazla bilgiyi temsil eder. |
İş ortağı rolü | PartnerRole | Yalnızca Hizmetler ortak satış referansları için gereklidir |
Çözüm Alanı | Çözüm Alanı | Müşterinin fırsatta ihtiyaç duyduğu Çözüm alanı. Yalnızca Hizmetler ortak satış referansları için gereklidir |
Çözüm Stratejisi | SolutionPlay | Fırsatta Müşteri ihtiyacına yönelik Çözüm stratejisi. Yalnızca Hizmetler ortak satış referansları için gereklidir |
İstek örneği
Önemli
Bu örnek istek, gerekli en az bilgiyle Özel bir başvuru oluşturmanın nasıl yapılacağını açıklar. Bu yönlendirmeyi özel bir anlaşma yapmak için anahtar parametrenin consentToShareReferralWithMicrosoftSellers olduğuna dikkat edin.
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"
}
],
"ids":[
{
"profileType":"moodys",
"id":"IN0011234567"
}
]
},
"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 Yanıtı
Başarılı olursa, bu yöntem yanıt gövdesinde doldurulan Yönlendirme kaynağını döndürür.
Yanıt başarısı ve hata kodları
Her yanıt, başarılı veya başarısız olduğunu belirten bir HTTP durum kodu ve daha fazla hata ayıklama bilgisi ile birlikte gelir. Bu kodu, hata türünü ve diğer parametreleri okumak için bir ağ izleme aracı kullanın. Tam listeyi görmek için Hata Kodları'na bakın.
Yanıt örneği
{
"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": [
{
"profileType":"moodys",
"id":"IN0011234567"
}
],
"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"
}
}
}
Ortak satış anlaşması veya paylaşılan referans oluşturma
Ortak satış anlaşması veya Paylaşılan referans türü referansı oluşturmak için iki adım vardır:
- Microsoft satıcılarının görebileceği iş ortağı liderliğinde bir anlaşma oluşturun.
- İş ortağı referans detaylarını kullanarak Microsoft tavsiyesi oluşturun
Aşağıdaki akış çizelgesi, paylaşılan başvuru oluşturma işleminin bu iki adımını göstermektedir.
İki referansın API ile bağlandığı bir paylaşılan referansı gösteren akış grafiği.
1. Adım: Microsoft satıcıları tarafından görülebilen İş ortağı liderliğinde bir anlaşma oluşturma
İlk olarak, aşağıdaki istek yükünü kullanarak Microsoft satıcıları tarafından görülebilen İş ortağı liderliğinde bir anlaşma oluşturun.
Önemli
İş Ortağı liderliğinde bir referansı yapmak için, consentToShareReferralWithMicrosoftSellers değerinin true olarak sağlandığını unutmayın. Etkin bir Özel referans, yalnızca bu alan için referans güncellenerek İş Ortağı yönlendirmesiyle dönüştürülebilir.
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, bir iş ortağının diğer kuruluşları katılıma davet ederken sağlayabilecekleri ek bilgileri temsil eder. SolutionProfiletürü için başvuruda 'hedef' belirtmek için, başvuru için örnek bir değer aşağıda verilmişti:
"target": [
{
"type": "SolutionProfile",
"id": "SOL-ABC-DEF"
}
]
Not
İstek girişinde Bağımsız veya Paylaşılan olarak sağlanan alan türü yalnızca bir gösterge değeridir ve anlaşma türünü etkilemez. Asıl değer, API içinde, onay ve davetBağlamı gibi diğer parametrelere göre atanır.
2. Adım: İş ortağı başvuru ayrıntılarını kullanarak Microsoft başvurusu oluşturma
Ardından, başka bir API çağrısı aracılığıyla Microsoft başvurusunu oluşturun ve 1. Adım'dan döndürülen Görevlendirme Kimliği alanını kullanarak iş ortağı başvurusuna bağlayın.
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": []
}
Bir Microsoft başvurusu için ReferralTarget belirtmek için örnek bir değer aşağıda verilmiştir:
"target": [
{
"type": "BusinessProfileLocation",
"id": "msft"
}
]
Hizmetler için ortak satış fırsatı oluştur
- Hizmetler Ortak Satış fırsatı oluşturmak için, PartnerRole, SolutionAreave SolutionPlayayrıntıları > gereksinimleri > additionalRequirementssağlanmalıdır.
- Çözüm ayrıntıları, Hizmetler Ortak satış fırsatlarında isteğe bağlıdır.
"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"
}
]
}
}
}