Referencia de API del Cloud Partner Portal

  • Artículo

Nota:

Las API de Cloud Partner Portal se integran en el Centro de partners y seguirán funcionando en este. La transición presenta pequeños cambios. Revise los cambios de las API de Cloud Partner Portal enumerados en este documento 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.

Las API de REST de Cloud Partner Portal permiten la recuperación y la manipulación mediante programación de las cargas de trabajo, ofertas y perfiles del publicador. Las API usan el control de acceso basado en roles de Azure (RBAC de Azure) para exigir los permisos correctos en tiempo de procesamiento.

Esta referencia proporciona los detalles técnicos de las API de REST de Cloud Partner Portal. Los ejemplos de carga en este documento son solo para referencia y están sujetos a cambios a medida que se agregan nuevas funcionalidades.

Requisitos previos y consideraciones

Antes de usar las API, debe revisar:

  • El artículo Requisitos previos para aprender a agregar una entidad de servicio a su cuenta y obtener un token de acceso de Microsoft Entra para la autenticación.
  • Las dos estrategias de control de simultaneidad disponibles para llamar a estas API.
  • Otras consideraciones de API, como el control de versiones y el control de errores.

Cambios en las API de Cloud Partner Portal después de la migración al Centro de partners

API Descripción del cambio Impacto
POST Publish, GoLive, Cancel En el caso de las ofertas migradas, el encabezado de respuesta tiene un formato diferente, pero sigue funcionando de la misma manera, lo que indica una ruta de acceso relativa para recuperar el estado de la operación. Al enviar cualquiera de las solicitudes POST correspondientes para una oferta, el encabezado Location tiene uno de dos formatos en función del estado de migración de la oferta:
  • Ofertas no migradas
    /api/operations/{PublisherId}${offerId}$2$preview?api-version=2017-10-31
  • Ofertas migradas
    /api/publishers/{PublisherId}/offers/{offereId}/operations/408a4835-0000-1000-0000-000000000000?api-version=2017-10-31
GET Operation En el caso de los tipos de oferta que anteriormente admitían el campo "Dirección de correo electrónico para notificaciones" en la respuesta, este campo quedará en desuso y ya no se devolverá para las ofertas migradas. En el caso de las ofertas migradas, ya no se enviarán notificaciones a la lista de correos electrónicos especificados en las solicitudes. En su lugar, el servicio de API se alinea con el proceso de correo electrónico de notificación en el Centro de partners para enviar correos electrónicos. En concreto, las notificaciones se enviarán a la dirección de correo electrónico establecida en la sección de información de contacto del vendedor de la configuración de la cuenta en el Centro de partners, para notificarle el progreso de la operación.

Revise la dirección de correo electrónico establecida en la sección Información de contacto del vendedor de la configuración de la cuenta en el Centro de partners para asegurarse de que se proporciona el correo electrónico correcto para las notificaciones.

Tareas comunes

Esta referencia ofrece información sobre las API adecuadas para realizar las siguientes tareas comunes.

Ofertas

Operations

Publicar una aplicación

Otras tareas

Solución de problemas

Versiones y actualizaciones de API

Actualizar ¿Qué ha cambiado?
12-2022 La API pública de CPP (versión 2017-10-31) ahora se actualiza para capturar clientId y clientSecret para el conector marketo al configurar clientes potenciales. Durante la configuración del cliente potencial no es necesario proporcionar el campo serverId en el futuro. Esta actualización de la API no implica actualizaciones de versiones ni cambios importantes.