使用合作夥伴中心 API 為間接轉銷商建立客戶

文章
03/28/2024

適用於：合作夥伴中心

間接提供者可以建立間接轉銷商的客戶。

必要條件

認證，如合作夥伴中心驗證所述。此案例僅支援使用「應用程式+使用者」認證來進行驗證。
間接轉銷商的租用戶標識碼。
間接轉銷商必須與間接提供者建立合作關係。

C#

若要為間接轉銷商新增新客戶：

具現化新的 Customer 對象，然後具現化並填入 BillingProfile 和 CompanyProfile。 請務必將間接轉銷商標識符指派給 AssociatedPartnerID 屬性。
使用 IAggregatePartner.Customers 屬性來取得客戶集合作業的介面。
呼叫 Create 或 CreateAsync 方法來建立客戶。

C# 範例

// IAggregatePartner partnerOperations;
// var indirectResellerId;
var customerToCreate = new Customer()
{
    CompanyProfile = new CustomerCompanyProfile()
    {
        Domain = string.Format(CultureInfo.InvariantCulture,
            "WingtipToys{0}.{1}",
            new Random().Next(),
            this.Context.Configuration.Scenario.CustomerDomainSuffix)
    },
    BillingProfile = new CustomerBillingProfile()
    {
        Culture = "EN-US",
        Email = "Gena@wingtiptoys.com",
        Language = "En",
        CompanyName = "Wingtip Toys",
        DefaultAddress = new Address()
        {
            FirstName = "Gena",
            LastName = "Soto",
            AddressLine1 = "One Microsoft Way",
            City = "Redmond",
            State = "WA",
            Country = "US",
            PostalCode = "98052",
            PhoneNumber = "4255550101"
        }
    },
    AssociatedPartnerId = indirectResellerId
};

var newCustomer = partnerOperations.Customers.Create(customerToCreate);

範例：控制台測試應用程式。專案：合作夥伴中心 SDK 範例類別:CreateCustomerforIndirectReseller.cs

REST 要求

要求語法

方法	要求 URI
POST	{baseURL}/v1/customers HTTP/1.1

要求標頭

如需詳細資訊，請參閱合作夥伴中心 REST 標頭。

要求本文

下表描述要求本文中的必要屬性。

名稱	類型	必要	描述
BillingProfile	object	Yes	客戶的帳單配置檔資訊。
CompanyProfile	object	Yes	客戶的公司配置文件資訊。
AssociatedPartnerId	string	Yes	間接轉銷商標識碼。此處提供的標識碼所指示的間接轉銷商必須與間接提供者建立合作關係，否則要求將會失敗。另請注意，如果未提供 AssociatedPartnerId 值，則會將客戶建立為間接提供者的直接客戶，而不是間接轉銷商。
網域	String	Yes	客戶的功能變數名稱，例如 contoso.onmicrosoft.com。
organizationRegistrationNumber	string	Yes	客戶的組織註冊號碼（也稱為特定國家/地區的 INN 號碼）。只有位於下列國家和地區的客戶公司/組織需要：亞美尼亞（AM）、亞塞拜然（AZ）、白俄羅斯（BY）、匈牙利（HU）、哈薩克（KZ）、吉爾吉斯斯坦（KG）、摩爾多瓦（MD）、俄羅斯（RU）、塔吉克（TJ）、烏茲別克（UZ）、烏克蘭（UA）、印度、巴西、南非、波蘭、阿拉伯聯合酋長國、沙烏地阿拉伯、圖爾基耶、泰國、越南、緬甸、伊拉克、南蘇丹和委內瑞拉。對於位於其他國家/地區的客戶公司/組織，這是選擇性欄位。

帳單設定檔

下表描述建立新客戶所需的 CustomerBillingProfile 資源所需的最小必要字段。

名稱	類型	必要	描述
電子郵件	string	Yes	客戶的電子郵件地址。
culture	string	Yes	其偏好的通訊和貨幣文化特性，例如 `en-US`。如需支援的文化特性，請參閱合作夥伴中心支援的語言和地區設定。
language	string	Yes	默認語言。支援兩個字元的語言代碼（例如 `en` 或 `fr`）。
company_name	string	Yes	已註冊的公司/組織名稱。
default_address	地址	Yes	客戶公司/組織的註冊位址。如需任何長度限制的資訊，請參閱地址資源。

公司設定檔

下表描述建立新客戶所需的 CustomerCompanyProfile 資源所需的最小必要字段。

名稱	類型	必要	描述
網域	string	Yes	客戶的功能變數名稱，例如 contoso.onmicrosoft.com。
organizationRegistrationNumber	string	視條件而定	客戶的組織註冊號碼（也稱為特定國家/地區的 INN 號碼）。只有在客戶的公司/組織位於下列國家/地區時，才需要完成此字段： - 亞美尼亞（AM） - 亞塞拜然（AZ） - 白俄羅斯（BY） - 匈牙利（HU） - 哈薩克（KZ） - 吉爾吉斯斯坦（公斤） - 摩爾多瓦（MD） - 俄羅斯（RU） - 塔吉克（TJ） - 烏茲別克（烏茲） - 烏克蘭（UA） -印度 -巴西 -南非 -波蘭 -阿拉伯聯合大陸國 -沙烏地阿拉伯 - Türkiye -泰國 -越南 - 緬甸 -伊拉克 - 南蘇丹 -委內瑞拉 -中國對於位於其他國家/地區的客戶公司/組織，這是選擇性欄位。

