Considerações sobre API

Controle de versão de API

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 listadas na API do Portal do Cloud Partner para garantir que seu código continue funcionando após a transição para o Cloud Partner. 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.

Pode haver várias versões da API disponíveis ao mesmo tempo. Os clientes devem indicar qual versão querem chamar usando 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]"
        }
    }

Errors

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 a solicitação novamente 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 Microsoft Entra ID. Esse cabeçalho é necessário para receber uma resposta válida e, se não estiver presente, um erro 401 Unauthorized será retornado.

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

    Accept: application/json 
    Authorization: Bearer <YOUR_TOKEN>