Compartilhar via

Referência de API do Portal do Cloud Partner

  • Artigo

Observação

As APIs do Portal do Cloud Partner são integradas ao Partner Center e continuarão funcionando nele. A transição introduz 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 somente devem ser usadas em produtos existentes que já foram integrados antes da transição para o Partner Center. Os novos produtos devem usar as 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 publicação. As APIs usam o RBAC do Azure (controle de acesso baseado em função do Azure) para impor permissões corretas no tempo de processamento.

Essa referência fornece os detalhes técnicos para as APIs REST do Portal do Cloud Partner. Os exemplos de conteúdo deste 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ê deverá 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 de 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

API Descrição da alteração Impacto
POSTAR publicação, GoLive, cancelar Para ofertas migradas, o cabeçalho de resposta tem um formato diferente, mas continua a funcionar 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 ofertas que anteriormente tinham suporte no campo 'notification-e-mail' na resposta, esse campo será preterido e não retornará mais para as ofertas migradas. Para ofertas migradas, não enviaremos mais notificações para a lista de e-mails 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 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 de suas configurações de conta no Partner Center, para notificá-lo sobre o andamento da operação.

Analise 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 email correto seja fornecido para notificações.

Tarefas comuns

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

Ofertas

Operações

Publicar um aplicativo

Outras tarefas

Solução de problemas

Versões e atualizações da API

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