Обновление сведений о потенциальном клиенте или возможности

В этой статье объясняется, как обновить сведения о потенциальных или возможных возможностях, такие как стоимость сделки, оценка даты закрытия или управление этапами продаж среди других сведений.

Предварительные требования

• Учетные данные, как описано в аутентификации API рефералов. Этот сценарий поддерживает проверку подлинности с использованием учетных данных приложений и пользователей.
• Этот API в настоящее время поддерживает только доступ пользователей, где партнеры должны находиться в одной из следующих ролей: администратор рефералов или пользователь-реферал.

Запрос REST

Синтаксис запроса

параметр URI

Заголовки запросов

Дополнительные сведения см. в заголовках REST партнера.

Текст запроса

Тело запроса следует формату JSON Patch. Документ JSON Patch содержит массив операций. Каждая операция определяет определенный тип изменения. Примеры таких изменений включают добавление элемента массива или замена значения свойства.

Пример запроса

PATCH https://api.partner.microsoft.com/v1.0/engagements/referrals/{ID} HTTP/1.1
Authorization: Bearer <token>
Prefer: return=representation
Content-Type: application/json

[
    {
        "op": "replace",
        "path": "/details/dealValue",
        "value": "10000"
    },
    {
        "op": "add",
        "path": "/team/-",
        "value": {
            "email": "jane.doe@contoso.com",
            "firstName": "Jane",
            "lastName": "Doe",
            "phoneNumber": "0000000001"
        }
    }
]

Ответ REST

В случае успешного выполнения текст ответа содержит обновленного клиента или возможность.

Коды успешных ответов и ошибок

Каждый ответ содержит код состояния HTTP, указывающий на успех или неудачу, и другую отладочную информацию. Используйте средство трассировки сети для чтения этого кода, типа ошибки и других параметров.

Пример ответа

HTTP/1.1 204 No Content
Content-Length: 0
Request-ID: 9f8bed52-e4df-4d0c-9ca6-929a187b0731

Примеры запросов

1. Обновляет значение сделки для данной возможности на 10000; обновляет заметки. Из-за отсутствия заголовка If-Match нет проверок конкурентности.

   PATCH https://api.partner.microsoft.com/v1.0/engagements/referrals/{ID}
   Authorization: Bearer <token>
   Content-Type: application/json
   
   [
       {"op":"replace","path":"/details/dealValue","value":"10000"},
       {"op":"replace","path":"/details/notes","value":"Lorem ipsum dolor sit amet."}
   ]
   

2. Изменяет статус лида или возможности на «Выиграно».

   PATCH https://api.partner.microsoft.com/v1.0/engagements/referrals/{ID}
   Authorization: Bearer <token>
   Content-Type: application/json
   
   [
       {"op":"replace", "path":"/status", "value":"Closed"},
       {"op":"replace", "path":"/substatus", "value":"Won"}
   ]
   

   Внимание

   Поля status и substatus должны соответствовать допустимому набору значений перехода.

3. Добавляет нового участника из вашей организации в команду по работе с потенциальными клиентами или возможностями. Ответ содержит обновленный лид или возможность из-за наличия заголовка Prefer: return=representation.

   PATCH https://api.partner.microsoft.com/v1.0/engagements/referrals/{ID} HTTP/1.1
   Authorization: Bearer <token>
   Prefer: return=representation
   Content-Type: application/json
   
   [
       {
           "op": "add",
           "path": "/team/-",
           "value": {
               "email": "jane.doe@contoso.com",
               "firstName": "Jane",
               "lastName": "Doe",
               "phoneNumber": "0000000001"
           }
       }
   ]
   

Создание регистраций сделок

Используйте API регистрации сделок, чтобы создать регистрацию сделки в Центре партнеров, когда партнер и реферал имеют право участвовать. Дополнительные сведения о концепциях регистрации сделки и рабочих процессах см. в разделе регистрации сделок в Центре партнеров.

Требования к участию

• Партнер должен быть утвержден для регистрации сделки на основе критериев соответствия корпорации Майкрософт.
• Реферал должен поддерживать регистрацию сделки.

Как работает право на участие?

• Право быть партнёром определяется корпорацией Майкрософт и не осуществляется через рабочую область рефералов Центра партнёрства.
• Перед созданием регистрации сделки можно программно проверить соответствие требованиям партнера, вызвав API на проверку права на регистрацию сделки партнера.
• Ответ API указывает, может ли вызывающая сторона продолжать создание регистрации сделки.

Требования к соответствию гарантируют, что только соответствующие партнеры могут регистрировать сделки и помогают предотвратить неудачные или недействительные отправки.

API регистрации соответствия требованиям для сделок партнера

Синтаксис запроса

Пример запроса

