Considerações sobre a API
Controlo de versões de API
Nota
As APIs do Cloud Partner Portal estão integradas e continuarão a trabalhar no Partner Center. A transição introduz pequenas alterações. Analise as alterações listadas na Referência da API do Cloud Partner Portal 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.
Pode haver várias versões da API que estão disponíveis ao mesmo tempo. Os clientes devem indicar qual versão desejam invocar usando fornecendo o api-version parâmetro como parte da cadeia de caracteres de consulta.
GET https://cloudpartner.azure.com/api/offerTypes?api-version=2017-10-31
A resposta a uma solicitação com uma versão desconhecida ou inválida da API é um código HTTP 400. Este erro retorna a coleção de versões de API conhecidas no corpo da resposta.
{
"error": {
"code":"InvalidAPIVersion",
"message":"Invalid api version. Allowed values are [2016-08-01-preview]"
}
}
Erros
A API responde a erros com os códigos de status HTTP correspondentes e, opcionalmente, informações adicionais na resposta serializada como JSON. Quando você receber um erro, especialmente um erro de classe 400, não tente novamente a solicitação antes de corrigir a causa subjacente. Por exemplo, na resposta de exemplo acima, corrija o parâmetro de versão da API antes de reenviar a solicitação.
Cabeçalho de autorização
Para todas as APIs nesta referência, você deve passar o cabeçalho de autorização junto com o token de portador obtido do ID do Microsoft Entra. Este cabeçalho é necessário para receber uma resposta válida; Se não estiver presente, um 401 Unauthorized erro será retornado.
GET https://cloudpartner.azure.com/api/offerTypes?api-version=2016-08-01-preview
Accept: application/json
Authorization: Bearer <YOUR_TOKEN>