Referência da API do Cloud Partner Portal

  • Artigo

Nota

As APIs do Cloud Partner Portal estão integradas e continuarão a funcionar no Partner Center. A transição introduz pequenas alterações. Analise as alterações nas APIs de CPP listadas neste documento para garantir que seu código continue funcionando após a transição para o Partner Center. As APIs de CPP só devem ser usadas para produtos existentes que já estavam integrados antes da transição para o Partner Center; novos produtos devem usar APIs de envio do Partner Center.

As APIs REST do Cloud Partner Portal permitem a recuperação programática e a manipulação de cargas de trabalho, ofertas e perfis de editor. As APIs usam o controle de acesso baseado em função do Azure (Azure RBAC) para impor permissões corretas no momento do processamento.

Esta referência fornece os detalhes técnicos para as APIs REST do Cloud Partner Portal. As amostras de carga útil neste documento são apenas para referência e estão sujeitas a alterações à medida que novas funcionalidades são adicionadas.

Pré-requisitos e considerações

Antes de usar as APIs, você deve revisar:

  • O artigo Pré-requisitos para saber como adicionar uma entidade de serviço à sua conta e obter um token de acesso do Microsoft Entra para autenticação.
  • As duas estratégias de controle de simultaneidade disponíveis para chamar essas APIs.
  • Outras considerações sobre a API, como controle de versão e tratamento de erros.

Alterações nas APIs de CPP após a migração para o Partner Center

API Alterar descrição Impacto
POST Publicar, GoLive, Cancelar Para ofertas migradas, o cabeçalho de resposta tem um formato diferente, mas continua a funcionar da mesma maneira, denotando um caminho relativo para recuperar o status da operação. Ao enviar qualquer uma das solicitações POST correspondentes para uma oferta, o cabeçalho Localização tem um dos dois formatos, dependendo do status de migração da oferta:
  • Ofertas não migradas
    /api/operations/{PublisherId}${offerId}$2$preview?api-version=2017-10-31
  • Ofertas migradas
    /api/publishers/{PublisherId}/offers/{offereId}/operations/408a4835-0000-1000-0000-000000000000?api-version=2017-10-31
Operação GET Para tipos de oferta que anteriormente suportavam o campo 'e-mail de notificação' na resposta, esse campo será preterido e não será mais retornado para ofertas migradas. Para ofertas migradas, não enviaremos mais notificações para a lista de e-mails especificada nas solicitações. Em vez disso, o serviço de API se alinha com o processo de e-mail de notificação no Partner Center para enviar e-mails. Especificamente, as notificações serão enviadas para o endereço de e-mail definido na seção Informações de contato do vendedor das configurações da sua conta no Partner Center, para notificá-lo sobre o progresso da operação.

Revise o endereço de e-mail definido na seção Informações de contato do vendedor das configurações da sua Conta no Partner Center para garantir que o e-mail correto seja fornecido para notificações.

Tarefas comuns

Esta referência detalha APIs para executar as seguintes tarefas comuns.

Ofertas

Operations

Publicar uma aplicação

Outras funções

Resolução de Problemas

Versões e atualizações da API

Atualizar O que mudou?
12-2022 A API pública do CPP (versão 2017-10-31) agora é atualizada para capturar clientId e clientSecret para o conector Marketo durante a configuração de leads de clientes. Durante a configuração do lead, você não precisa fornecer o campo serverId no futuro. Esta atualização para a API não envolve atualizações de versão ou alterações de quebra.