Considerações sobre a API

Versão API

Nota

As APIs do Portal do Parceiro Cloud estão integradas e continuarão a trabalhar no Partner Center. A transição introduz pequenas mudanças. Reveja as alterações listadas no Cloud Partner Portal API Reference para garantir que o seu código continua a funcionar após a transição para o Partner Center. As APIS de CPP só devem ser utilizadas para produtos já integrados antes da transição para o Centro de Parceiros; os novos produtos devem utilizar APIs de submissão do Partner Center.

Pode haver várias versões da API que estão disponíveis ao mesmo tempo. Os clientes devem indicar qual a versão que pretendem invocar, fornecendo o api-version parâmetro como parte da cadeia de consulta.

GET https://cloudpartner.azure.com/api/offerTypes?api-version=2017-10-31

A resposta a um pedido com uma versão API desconhecida ou inválida é um código HTTP 400. Este erro devolve a recolha de versões conhecidas da API no organismo de resposta.

    {
        "error": { 
            "code":"InvalidAPIVersion",
            "message":"Invalid api version. Allowed values are [2016-08-01-preview]"
        }
    }

Erros

A API responde a erros com os respetivos códigos de estado HTTP e, opcionalmente, informações adicionais na resposta serializada como JSON. Quando receber um erro, especialmente um erro de 400 classes, não relemque o pedido antes de corrigir a causa subjacente. Por exemplo, na resposta da amostra acima, fixe o parâmetro da versão API antes de reencamender o pedido.

Cabeçalho de autorização

Para todas as APIs nesta referência, deve passar o cabeçalho de autorização juntamente com o sinal ao portador obtido a partir de Azure Ative Directory (Azure AD). Este cabeçalho é necessário para receber uma resposta válida; se não estiver presente, um 401 Unauthorized erro é devolvido.

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

    Accept: application/json 
    Authorization: Bearer <YOUR_TOKEN>