Considerações sobre a API

Controle de versão da API

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 listadas no de Referência da API do Portal do Cloud Partner 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.

Pode haver várias versões da API disponíveis ao mesmo tempo. Os clientes devem indicar qual versão eles desejam invocar usar fornecendo o parâmetro api-version 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 de API desconhecida ou inválida é um código HTTP 400. Esse 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ê recebe um erro, especialmente um erro de 400 classes, 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 nessa referência, você deve passar o cabeçalho de autorização junto com o token de portador obtido da ID do Microsoft Entra. Esse cabeçalho é necessário para receber uma resposta válida; se não estiver presente, um erro de 401 Unauthorized será retornado.

  GET https://cloudpartner.azure.com/api/offerTypes?api-version=2016-08-01-preview

    Accept: application/json 
    Authorization: Bearer <YOUR_TOKEN>