Chamada de APIs REST usando o cliente HTTP

O IBM Sterling® Order Management System oferece suporte à autenticação básica e padrão para chamar as APIs REST. Por padrão, a autenticação REST é configurada para a autenticação padrão Para definir o estilo de autenticação que você deseja usar, conclua as seguintes etapas:

  1. Configure as propriedades de estilo de autenticação
  2. Reinicie os servidores de aplicativos
  3. Inicie a API REST configurando o estilo de autenticação HTTP.

Configurar propriedades de estilo de autenticação

Por padrão, o servlet.authstyle é configurado como STANDARD A IBM recomenda autenticação padrão em um ambiente superior. É possível usar o estilo de autenticação como BASIC ou STANDARD com base em suas necessidades de negócios

Configure o xapirest.properties para o seu tipo de ambiente atual Configure a propriedade servlet.authstyle como BASIC ou STANDARD Com base no seu tipo de ambiente, você pode definir as propriedades no arquivo customer_overrides.properties no kit de ferramentas de desenvolvimento ou usando o System Management Administrator na instância de nuvem do Sterling™ Order Management System.

Para obter mais informações sobre xapirest.properties, consulte xapirest.properties.

Se você quiser usar o HTTP REST XAPI Tester para desenvolvimento e teste, consulte Configuração do HTTP REST XAPI Tester.

Reiniciar servidores de aplicativos

Você deve reiniciar todos os servidores de aplicativos ao alterar o estilo de autenticação.

Para obter mais informações, consulte Gerenciando processos do servidor na plataforma da próxima geração..

Chame a API REST configurando o estilo de autenticação HTTP

Autenticação padrão
Para configurar o estilo de autenticação STANDARD, execute as seguintes etapas:
  1. Chame a API de login por meio de REST usando o seguinte URL :
    http://<ip-address>:<port>//smcfs/restapi/invoke/login

    Método-POST

    Tipo de mídia- application/json

  2. Forneça a carga útil para o login:
    {                                                                      
    "LoginID" : "yourUserLogin",                                                  
    "Password" : "UserPassword"                                                
    } 
    A API retorna os seguintes resultados:
    "UserGroupID": "ItemAdministratorGroup",                              
    "UserToken":                                                            
    "mXffVPKgo9HUoftxg0HsyX3uQQP6o4LmAG3HHnfiVTrtQvx3dyYUX8n6793wggmU15",
    "UserName": "Administrator",
  3. Use o UserToken gerado durante a chamada de login em chamadas subsequentes. O usuário inclui _loginid e _token como parâmetros de consulta no URL da API REST.
    Por exemplo, para iniciar a API do servidor (GET), use o seguinte URL :
    http://localhost:<port>/smcfs/restapi/server?_loginid=admin&_token=mXffVPKgo9HUoftxg0HsyX3uQQP6o4LmAG3HHnfiVTrtQvx3dyYUX8n6793wggmU15
Observação: Você deve usar o cliente HTTP, como o Postman, para autenticação PADRÃO. O testador HTTP REST XAPI é compatível apenas com a autenticação BASIC.
Autenticação básica
O testador HTTP REST XAPI suporta apenas a autenticação BASIC. No entanto, se você quiser usar seu próprio cliente HTTP, execute as etapas a seguir: Para configurar o estilo de autenticação BASIC, você deve fornecer um cabeçalho e executar a seguinte codificação base64 :
  1. Obtenha um token codificado base64 que consiste no nome de login do usuário e no segredo do usuário. Concatene esses valores usando dois pontos. Por exemplo, se o nome do usuário for testuser e a senha for testsecret, usando um codificador base64 , será possível executar o comando a seguir:
    echo -n "testuser:testsecret"|openssl base64
    Resultados:
    dGVzdHVzZXI6dGVzdHNlY3JldA==

    Use esse token como seu token básico para autenticação durante uma chamada API REST.

  2. Chame a API de REST usando o token base64 básico
    Inclua o seguinte valor no cabeçalho da solicitação HTTP :
    Authorization: BASIC 
    Por exemplo,
    curl --location --request GET 'http://localhost:/smcfs/restapi/server'
    --header 'Authorization: Basic dGVzdHVzZXI6dGVzdHNlY3JldA=='
    --header 'Content-Type: application/json'

Para obter mais informações sobre como chamar o serviço da API REST, consulte Chamando os serviços REST

Para obter mais informações, consulte Segurança da API