Obter um cliente por ID

Aplica-se a: Partner Center | Partner Center operado pela 21Vianet | Partner Center for Microsoft Cloud for US Government

Obtém um recurso do Cliente que corresponde a um ID do cliente.

Pré-requisitos

  • Credenciais conforme descrito na autenticação do Partner Center. Este cenário suporta credenciais de aplicativo+usuário ou autenticação somente de aplicativo.

  • Um ID de cliente (customer-tenant-id). Se não souber o ID do cliente, pode procurá-lo no Partner Center. Selecione o espaço de trabalho Clientes na página inicial do Partner Center. Selecione o cliente na lista Cliente e, em seguida, selecione Conta. Na página Conta do cliente, procure a ID da Microsoft na seção Detalhes da Conta do Cliente. A ID da Microsoft é a mesma que a ID do cliente (customer-tenant-id).

Importante

A chamada Get Customer ID API não retornará os seguintes atributos na resposta se o parceiro não tiver acesso DAP no locatário do cliente. Caso contrário, ele retornará todos os atributos listados no exemplo de resposta.

  • EmpresaProfileAddress
  • EmpresaPerfilEmail
  • CustomDomain

Funções GDAP

Você precisará de pelo menos uma das seguintes funções GDAP para chamar Obter uma organização de cliente para CompanyProfileAddress, CompanyProfileEmail e Obter um domínio personalizado de cliente para CustomDomain:

  • Gravador de Diretórios
  • Leitor Global
  • Administrador de Domínio

C#

Para obter um cliente por ID, use sua coleção IAggregatePartner.Customers, chame o método ById() e chame os métodos Get() ou GetAsync().

// IAggregatePartner partnerOperations;
// string customerIdToRetrieve;

Customer customerInfo = partnerOperations.Customers.ById(customerIdToRetrieve).Get();

Exemplo: Aplicativo de teste de console. Projeto: PartnerSDK.FeatureSamples Classe: CustomerInformation.cs

Java

O SDK Java do Partner Center pode ser usado para gerenciar recursos do Partner Center. É um projeto de código aberto mantido pela comunidade de parceiros e não suportado oficialmente pela Microsoft. Você pode obter ajuda da comunidade ou abrir um problema no GitHub se tiver um problema.

Para obter um cliente por ID, use sua função IAggregatePartner.getCustomers, chame a função byId() e, em seguida, chame a função get().

// IAggregatePartner partnerOperations;
// String customerIdToRetrieve;

Customer customerInfo = partnerOperations.getCustomers().byId(customerIdToRetrieve).get();

PowerShell

O módulo PowerShell do Partner Center pode ser usado para gerenciar recursos do Partner Center. É um projeto de código aberto mantido pela comunidade de parceiros e não suportado oficialmente pela Microsoft. Você pode obter ajuda da comunidade ou abrir um problema no GitHub se tiver um problema.

Para obter um cliente por ID, execute o comando Get-PartnerCustomer e especifique o parâmetro CustomerId.

Get-PartnerCustomer -CustomerId '2ca7de6c-c05c-46b5-b689-32e53573a97a'

Pedido REST

Sintaxe da solicitação

Método URI do pedido
GET {baseURL}/v1/customers/{customer-tenant-id} HTTP/1.1

Parâmetro URI

Use o seguinte parâmetro de consulta para um cliente específico.

Nome Type Obrigatório Description
ID do cliente-locatário GUID Y O valor é um ID de cliente-locatário formatado em GUID que permite ao revendedor filtrar os resultados de um determinado cliente que pertence ao revendedor.

Cabeçalhos do pedido

Para obter mais informações, consulte Cabeçalhos REST do Partner Center.

Corpo do pedido

Nenhum.

Exemplo de solicitação

GET https://api.partnercenter.microsoft.com/v1/customers/<customer-tenant-id> HTTP/1.1
Authorization: Bearer <token>
Accept: application/json
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
MS-RequestId: 74ca1db9-df92-41c6-a362-a16433b0542b

Resposta do REST

Se for bem-sucedido, esse método retornará um recurso Customer no corpo da resposta.

Códigos de sucesso e erro de resposta

Cada resposta vem com um código de status HTTP que indica sucesso ou falha e informações adicionais de depuração. Use uma ferramenta de rastreamento de rede para ler esse código, tipo de erro e parâmetros adicionais. Para obter a lista completa, consulte Códigos de erro.

Exemplo de resposta

HTTP/1.1 200 OK
Content-Length: 1530
Content-Type: application/json; charset=utf-8
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
MS-RequestId: 74ca1db9-df92-41c6-a362-a16433b0542b

{
  "id": "aaaabbbb-0000-cccc-1111-dddd2222eeee",
  "commerceId": "99e6a635-48e7-424d-9059-c9db944e3c54",
  "companyProfile": {
    "tenantId": "aaaabbbb-0000-cccc-1111-dddd2222eeee",
    "domain": "abcdefgh1234.onmicrosoft.com",
    "companyName": "1kl as kjk",
    "address": {
      "country": "US",
      "region": "wa",
      "city": "redmond",
      "addressLine1": "1 ms way",
      "postalCode": "98052",
      "phoneNumber": "1234567890"
    },
    "email": "a@a.com",
    "links": {
      "self": {
        "uri": "/customers/aaaabbbb-0000-cccc-1111-dddd2222eeee/profiles/company",
        "method": "GET",
        "headers": []
      }
    },
    "attributes": {
      "objectType": "CustomerCompanyProfile"
    }
  },
  "billingProfile": {
    "id": "eeada110-69d6-4cc9-b093-75feb7ca9d3f",
    "firstName": "d0d89d776d03471c819bf772191ed728",
    "lastName": "kjkAJJAAAAAAAAAAAAAAAAAAAA",
    "email": "a@a.com",
    "culture": "en-US",
    "language": "en",
    "companyName": "1kl as kjkAAAAAAAAAAAAAAAJJJJJJJJJJJAAAAAJJJJJJJJJJJAAJJJJJJJJJJJJJJJJJJJJJJJJJJJJJJJJJAJJJJJAJJAAAAJAJJAAAAAAAAAAAAAAAAAAAA",
    "defaultAddress": {
      "country": "US",
      "city": "redmond",
      "state": "WA",
      "addressLine1": "1 ms way",
      "postalCode": "98052",
      "firstName": "1kl as",
      "lastName": "kjk",
      "phoneNumber": "1234567890"
    },
    "links": {
      "self": {
        "uri": "/customers/aaaabbbb-0000-cccc-1111-dddd2222eeee/profiles/billing",
        "method": "GET",
        "headers": [

        ]
      }
    },
    "attributes": {
      "etag": "-4242348048554929329",
      "objectType": "CustomerBillingProfile"
    }
  },
  "relationshipToPartner": "reseller",
  "allowDelegatedAccess": true,
  "customDomains": [
    "abcdefgh1234.onmicrosoft.com"
  ],
  tags": [
    "TestCustomer",
    "USCustomer"
  ],
  "links": {
    "self": {
      "uri": "/customers/aaaabbbb-0000-cccc-1111-dddd2222eeee",
      "method": "GET",
      "headers": []
    }
  },
  "attributes": {
    "objectType": "Customer"
  }
}