GET https://api.partner.microsoft.com/v1.0/engagements/partners/dealregistrationeligibility HTTP/1.1
Authorization: Bearer <token>
Prefer: return=representation

Ответ сервиса REST

Если операция успешна, текст ответа содержит статус правомочности.

Коды успешных ответов и ошибок

Каждый ответ сопровождается кодом состояния HTTP, который указывает на успешность или сбой, а также содержит сведения об отладке. Используйте средство трассировки сети для чтения этого кода, типа ошибки и любых параметров.

Пример ответа

HTTP/1.1 200 OK
Request-ID: 2d1bed51-2fd9-adfc-h4a7-019kk87c0627
Content-Type: application/json

{
  "isEligible": true,
  "policies": [
    {
      "isEligible": true
    }
  ]
}

Правомочность регистрации реферальной сделки

Реферал имеет право на регистрацию сделки, если выполнены все следующие условия:

• Тип сделки — совместная продажа.
• Клиент является управляемым корпорацией Майкрософт.
• Общая стоимость сделки превышает 25 000 долларов США.
• По крайней мере одно связанное решение подходит для совместной продажи через Azure IP.
• Статус реферала Майкрософт принят.

Вы также можете программно проверить право на участие в программе реферальных ссылок, вызвав API проверки права на регистрацию сделки. Ответ API подтверждает, имеет ли заданный реферал совместной продажи право на регистрацию сделки.

API определения права на регистрацию сделки

Синтаксис запроса

параметр URI

Пример запроса

POST https://api.partner.microsoft.com/v1.0/engagements/referrals/{ID}/dealregistrations/eligibility HTTP/1.1
Authorization: Bearer <token>
Prefer: return=representation

Ответ сервиса REST

В случае успешного выполнения текст ответа содержит состояние соответствия и набор неудачных и переданных политик соответствия.

Коды успешных ответов и ошибок

Каждый ответ содержит код состояния HTTP, указывающий на успешность или сбой, и сведения об отладке. Используйте средство трассировки сети для чтения этого кода, типа ошибки и любых параметров.

Пример ответа

HTTP/1.1 200 OK
Request-ID: 9f8bed52-e4df-4d0c-9ca6-929a187b0731
Content-Type: application/json

{
  "isEligible": true,
  "passedPolicies": [
    {
      "policyName": "isDealTypeCosellOrPartnerLed",
      "isEligible": true,
      "referralProperties": {
        "type": "Shared"
      }
    },
    {
      "policyName": "isMicrosoftReferralAcceptedOrWon",
      "isEligible": true,
      "referralProperties": {
        "status": "Active",
        "substatus": "Accepted"
      }
    },
    {
      "policyName": "isSolutionIncentiveEligible",
      "isEligible": true,
      "referralProperties": {
        "solutionId": "DEAL-123456-XYZ",
        "solutionName": "Contoso Experience Platform"
      },
      "additionalProperties": [
        "MSFT Internal Azure IP Co-Sell"
      ]
    },
    {
      "policyName": "isDealValueEligible",
      "isEligible": true,
      "referralProperties": {
        "currency": "USD",
        "dealValue": "30000"
      }
    },
    {
      "policyName": "isCustomerManaged",
      "isEligible": true,
      "referralProperties": {
        "isMatchingComplete": "true"
      },
      "additionalProperties": [
        "Managed"
      ]
    }
  ],
  "failedPolicies": []
}

API регистрации сделки

Используйте существующую операцию обновления сделки (API PATCH) для создания регистрации сделки.

Пример запроса

PATCH https://api.partner.microsoft.com/v1.0/engagements/referrals/{ID} HTTP/1.1
Authorization: Bearer <token>
Prefer: return=representation
Content-Type: application/json

[
    {
        "op":"add",
        "path":"/registrations/-",
        "value":{
            "type":"AzureIPCoSell",
            "contract":{
                "currency":"USD",
                "endDateTime":"2026-02-28T09:14:19.454Z",
                "signDateTime":"2026-02-12T09:14:10.783Z",
                "startDateTime":"2026-02-12T09:14:16.319Z",
                "term":"Finite",
                "value":250000
            },
            "solutionDetails":[
                {
                    "id":"DEAL-123456-XYZ",
                    "isDeployedOnAzure":true,
                    "marketplaceTransactionDetails":{
                        "isMarketplaceTransacted":true,
                        "marketplaceTransactionDateTime":"2026-02-11T09:13:52.105Z"
                    },
                    "primaryDeploymentOn":"Partner",
                    "pricingModel":"Other",
                    "value":250000,
                    "currency":"USD"
                }
            ]
        }
    }
]

Пример ответа

HTTP/1.1 204 No Content
Content-Length: 0
Request-ID: 9f8bed52-e4df-4d0c-9ca6-929a187b0731

Связанный контент

• Создать реферал