パートナーセンター API を使用して間接リセラーの顧客を作成する

[アーティクル]
03/28/2024

適用対象: パートナーセンター

間接プロバイダーは、間接リセラーの顧客を作成できます。

前提条件

パートナーセンターの認証に関するページで説明している資格情報。このシナリオでは、アプリとユーザーの資格情報を使用した認証のみがサポートされます。
間接リセラーのテナント識別子。
間接リセラーは、間接プロバイダーとのパートナーシップを持っている必要があります。

C#

間接リセラーの新しい顧客を追加するには:

新しい Customer オブジェクトをインスタンス化し、BillingProfile と CompanyProfile をインスタンス化して設定します。必ず、間接リセラー ID を 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
投稿	{baseURL}/v1/customers HTTP/1.1

要求ヘッダー

詳細については、「パートナーセンター REST ヘッダー」を参照してください。

要求本文

次の表は、要求本文の必須プロパティの説明です。

名前	タイプ	Required	説明
BillingProfile	オブジェクト	はい	顧客の課金プロファイル情報。
CompanyProfile	オブジェクト	はい	顧客の会社プロファイル情報。
AssociatedPartnerId	string	はい	間接リセラー ID。ここで指定した ID によって示される間接リセラーは、間接プロバイダーとのパートナーシップを持っている必要があります。または、要求は失敗します。また、AssociatedPartnerId 値が指定されていない場合、顧客は間接リセラーではなく間接プロバイダーの直接の顧客として作成されることに注意してください。
ドメイン	String	はい	顧客のドメイン名 (contoso.onmicrosoft.com など)。
organizationRegistrationNumber	string	はい	顧客の組織登録番号 (特定の国/地域では INN 番号とも呼ばれます)。アルメニア(AM)、アゼルバイジャン(AZ)、ベラルーシ(BY)、ハンガリー(HU)、カザフスタン(KZ)、キルギススタン(KG)、モルドバ(MD)、ロシア(RU)、タジキスタン(TJ)、ウズベキスタン(UZ)、ウクライナ(UA)、インド、ブラジル、南アフリカ、ポーランド、アラブ首長国連邦、サウジアラビア、トゥルキエ、タイ、ベトナム、ミャンマー、イラク、南スーダン、ベネズエラ。他の国/地域にある顧客の会社/組織の場合、これは省略可能なフィールドです。

請求プロファイル

次の表では、新しい顧客を作成するために必要な CustomerBillingProfile リソースの最小必須フィールドについて説明します。

名前	タイプ	Required	説明
メール	string	はい	顧客のメールアドレス。
culture	string	はい	コミュニケーションと通貨のための彼らの好ましい文化、例えば `en-US`. サポートされているカルチャについては、パートナーセンターでサポートされている言語とロケールを参照してください。
言語	string	はい	既定の言語です。 2 文字の言語コード (例: `en` または `fr`) がサポートされています。
company_name	string	はい	登録済みの会社名/組織名。
default_address	住所	はい	顧客の会社/組織の登録済み住所。長さの制限については、Address リソースを参照してください。

会社プロファイル

次の表では、新しい顧客を作成するために必要な CustomerCompanyProfile リソースの最小必須フィールドについて説明します。

名前	タイプ	Required	説明
ドメイン	string	はい	顧客のドメイン名 (contoso.onmicrosoft.com など)。
organizationRegistrationNumber	string	条件によって異なる	顧客の組織登録番号 (特定の国/地域では INN 番号とも呼ばれます)。このフィールドの入力は、顧客の会社/組織が次の国/地域にある場合にのみ必要です。 - アルメニア (AM) - アゼルバイジャン (AZ) - ベラルーシ (BY) - ハンガリー (HU) - カザフスタン (KZ) - Kyrgyzstan (KG) - モルドバ (MD) - ロシア (RU) - タジキスタン (TJ) - ウズベキスタン (UZ) - ウクライナ (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: 0dd197a8-992c-44ca-aeae-21cd83494dce
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 がアーカイブされるようになりました。 SDK リリースは、有用な情報が記載された readme ファイルと一緒に GitHub からダウンロードできます。

パートナーの皆様には、パートナーセンター REST API を引き続き使用することをお勧めします。

REST 応答

成功した場合、応答には新しい顧客の Customer リソースが含まれます。

応答の成功とエラーのコード

応答には、成功または失敗と追加のデバッグ情報を示す HTTP 状態コードが付属しています。このコード、エラーの種類、追加のパラメーターを読み取るには、ネットワークトレースツールを使用します。完全な一覧については、パートナーセンターの REST エラーコードに関する記事を参照してください。

応答の例

HTTP/1.1 201 Created
Content-Length: 1085
Content-Type: application/json; charset=utf-8
MS-CorrelationId: 0dd197a8-992c-44ca-aeae-21cd83494dce
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": "626099fe-17af-4756-9fd0-6a73b7127859",
    "commerceId": "626099fe-17af-4756-9fd0-6a73b7127859",
    "companyProfile": {
        "tenantId": "626099fe-17af-4756-9fd0-6a73b7127859",
        "domain": "WingtipToys678152504.onmicrosoft.com",
        "companyName": "Wingtip Toys",
        "links": {
            "self": {
                "uri": "/customers/626099fe-17af-4756-9fd0-6a73b7127859/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"
    }
}

パートナーセンター API を使用して間接リセラーの顧客を作成する

前提条件

C#

C# の例

REST 要求

要求の構文

要求ヘッダー

要求本文

請求プロファイル

会社プロファイル

GDAP (既定)

要求の例

REST 応答

応答の成功とエラーのコード

応答の例

フィードバック

フィードバック

その他のリソース

パートナー センター API を使用して間接リセラーの顧客を作成する

前提条件

C#

C# の例

REST 要求

要求の構文

要求ヘッダー

要求本文

請求プロファイル

会社プロファイル

GDAP (既定)

要求の例

REST 応答

応答の成功とエラーのコード

応答の例

フィードバック

フィードバック

その他のリソース

パートナーセンター API を使用して間接リセラーの顧客を作成する