Considerações sobre API

Controle de versão da API

Observação

As APIs do Cloud Partner Portal estão integradas e continuarão funcionando no Partner Center. A transição apresenta pequenas alterações. Revise as alterações listadas na Referência da API do Portal de Parceiros em Nuvem para garantir que seu código continue funcionando após a transição para o Centro de Parceiros. As APIs de CPP devem ser usadas apenas para produtos existentes que já estavam integrados antes da transição para o Partner Center; novos produtos devem usar as APIs de submissão do Partner Center.

Pode haver várias versões da API 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 de API desconhecida ou inválida é um código HTTP 400. Esse erro retorna a coleção de versões conhecidas da API 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 repita a solicitação antes de corrigir a causa subjacente. Por exemplo, no exemplo de resposta 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 da ID do Microsoft Entra. Esse 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>