Llamadas a APIs

Obtención de APIs y documentación

Antes de llamar a las API, obtenga la información de solicitud del proveedor de API, incluidos el nombre de dominio de acceso, el protocolo, el método, la ruta de acceso y los parámetros de solicitud.

Llamada a una API

Esta sección describe solo la configuración de la ruta de acceso de solicitud y los parámetros de autenticación. Para otros parámetros, como el tiempo de espera y SSL, configúrelos según sea necesario. Para evitar pérdidas de servicio debido a parámetros incorrectos, configúrelos haciendo referencia a los estándares de la industria.

1. Establezca la ruta de la solicitud.

   Escenario	Configuración de parámetros de solicitud
   Llamar a una API con un nombre de dominio	Llama a la API mediante el nombre de subdominio asignado al grupo de API o un nombre de dominio enlazado al grupo. No se requiere ninguna configuración adicional.
   Llamar a una API en el grupo DEFAULT con una dirección IP	En la puerta de enlace compartida, llame a una API del grupo DEFAULT con una dirección IP. No se requiere ninguna configuración adicional.
   Llamar a una API en un grupo no-DEFAULT con una dirección IP	Para llamar a las API mediante una dirección IP, asegúrese de que el parámetro app_route se ha establecido en on en la página de pestaña Configuration Parameters de la puerta de enlace dedicada. Para usar una dirección IP para llamar a una API que usa autenticación de aplicaciones en un grupo que no es DEFAULT, Agregue los parámetros de encabezado X-HW-ID y X-HW-APPKEY y establezca los valores de parámetro en la clave y el secreto de una aplicación autorizada para la API o un AppKey y AppSecret de cliente. Para usar una dirección IP para llamar a una API que no use autenticación de aplicación en un grupo que no sea DEFAULT, agregue el host de parámetros de encabezado.

2. Establezca los parámetros de autenticación.

   Modo de autenticación	Configuración de parámetros de solicitud
   App authentication (with a signature)	Use el SDK para firmar solicitudes de API. Para obtener más información, consulta la sección de Llamar a las API a través de la autenticación de la aplicación.
   App authentication (through simple authentication)	Agregue el parámetro de encabezado X-Apig-AppCode y establezca el valor del parámetro en el AppCode obtenido en Obtención de APIs y documentación. Para obtener más información, consulte Primeros pasos.
   App authentication (with app_api_key)	Para habilitar la autenticación app_api_key, asegúrese de que el parámetro app_api_key se ha establecido en on en la página de pestaña Configuration Parameters de la puerta de enlace dedicada. Agregue el parámetro apikey del encabezado o cadena de consulta y establezca el valor del parámetro en la clave o AppKey obtenida en Obtención de APIs y documentación.
   App authentication (with app_secret)	En la página de pestaña Configuration Parameters de una puerta de enlace dedicada, el parámetro app_secret se ha establecido en on para habilitar la autenticación app_secret y app_api_key se ha establecido en off para deshabilitar la autenticación app_api_key. Agrega el parámetro de encabezado X-HW-ID y establece el valor del parámetro en la clave de la aplicación autorizada para la API o el AppKey cliente. Agregue el parámetro de encabezado X-HW-AppKey y establezca el valor del parámetro en el secreto o AppSecret obtenido en Obtención de APIs y documentación.
   App authentication (with app_basic)	Para habilitar la autenticación app_basic, asegúrese de que el parámetro app_basic se ha establecido en on en la página de pestaña Configuration Parameters de la puerta de enlace dedicada. Añada el parámetro de encabezado Authorization y ajuste el valor del parámetro a "Basic + base64 (appkey + : + appsecret)", en el que appkey y appsecret son la clave y el secreto (o AppKey y AppSecret que se obtiene en Obtención de APIs y documentación.
   App authentication (with app_jwt)	Para habilitar la autenticación app_jwt, asegúrese de que el parámetro app_jwt se ha establecido en on en la página de pestaña Configuration Parameters de la puerta de enlace dedicada. Agregue el parámetro de encabezado Timestamp y establezca el valor del parámetro en la marca de tiempo de Unix de la hora actual. Añada el parámetro de cabecera Authorization y ajuste el valor del parámetro a "sha256 (appkey + appsecret + timestamp) ", en el que appkey y appsecret son la clave y secreto (o AppKey y AppSecret) obtenidos en Obtención de APIs y documentación y timestamp es Unix timestamp de la hora actual.
   IAM authentication (with a token)	Obtenga un token de la plataforma en la nube y lleve el token en las solicitudes de autenticación de la API. Para obtener más información, consulte la sección Autenticación de token.
   IAM authentication (with AK/SK)	Use un SDK para firmar solicitudes de API. Para obtener más información, consulte Autenticación de AK/SK.
   Custom authentication	Lleve información de autenticación en los parámetros de solicitud de API para la autenticación.
   None	Llame a las API sin autenticación.