Share via

Клиенты

  • Статья

В этом разделе

В этом разделе приведены примеры для:

  • Получение торгового посредника, которому предоставлено удостоверение
  • Создание клиента
  • Получение клиента с удостоверением
  • Получение клиента с идентификатором клиента

Примеры

Get a reseller given an identity

Вы можете получить ресурс "Клиенты", который представляет вас, торгового посредника, предоставляя требуемые данные Azure AD. Как только вы получите этот ресурс, сохраните идентификатор клиента (cid-for-reseller), который представляет вас в будущих вызовах API.

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

GET https : //api.cp.microsoft.com/customers/get-by-identity?provider=AAD&type=tenant&tid=d51a0512-02a2-4363-8184-ef4b470568db HTTP/1.1
Accept : application / json
api - version : 2015 - 03 - 31
Authorization : Bearer < SA_Token >
x - ms - correlation - id : 993c6c43 - 03ef - 40c4 - 8f28 - e142ac3b37b4
x - ms - tracking - id : e175e48d - 9e68 - 4534 - a130 - f932a3297020

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

HTTP / 1.1 200 OK
Access - Control - Allow - Methods : GET, POST, PUT
api - version : 2015 - 03 - 31
Cache - Control : no - cache
Date : Sat, 21 Mar 2015 03 : 49 : 29 GMT
Server : Microsoft - IIS / 7.5
Strict - Transport - Security : max - age = 15724800;
includeSubDomains
X - AspNet - Version : 4.0.30319
x - ms - correlation - id : 993c6c43 - 03ef - 40c4 - 8f28 - e142ac3b37b4
x - ms - session - id : 0be47f66 - b168 - 422b - 97e5 - 499ab7884df0
X - Powered - By : ASP.NET
X - Server : BLUOS3OMSORDW01
{
    "id" : "d51a0512-02a2-4363-8184-ef4b470568db",
    "identity" : {
        "provider" : "AAD",
        "type" : "tenant",
        "data" : {
            "tid" : "d51a0512-02a2-4363-8184-ef4b470568db"
        }
    },
    "is_test" : false,
    "links" : {
        "self" : {
            "href" : "customers/d51a0512-02a2-4363-8184-ef4b470568db",
            "method" : "GET"
        },
        "profiles" : {
            "href" : "d51a0512-02a2-4363-8184-ef4b470568db/profiles",
            "method" : "GET"
        },
        "addresses" : {
            "href" : "d51a0512-02a2-4363-8184-ef4b470568db/addresses",
            "method" : "GET"
        }
    },
    "object_type" : "Customer"
}

Create a customer

Вы можете создать клиента, который позволяет вам (торговому посреднику) совершать покупки от его имени. Поскольку клиент является новым, его создание требует дополнительных сведений о торговом посреднике и данные клиента Azure AD.

Данный API создает следующее:

  • Объект клиента Azure AD, который представляет клиента.
  • Ресурс "Клиенты", который представляет группу безопасности торгового посредника в клиенте клиента. Это также ресурс, который возвращается из API. См. также раздел Объекты Azure Active Directory.
  • Соответствующие связи для создания связи торгового посредника и клиента.
  • Имя пользователя и пароль для входа на портал Microsoft Online Services.

Примечание  В случае успешного выполнения этот API возвращает ресурс "Клиенты" клиента. Удостоверение, объект JSON, содержит соответствующие данные о клиенте, только что созданном торговым посредником.

 

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

POST https : //api.cp.microsoft.com/d51a0512-02a2-4363-8184-ef4b470568db/customers/create-reseller-customer HTTP/1.1
Accept : application / json
api - version : 2015 - 03 - 31
Authorization : Bearer < SA_Token >
x - ms - correlation - id : 389da731 - 308e-4074 - bba3 - 62148d273c78
x - ms - tracking - id : 257002e4 - 8481 - 4f15 - a8b1 - 649b927220a9{
    "domain_prefix" : "ZIntPmND",
    "user_name" : "admin",
    "password" : "Password~1",
    "profile" : {
        "email" : "artemise2e@outlook.com",
        "company_name" : "TEST_TEST_Artemis Customer_BUtbsniZ",
        "culture" : "en-US",
        "language" : "en",
        "default_address" : {
            "first_name" : "TEST_TEST_Customer_BUtbsniZ",
            "last_name" : "TEST_TEST_Artemis",
            "address_line1" : "Test Address",
            "city" : "Bellevue",
            "region" : "WA",
            "postal_code" : "98005",
            "country" : "US"
        },
        "type" : "organization"
    }
}

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

