Introdução à API de Conteúdo

Para utilizar a API de Conteúdo, precisará de algumas coisas:

  1. Uma conta Microsoft
  2. Uma conta do Microsoft Advertising
  3. Um token de programador

Para obter uma conta do Microsoft Advertising, aceda a https://ads.microsoft.com. Se não tiver sessão iniciada na sua conta Microsoft, será redirecionado para iniciar sessão na sua conta ou para se inscrever numa. Depois de iniciar sessão, terá a opção de Se inscrever numa nova conta do Microsoft Advertising. Selecione a opção de inscrição e clique em Continuar.

Em seguida, se ainda não tiver um token de programador do Microsoft Advertising para o ambiente de produção, aceda ao Portal do Programador. Clique em Token de Pedido e forneça as informações pedidas. Se utilizar a API para gerir a sua própria conta, receberá imediatamente o seu token; no entanto, se estiver a gerir contas para outras pessoas, poderá demorar até cinco dias úteis para obter um token.

Autenticar as suas credenciais

Importante

A partir de 1 de junho de 2022, iremos precisar da autenticação multifator para todos os utilizadores que iniciem sessão através de uma aplicação de terceiros que utilize a API de Anúncios do Bing, a API de Conteúdo e as APIs de Hotel.

Tem de atualizar a aplicação para obter o consentimento do utilizador através do novo msads.manage âmbito. Todos os programadores de aplicações têm de tomar medidas para utilizar o novo âmbito.

Para obter mais informações, veja o Guia de requisitos de autenticação multifator .

A API de Conteúdo utiliza os mesmos esquemas de autenticação que a API de Anúncios do Bing. Para obter detalhes sobre como autenticar as credenciais da conta Microsoft com o OAuth, consulte Autenticação com o plataforma de identidades da Microsoft.

Pode utilizar o SDK de Anúncios do Bing para .NET, Java ou Python para autenticar as credenciais da conta Microsoft. Para obter detalhes sobre como utilizar o SDK para obter o token de acesso, veja C# | Java | Python. Para obter um exemplo da API de Conteúdo que utiliza o SDK para autenticação, veja Exemplo de gestão de produtos.

(Tenha em atenção que o SDK de Anúncios do Bing não fornece interfaces para a API de Conteúdo. Só deve utilizar o SDK para obter o token de acesso se também estiver a utilizar o SDK para campanhas do Microsoft Advertising. Caso contrário, poderá não valer a pena a sobrecarga da instalação do SDK.)

Se não utilizar o SDK de Anúncios do Bing para autenticação, veja Authenticating Microsoft Account Credentials in C# (Autenticar Credenciais da Conta Microsoft em C# ) para obter um exemplo que mostra como utilizar o OAuth para autenticar as credenciais da conta Microsoft.

Onde utilizar as suas credenciais e tokens de programador?

Todas as chamadas têm de especificar:

  • O cabeçalho DeveloperToken definido para o token de programador.
  • O cabeçalho AuthenticationToken definido como o token de acesso.

Se gerir catálogos em nome de outros clientes, também tem de definir os seguintes cabeçalhos:

  • O cabeçalho CustomerId definido para o ID de cliente do cliente cuja loja está a gerir
  • O cabeçalho CustomerAccountId que está definido para o ID de conta de qualquer uma das contas do cliente que gere (não importa qual a conta gerida).

Para obter informações sobre estes e outros cabeçalhos que o pedido e a resposta podem conter, consulte Cabeçalhos.

Configurar o Centro de Comerciantes da Microsoft para utilizar a API

Para obter uma descrição geral do Microsoft Merchant Center (MMC), consulte O que é o Centro de Comerciantes da Microsoft? O tópico inclui ligações para todos os tópicos do Centro de Comerciantes e vídeos relacionados.

Se ainda não o tiver feito, tem de concluir os seguintes passos.

  1. Verificar e reclamar o URL do Seu Site Para obter as ferramentas webmaster mencionadas em Verificar e reclamar o URL do seu Site, consulte Ferramentas do Bing Webmaster. Inicie sessão com a mesma conta Microsoft que utiliza para o Microsoft Advertising. Para obter mais informações sobre como utilizar a ferramenta, consulte Verificar a Propriedade do Seu Site.
  2. Criar uma loja do Centro de Comerciantes da Microsoft
  3. Adicionar um catálogo

Quando cria um arquivo MMC, o processo cria um catálogo predefinido para si. A loja e todos os catálogos que criar são ativados automaticamente para a gestão de API. O arquivo contém um catálogo predefinido ao qual todas as operações de produtos (adicionar, atualizar, eliminar e obter) se aplicam por predefinição. Para especificar um catálogo diferente, utilize o parâmetro de consulta bmc-catalog-id no URL do recurso.

Para adicionar e ativar catálogos, utilize o recurso Catálogos . Para obter mais informações, veja Gerir os Catálogos.

Nota

Em determinadas circunstâncias, pode utilizar a API e o FTP/SFTP para atualizar um feed de catálogo. Para obter informações sobre como utilizar a API com FTP/SFTP, consulte Posso Utilizar a API e FTP/SFTP?

Passos Seguintes

Agora que está pronto para começar a utilizar a API, veja as secções seguintes.