Recuperar o status de validação de um cliente

Um parceiro pode recuperar o status de uma validação do cliente sob demanda.

Pré-requisitos

  • Credenciais estabelecidas conforme descrito na autenticação do Partner Center. Este cenário dá suporte somente à autenticação com credenciais de aplicativo + de usuário.

  • Uma ID do cliente (customer-tenant-id). Se você não souber a ID do cliente, poderá pesquisá-la no Partner Center selecionando o workspace Clientes , o cliente na lista de clientes e, em seguida, Conta. Na página Conta do cliente, procure a ID da Microsoft na seção Informações da Conta do Cliente . A ID da Microsoft é a mesma que a ID do cliente (customer-tenant-id).

C#

Para recuperar o status de validação de um cliente para sua conta, primeiro crie uma enumeração que representa o ValidationType a ser recuperado. Em seguida, chame o método IAggregatePartner.Customers.ById com o identificador do cliente. Em seguida, use a propriedade ValidationStatus para recuperar uma interface IValidationStatus . Por fim, chame GetValidationStatus() ou GetValidationStatusAsync() com a variável de enumeração de tipo de validação como um parâmetro de entrada.

var validationTypeToFetch = ValidationType.Account;
var eduCustomerQualification = partnerOperations.Customers.ById(existingCustomer.Id).ValidationStatus.GetValidationStatus(validationTypeToFetch);

Exemplo: aplicativo de exemplo de console. Project: Classe SdkSamples: GetValidationStatus.cs

Solicitação REST

Sintaxe da solicitação

Método URI
GET {baseURL}/v1/customers/{customer-id}/validationStatus?type=account

Parâmetro do URI

Use o parâmetro de consulta a seguir para especificar o cliente para o qual você está recuperando status de validação.

Nome Type Obrigatório Descrição
{customer-id} guid Y O valor é um CustomerTenantId formatado por GUID que permite especificar um cliente.
tipo string S O tipo de validação status recuperar.

Cabeçalhos de solicitação

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

Resposta REST

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

Campos de resposta

Campo Type Descrição Observações
Type Enumeração Tipo de informações de validação Mesmos dados que o tipo de validação. O tipo de validação retorna a conta como o tipo de resposta.
Status Enumeração Status de validação Status disponíveis: Desconhecido, Subexibição, Permitido, Não Permitido, Não Pronto
Hora da atualização mais recente string hora da última atualização status em UTC

Exemplos de respostas

Status permitido

{
    "type": "account",
    "status": "Allowed",
    "lastUpdateDateTime": "2021-07-14T18:02:00"
}

Em status de revisão

{
    "type": "account",
    "status": "UnderReview",
    "lastUpdateDateTime": "2021-07-14T18:02:00"
}

NotAllowed status

{
    "type": "account",
    "status": "NotAllowed",
    "lastUpdateDateTime": "2021-07-14T18:02:00"
}

Status Desconhecido

{
    "type": "account",
    "status": "Unknown",
    "lastUpdateDateTime": "2021-07-14T18:02:00"
}

Não pronto status

{
    "type": "account",
    "status": "Not Ready",
    "lastUpdateDateTime": "2021-07-14T18:02:00"
}

Erro 404 não encontrado

{
    "code": 600074,
    "message": "Account Status for the customer, {customer-id} was not found.",
    "description": "Account Status for the customer, {customer-id} was not found.",
    "errorName": "AccountStatusNotFound",
    "isRetryable": false,
    "errorMessageExtended": "InternalErrorCode=600074"

Qualificação de compra

As transações do cliente serão bloqueadas quando sua conta tiver qualquer um dos status abaixo:

  • UnderReview
  • NotAllowed
  • Unknown

As transações do cliente não serão bloqueadas quando atenderem às seguintes condições:

  • O cliente tem um status permitido
  • O cliente não tem status de conta