HTTP / 1.1 201 Created
Access - Control - Allow - Methods : GET, POST, PUT
api - version : 2015 - 03 - 31
Cache - Control : no - cache
Date : Sat, 21 Mar 2015 03 : 49 : 48 GMT
Server : Microsoft - IIS / 7.5
Strict - Transport - Security : max - age = 15724800;
includeSubDomains
X - AspNet - Version : 4.0.30319
x - ms - correlation - id : 389da731 - 308e-4074 - bba3 - 62148d273c78
x - ms - session - id : 8d9cc5c7 - 0792 - 407f - 95e8 - 210b900800fd
X - Powered - By : ASP.NET
X - Server : BLUOS3OMSORDW01
{
    "domain_prefix" : "ZIntPmND",
    "user_name" : "admin",
    "password" : "Password~1",
    "customer" : {
        "id" : "1bbbe60b-e174-4a4c-8e5a-ed9f09e02010",
        "identity" : {
            "provider" : "AAD",
            "type" : "external_group",
            "data" : {
                "tid" : "9fb7ef00-def5-4516-b735-ec09c6bb5091",
                "etid" : "d51a0512-02a2-4363-8184-ef4b470568db",
                "eoid" : "db95a0ba-386a-433b-9822-f6663970d5e4"
            }
        },
        "is_test" : false,
        "links" : {
            "self" : {
                "href" : "customers/1bbbe60b-e174-4a4c-8e5a-ed9f09e02010",
                "method" : "GET"
            },
            "profiles" : {
                "href" : "1bbbe60b-e174-4a4c-8e5a-ed9f09e02010/profiles",
                "method" : "GET"
            },
            "addresses" : {
                "href" : "1bbbe60b-e174-4a4c-8e5a-ed9f09e02010/addresses",
                "method" : "GET"
            }
        },
        "object_type" : "Customer",
        "contract_version" : "2015-03-31"
    },
    "profile" : {
        "email" : "artemise2e@outlook.com",
        "company_name" : "TEST_TEST_Artemis Customer_BUtbsniZ",
        "language" : "en",
        "customer_id" : "1bbbe60b-e174-4a4c-8e5a-ed9f09e02010",
        "id" : "3ef2096d-f88e-4e9c-980a-5052d592a946",
        "snapshot_id" : "3ef2096d-f88e-4e9c-980a-5052d592a946/1",
        "type" : "organization",
        "default_address" : {
            "id" : "b79095f9-687a-4135-8b12-4327318443db",
            "country" : "US",
            "region" : "WA",
            "city" : "Bellevue",
            "address_line1" : "Test Address",
            "address_line3" : "",
            "postal_code" : "98005",
            "first_name" : "TEST_TEST_Customer_BUtbsniZ",
            "last_name" : "TEST_TEST_Artemis",
            "links" : {
                "self" : {
                    "href" : "1bbbe60b-e174-4a4c-8e5a-ed9f09e02010/addresses/b79095f9-687a-4135-8b12-4327318443db",
                    "method" : "GET"
                }
            },
            "object_type" : "Address",
            "contract_version" : "2015-03-31"
        },
        "culture" : "en-US",
        "etag" : "6843250809631227590",
        "links" : {
            "self" : {
                "href" : "1bbbe60b-e174-4a4c-8e5a-ed9f09e02010/profiles/3ef2096d-f88e-4e9c-980a-5052d592a946",
                "method" : "GET"
            },
            "snapshot" : {
                "href" : "1bbbe60b-e174-4a4c-8e5a-ed9f09e02010/profiles/3ef2096d-f88e-4e9c-980a-5052d592a946/1",
                "method" : "GET"
            },
            "update" : {
                "href" : "1bbbe60b-e174-4a4c-8e5a-ed9f09e02010/profiles/3ef2096d-f88e-4e9c-980a-5052d592a946",
                "method" : "PUT"
            }
        },
        "object_type" : "OrganizationProfile"
    }
}

