Compartilhar via


Referência da API do Portal do Cloud Partner

Nota

As APIs do Portal do Cloud Partner são integradas e continuarão trabalhando no Partner Center. A transição apresenta pequenas alterações. Examine as alterações nas APIs do CPP listadas neste documento para garantir que seu código continue funcionando após a transição para o Partner Center. As APIs do 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 Portal do Cloud Partner permitem a recuperação programática e a manipulação de cargas de trabalho, ofertas e perfis de editor. As APIs usam o RBAC (controle de acesso baseado em função) do Azure para impor permissões corretas no momento do processamento.

Essa referência fornece os detalhes técnicos das APIs REST do Portal do Cloud Partner. Os exemplos de conteúdo neste documento são apenas para referência e estão sujeitos a alterações à medida que novas funcionalidades são adicionadas.

Pré-requisitos e considerações

Antes de usar as APIs, você deve examinar:

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

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

de API Alterar descrição de impacto
POST Publish, GoLive, Cancel Para ofertas migradas, o cabeçalho de resposta tem um formato diferente, mas continua funcionando da mesma maneira, indicando 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 Local 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 'notification-email' 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 emails especificados nas solicitações. Em vez disso, o serviço de API se alinha ao processo de email de notificação no Partner Center para enviar emails. Especificamente, as notificações serão enviadas para o endereço de email definido na seção informações de contato do Vendedor de suas configurações de conta no Partner Center, para notificar você sobre o andamento da operação.

Examine o endereço de email definido na seção informações de contato do Vendedor das configurações da conta no Partner Center para garantir que o email correto seja fornecido para notificações.

Tarefas comuns

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

Oferece

Operações

Publicar um aplicativo

Outras tarefas

Solucionando problemas

versões e atualizações da API

Atualização O que mudou?
12-2022 A API pública do CPP (versão 2017-10-31) agora é atualizada para capturar clientId e clientSecret para conector Marketo ao configurar clientes potenciais. Durante a configuração de cliente potencial, você não precisa fornecer o campo serverId daqui para frente. Essa atualização para a API não envolve atualizações de versão ou alterações interruptivas.