API REST de administración directa API Management

  • Artículo

Azure API Management proporciona una API REST de administración directa para realizar operaciones en entidades seleccionadas, como usuarios, grupos, productos y suscripciones. La API de administración directa puede omitir ciertos límites de la API basada en Azure Resource Manager, como la limitación de solicitudes.

Importante

En esta sección se describe cómo acceder a la administración directa API Management API REST. Esta API tiene un mecanismo de autenticación diferente al de Azure Resource Manager y usa una dirección URL base diferente.

Habilitación del acceso a la API rest de administración directa

Se debe conceder acceso a la administración directa API Management API rest antes de que se puedan realizar correctamente las llamadas.

  1. Navegue a la instancia de Azure API Management en Azure Portal.

  2. Seleccione Api de administración en la sección Implementación e infraestructura del menú de la izquierda.

    Seleccione Api de administración en el Azure Portal

  3. En Habilitar API Management API REST, seleccione Sí.

    Importante

    Si no se selecciona Habilitar API Management API REST, se producirá un error en las llamadas realizadas a la API REST para esa instancia de servicio.

    Habilitación de la API de API Management en el Azure Portal

Tipo de medio predeterminado

El tipo de medio predeterminado para las solicitudes y respuestas es application/json. Cuando así se indica, algunas operaciones admiten otros tipos de contenido. Si no se menciona contenido adicional para una operación específica, el tipo de medio es application/json.

Authentication

Cada solicitud a la API rest de API Management debe ir acompañada de un Authorization encabezado que contenga un token de acceso compartido válido, como se muestra en el ejemplo siguiente.

Authorization: SharedAccessSignature uid=53dd860e1b72ff0467030003&ex=2014-08-04T22:03:00.0000000Z&sn=ItH6scUyCazNKHULKA0Yv6T+Skk4bdVmLqcPPPdWoxl2n1+rVbhKlplFrqjkoUFRr0og4wjeDz4yfThC82OjfQ==

Este token de acceso se puede generar mediante programación o desde el portal para desarrolladores de API Management. Para obtener instrucciones sobre cómo generar y recuperar el token de acceso, consulte Para crear manualmente un token de acceso y Para crear un token de acceso mediante programación.

URL base

La dirección URL base de la administración directa API Management API REST se ajusta a la plantilla siguiente.

https://{servicename}.management.azure-api.net

Esta plantilla contiene el parámetro siguiente.

  • {serviceName} es el nombre de servicio que se especificó al crear el servicio, por ejemplo https://contosoapi.management.azure-api.net.

Todas las direcciones URL devueltas por la API rest de API Management son relativas a esta dirección URL base y todas las solicitudes a la API REST deben usar esta plantilla de dirección URL base.

Parámetro de consulta de versión

En todas las operaciones se espera un parámetro de consulta de api-version con un valor que tenga el formato YYYY-MM-DD, por ejemplo 2021-08-01.

Nota:

Durante un período de versión preliminar de una API REST de API Management, -preview se anexa al parámetro de consulta de versión, por ejemplo 2021-04-01-preview.

Si este parámetro de consulta no se pasa en la cadena de consulta de una solicitud, el servidor devolverá un código de estado de 400 Bad Request. Para obtener una lista de las versiones admitidas, consulte API Management referencia de la API REST.

Pasos siguientes