Get a customer given an identity

Вы можете получить ресурс "Клиенты", который представляет клиента с соответствующими данными Azure AD. В API CREST информация Azure AD определяет группу безопасности для торгового посредника в клиенте заказчика. См. раздел Объекты Azure Active Directory в части группы безопасности.

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

Требуется идентификатор x-ms-tracking-id.

GET https : //api.cp.microsoft.com/customers/get-by-identity?provider=AAD&type=external_group&tid=9fb7ef00-def5-4516-b735-ec09c6bb5091&etid=d51a0512-02a2-4363-8184-ef4b470568db HTTP/1.1
Accept : application / json
api - version : 2015 - 03 - 31
Authorization : Bearer < SA_Token >
x - ms - correlation - id : ac81d093 - 9a0b - 4da1 - 94dd - 20b616245351
x - ms - tracking - id : 47385b81 - cb88 - 4673 - aa6f - 4ea72ef29387

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

{
    "id" : "1bbbe60b-e174-4a4c-8e5a-ed9f09e02010",
    "identity" : {
        "provider" : "AAD",
        "type" : "external_group",
        "data" : {
            "tid" : "9fb7ef00-def5-4516-b735-ec09c6bb5091",
            "etid" : "d51a0512-02a2-4363-8184-ef4b470568db",
            "eoid" : "db95a0ba-386a-433b-9822-f6663970d5e4"
        }
    },
    "is_test" : false,
    "links" : {
        "self" : {
            "href" : "customers/1bbbe60b-e174-4a4c-8e5a-ed9f09e02010",
            "method" : "GET"
        },
        "profiles" : {
            "href" : "1bbbe60b-e174-4a4c-8e5a-ed9f09e02010/profiles",
            "method" : "GET"
        },
        "addresses" : {
            "href" : "1bbbe60b-e174-4a4c-8e5a-ed9f09e02010/addresses",
            "method" : "GET"
        }
    },
    "object_type" : "Customer"
}

Get a customer given a customer ID

Если вы сохраните идентификатор клиента при его создании, то сможете получить ресурс "Клиенты" с помощью этого идентификатора. Часто это быстрее, чем получение ресурса "Клиенты" с помощью вызова GET /customers/get-by-identity.

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

GET https : //api.cp.microsoft.com/customers/1bbbe60b-e174-4a4c-8e5a-ed9f09e02010 HTTP/1.1
Accept : application / json
api - version : 2015 - 03 - 31
Authorization : Bearer < SA_Token >
x - ms - correlation - id : a4ada730 - 6576 - 4b91 - b5e4 - 62456ab6ec92
x - ms - tracking - id : 686e4f2e - 5772 - 428b - ba2f - 826790c16218

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

{
    "id" : "1bbbe60b-e174-4a4c-8e5a-ed9f09e02010",
    "identity" : {
        "provider" : "AAD",
        "type" : "External_Group",
        "data" : {
            "tid" : "9fb7ef00-def5-4516-b735-ec09c6bb5091",
            "etid" : "d51a0512-02a2-4363-8184-ef4b470568db",
            "eoid" : "db95a0ba-386a-433b-9822-f6663970d5e4"
        }
    },
    "is_test" : false,
    "links" : {
        "self" : {
            "href" : "customers/1bbbe60b-e174-4a4c-8e5a-ed9f09e02010",
            "method" : "GET"
        },
        "profiles" : {
            "href" : "1bbbe60b-e174-4a4c-8e5a-ed9f09e02010/profiles",
            "method" : "GET"
        },
        "addresses" : {
            "href" : "1bbbe60b-e174-4a4c-8e5a-ed9f09e02010/addresses",
            "method" : "GET"
        }
    },
    "object_type" : "Customer"
}