Compartir vía

Consideraciones de API

  • Artículo

Control de versiones de API

Nota

Las API de Cloud Partner Portal se integran con y seguirán trabajando en el Centro de partners. La transición introduce pequeños cambios. Revise los cambios enumerados en Referencia de la API de Cloud Partner Portal para asegurarse de que el código sigue funcionando después de la transición al Centro de partners. Las API de CPP solo deben usarse para los productos existentes que ya estaban integrados antes de la transición al Centro de partners; los nuevos productos deben usar las API de envío del Centro de partners.

Puede haber varias versiones de la API que están disponibles al mismo tiempo. Los clientes deben indicar qué versión desean invocar el uso proporcionando el parámetro api-version como parte de la cadena de consulta.

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

La respuesta a una solicitud con una versión de API desconocida o no válida es un código HTTP 400. Este error devuelve la colección de versiones de API conocidas en el cuerpo de la respuesta.

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

Errores

La API responde a errores con los códigos de estado HTTP correspondientes y, opcionalmente, información adicional en la respuesta serializada como JSON. Cuando reciba un error, especialmente un error de 400 clases, no vuelva a intentar la solicitud antes de corregir la causa subyacente. Por ejemplo, en la respuesta de ejemplo anterior, corrija el parámetro de versión de la API antes de volver a enviar la solicitud.

Encabezado de autorización

Para todas las API de esta referencia, debe pasar el encabezado de autorización junto con el token de portador obtenido de Microsoft Entra ID. Este encabezado es necesario para recibir una respuesta válida; si no está presente, se devuelve un error de 401 Unauthorized.

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

    Accept: application/json 
    Authorization: Bearer <YOUR_TOKEN>