Llamada a API REST mediante cliente HTTP

IBM Sterling® Order Management System admite autenticación básica y estándar para llamar a las API REST. De forma predeterminada, la autenticación REST se establece en autenticación estándar. Para definir el estilo de autenticación que desea utilizar, realice los pasos siguientes:

  1. Configure las propiedades de estilo de autenticación.
  2. Reinicie los servidores de aplicaciones.
  3. Inicie la API REST configurando el estilo de autenticación HTTP.

Configurar propiedades de estilo de autenticación

De forma predeterminada, servlet.authstyle se establece en STANDARD. IBM recomienda la autenticación estándar en un entorno superior. Puede utilizar el estilo de autenticación como BASIC o STANDARD en función de sus necesidades empresariales.

Configure el xapirest.properties para el tipo de entorno actual. Establezca la propiedad servlet.authstyle en BASIC o STANDARD. En función de su tipo de entorno, puede establecer las propiedades en el archivo customer_overrides.properties del kit de herramientas de desarrollo o mediante el Administrador de gestión del sistema en la instancia en la nube de Sterling™ Order Management System.

Para obtener más información sobre xapirest.properties, consulte xapirest.properties.

Si desea utilizar HTTP REST XAPI Tester para el desarrollo y las pruebas, consulte Configuración de HTTP REST XAPI Tester.

Reiniciar servidores de aplicaciones

Debe reiniciar todos los servidores de aplicaciones cuando cambie el estilo de autenticación.

Para obtener más información, consulte Gestión de procesos de servidor en la plataforma de próxima generación.

Llamar a la API REST configurando el estilo de autenticación HTTP

Autenticación estándar
Para establecer el estilo de autenticación STANDARD, realice los pasos siguientes:
  1. Llame a la API de inicio de sesión a través de REST utilizando la siguiente URL :
    http://<ip-address>:<port>//smcfs/restapi/invoke/login

    Método-POST

    Tipo de soporte- application/json

  2. Proporcione la carga útil para el inicio de sesión:
    {                                                                      
    "LoginID" : "yourUserLogin",                                                  
    "Password" : "UserPassword"                                                
    } 
    La API devuelve los resultados siguientes:
    "UserGroupID": "ItemAdministratorGroup",                              
    "UserToken":                                                            
    "mXffVPKgo9HUoftxg0HsyX3uQQP6o4LmAG3HHnfiVTrtQvx3dyYUX8n6793wggmU15",
    "UserName": "Administrator",
  3. Utilice el UserToken que se genera durante la llamada de inicio de sesión en llamadas posteriores. El usuario incluye _loginid y _token como parámetros de consulta en la URL de la API REST.
    Por ejemplo, para iniciar la API del servidor (GET), utilice la siguiente URL :
    http://localhost:<port>/smcfs/restapi/server?_loginid=admin&_token=mXffVPKgo9HUoftxg0HsyX3uQQP6o4LmAG3HHnfiVTrtQvx3dyYUX8n6793wggmU15
Nota: Debe utilizar el cliente HTTP como Postman para la autenticación STANDARD. El comprobador HTTP REST XAPI sólo admite la autenticación BÁSICA.
Autenticación básica
HTTP REST XAPI tester sólo admite la autenticación BÁSICA. Sin embargo, si desea utilizar su propio cliente HTTP, realice los siguientes pasos: Para configurar el estilo de autenticación BASIC, debe proporcionar una cabecera y debe realizar la siguiente codificación base64 :
  1. Obtenga una señal codificada base64 que conste del nombre de inicio de sesión de usuario y del secreto de usuario. Concatene estos valores utilizando dos puntos. Por ejemplo, si el nombre de usuario es testuser y la contraseña es testsecret, utilizando un codificador base64 , puede ejecutar el mandato siguiente:
    echo -n "testuser:testsecret"|openssl base64
    Resultados:
    dGVzdHVzZXI6dGVzdHNlY3JldA==

    Utilice esta señal como señal básica para la autenticación durante una llamada de API REST.

  2. Llame a la API REST utilizando la señal base64 básica.
    Incluya el siguiente valor en la cabecera de la petición HTTP :
    Authorization: BASIC 
    Por ejemplo:
    curl --location --request GET 'http://localhost:/smcfs/restapi/server'
    --header 'Authorization: Basic dGVzdHVzZXI6dGVzdHNlY3JldA=='
    --header 'Content-Type: application/json'

Para obtener más información sobre cómo llamar al servicio de API REST, consulte Invocación de servicios REST.

Para obtener más información, consulte Seguridad de API.