Realización de una solicitud de API
Esta sección describe la estructura de una solicitud de API de REST y utiliza la API de IAM para obtener un token de usuario como ejemplo para demostrar cómo llamar a una API. El token obtenido se puede usar entonces para autenticar la llamada de otras API.
Solicitud de URI
Un URI de solicitud tiene el siguiente formato:
{URI-scheme} :// {Endpoint} / {resource-path} ? {query-string}
Aunque se incluye un URI de solicitud en la cabecera de solicitud, la mayoría de los lenguajes de programación o marcos requieren que el URI de solicitud se transmita por separado.
- URI-scheme:
Protocolo utilizado para transmitir solicitudes. Todas las API usan HTTPS.
- Endpoint:
Nombre de dominio o dirección IP del servidor que lleva el servicio REST. El endpoint varía entre los servicios en diferentes regiones. Se puede obtener del Regiones y endpoints.
Por ejemplo, el endpoint de IAM en la región CN-Hong Kong es iam.ap-southeast-1.myhuaweicloud.com.
- resource-path:
Ruta de acceso de una API para realizar una operación especificada. Obtenga la ruta de acceso desde el URI de una API. Por ejemplo, resource-path de la API utilizada para obtener un token de usuario es /v3/auth/tokens.
- query-string:
Parámetro de consulta, que es opcional. Asegúrese de que se incluya un signo de interrogación (?) antes de cada parámetro de consulta que tenga el formato de "Nombre de parámetro=Valor de parámetro". Por ejemplo, ?limit=10 indica que se mostrará un máximo de 10 registros de datos.
Por ejemplo, para obtener un token IAM en la región CN-Hong Kong, obtener el endpoint de IAM (iam.ap-southeast-1.myhuaweicloud.com) para esta región y resource-path (/v3/auth/tokens) en el URI de la API utilizada para obtener un token de usuario. A continuación, construya el URI de la siguiente manera:
https://iam.ap-southeast-1.myhuaweicloud.com/v3/auth/tokens
Para simplificar la visualización de URI en este documento, cada API se proporciona solo con resource-path y un método de solicitud. El URI-scheme de todas las API es HTTPS, y los endpoints de todas las API de la misma región son idénticos.
Métodos de solicitud
El protocolo HTTP define los siguientes métodos de solicitud que se pueden usar para enviar una solicitud al servidor:
- GET: solicita al servidor que devuelva los recursos especificados.
- PUT: solicita al servidor que actualice los recursos especificados.
- POST: solicita al servidor que añada recursos o realice operaciones especiales.
- DELETE: solicita al servidor que elimine los recursos especificados, por ejemplo, un objeto.
- HEAD: igual que GET excepto que el servidor debe devolver solo el encabezado de respuesta.
- PATCH: solicita al servidor que actualice el contenido parcial de un recurso especificado. Si el recurso no existe, se creará un nuevo recurso.
Por ejemplo, en el caso de la API usada para obtener un token de usuario, el método de solicitud es POST. La solicitud es la siguiente:
POST https://iam.ap-southeast-1.myhuaweicloud.com/v3/auth/tokens
Encabezado de la solicitud
También puede agregar campos de encabezado adicionales a una solicitud, como los campos requeridos por un método URI o HTTP especificado. Por ejemplo, para solicitar la información de autenticación, agregue Content-Type, que especifica el tipo de cuerpo de la solicitud.
Los campos de encabezado de solicitud comunes son los siguientes:
- Content-Type: especifica el tipo o formato del cuerpo de la solicitud. Este campo es obligatorio y su valor predeterminado es application/json. Otros valores de este campo se proporcionarán para APIs específicas si los hay.
- X-Auth-Token: especifica un token de usuario solo para la autenticación API basada en tokens. El token de usuario es una respuesta a la API utilizada para obtener un token de usuario. Esta API es la única que no requiere autenticación.
Además de admitir la autenticación basada en tokens, las API también admiten la autenticación mediante ID de clave de acceso/clave de acceso secreta (AK/SK). Durante la autenticación basada en AK/SK, se utiliza un SDK para firmar la solicitud, y los campos de encabezado Authorization (información de firma) y X-Sdk-Date (hora en la que se envía la solicitud) se añaden automáticamente a la solicitud.
Para obtener más información, consulte Autenticación basada en AK/SK.
La API usada para obtener un token de usuario no requiere autenticación. Por lo tanto, solo es necesario agregar el campo Content-Type a las solicitudes para llamar a la API. Un ejemplo de tales solicitudes es el siguiente:
POST https://iam.ap-southeast-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json
Cuerpo de la solicitud
El cuerpo de una solicitud se envía a menudo en un formato estructurado como se especifica en el campo de encabezado Content-Type. El cuerpo de la solicitud transfiere contenido excepto el encabezado de la solicitud.
El cuerpo de la solicitud varía entre las API. Algunas API no requieren el cuerpo de la solicitud, como las API solicitadas mediante los métodos GET y DELETE.
En el caso de la API usada para obtener un token de usuario, los parámetros de solicitud y la descripción de parámetros se pueden obtener a partir de la solicitud de API. A continuación se proporciona una solicitud de ejemplo con un cuerpo incluido. Establecer username en el nombre de un usuario, domainname en el nombre de la cuenta que el usuario pertenece to, ******** a la contraseña de inicio de sesión del usuario, y xxxxxxxxxxxxxxxxxx al nombre del proyecto. Puede obtener más información sobre los proyectos en Regiones y endpoint. Compruebe el valor de la columna Region.
El parámetro scope especifica dónde surte efecto un token. Puede establecer scope para una cuenta o un proyecto en una cuenta. En el siguiente ejemplo, el token solo tiene efecto para los recursos de un proyecto especificado. Para obtener más información sobre esta API, consulte Obtener un token de usuario.
POST https://iam.ap-southeast-1.myhuaweicloud.com/v3/auth/tokens
Content-Type: application/json
{
"auth": {
"identity": {
"methods": [
"password"
],
"password": {
"user": {
"name": "username",
"password": "********",
"domain": {
"name": "domainname"
}
}
}
},
"scope": {
"project": {
"name": "xxxxxxxxxxxxxxxxxx"
}
}
}
}
Si todos los datos necesarios para la solicitud de API están disponibles, puedes enviar la solicitud para llamar a la API a través de curl, Postman o codificación. En la respuesta a la API utilizada para obtener un token de usuario, x-subject-token es el token de usuario deseado. Este token se puede utilizar para autenticar la llamada de otras API.