根據預設，GDAP

名稱	類型	描述
enableGDAPByDefault	bool	布爾值，指出我們是否要默認啟用 GDAP。如果為 true，我們預設會建立 GDAP。如果為 false，我們不會建立 GDAP。請注意，這隻適用於支援 GDAP 的雲端。如果沒有支持，預設會建立 DAP。

要求範例

POST https://api.partnercenter.microsoft.com/v1/customers HTTP/1.1
Authorization: Bearer <token>
MS-RequestId: d628adbe-b7ee-412e-ac55-58f22b4ba2f4
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
X-Locale: en-US
MS-PartnerCenter-Client: Partner Center .NET SDK
Content-Type: application/json
Host: api.partnercenter.microsoft.com
Content-Length: 823
Expect: 100-continue
Connection: Keep-Alive

{
    "enableGDAPByDefault": false,
    "Id": null,
    "CommerceId": null,
    "CompanyProfile": {
        "TenantId": null,
        "Domain": "WingtipToys678152504.onmicrosoft.com",
        "CompanyName": null,
        "Attributes": {
            "ObjectType": "CustomerCompanyProfile"
        }
    },
    "BillingProfile": {
        "Id": null,
        "FirstName": null,
        "LastName": null,
        "Email": "Gena@wingtiptoys.com",
        "Culture": "EN-US",
        "Language": "En",
        "CompanyName": "Wingtip Toys",
        "DefaultAddress": {
            "Country": "US",
            "Region": null,
            "City": "Redmond",
            "State": "WA",
            "AddressLine1": "One Microsoft Way",
            "AddressLine2": null,
            "PostalCode": "98052",
            "FirstName": "Gena",
            "LastName": "Soto",
            "PhoneNumber": "4255550101"
        },
        "Attributes": {
            "ObjectType": "CustomerBillingProfile"
        }
    },
    "RelationshipToPartner": "none",
    "AllowDelegatedAccess": null,
    "UserCredentials": null,
    "CustomDomains": null,
    "AssociatedPartnerId": "484e548c-f5f3-4528-93a9-c16c6373cb59",
    "Attributes": {
        "ObjectType": "Customer"
    }
}

重要

自 2023 年 6 月起，最新的合作夥伴中心 .NET SDK 3.4.0 版現已封存。您可以從 GitHub 下載 SDK 版本，以及包含實用資訊的自述檔。

鼓勵合作夥伴繼續使用合作夥伴中心 REST API。

REST 回應

如果成功，回應會包含新客戶的客戶資源。

回應成功和錯誤碼

回應隨附 HTTP 狀態代碼，指出成功或失敗和其他偵錯資訊。請使用網路追蹤工具來讀取此錯誤碼、錯誤類型和其他參數。如需完整清單，請參閱合作夥伴中心的 REST 錯誤碼。

回應範例

HTTP/1.1 201 Created
Content-Length: 1085
Content-Type: application/json; charset=utf-8
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
MS-RequestId: d628adbe-b7ee-412e-ac55-58f22b4ba2f4
MS-CV: Yy/YaA0gYEmfQyR/.0
MS-ServerId: 030020525
Date: Tue, 06 Jun 2017 23:11:40 GMT

{
    "enableGDAPByDefault": false,
    "id": "aaaabbbb-0000-cccc-1111-dddd2222eeee",
    "commerceId": "aaaabbbb-0000-cccc-1111-dddd2222eeee",
    "companyProfile": {
        "tenantId": "aaaabbbb-0000-cccc-1111-dddd2222eeee",
        "domain": "WingtipToys678152504.onmicrosoft.com",
        "companyName": "Wingtip Toys",
        "links": {
            "self": {
                "uri": "/customers/aaaabbbb-0000-cccc-1111-dddd2222eeee/profiles/company",
                "method": "GET",
                "headers": []
            }
        },
        "attributes": {
            "objectType": "CustomerCompanyProfile"
        }
    },
    "billingProfile": {
        "id": "7079246e-7b62-56ef-7cbd-a819514b54b5",
        "email": "Gena@wingtiptoys.com",
        "culture": "en-US",
        "language": "En",
        "companyName": "Wingtip Toys",
        "defaultAddress": {
            "country": "US",
            "city": "Redmond",
            "state": "WA",
            "addressLine1": "One Microsoft Way",
            "postalCode": "98052",
            "firstName": "Gena",
            "lastName": "Soto",
            "phoneNumber": "4255550101"
        },
        "attributes": {
            "etag": "-8799889149591823008",
            "objectType": "CustomerBillingProfile"
        }
    },
    "relationshipToPartner": "reseller",
    "allowDelegatedAccess": true,
    "userCredentials": {
        "userName": "admin",
        "password": "0Krha*Io"
    },
    "associatedPartnerId": "484e548c-f5f3-4528-93a9-c16c6373cb59",
    "attributes": {
        "objectType": "Customer"
    }
}

分享方式：