IBM API Hub
IBM Sterling Intelligent Promising APIs

By IBM Sterling Intelligent Promising

IBM Sterling Intelligent Promising is a stand-alone cloud service solution that provides reliable inventory promises at every stage of a shopper's order lifecycle.


API Token Generation

Gather Required Information

To access IBM Sterling Intelligent Promising APIs, you will first need to generate an authorization bearer token for authorized access to the APIs for your tenant via the OAuth 2.0 client_credentials flow. To do this you will need the following details:

VariableNameDescription
urlSIP URLhttps://api.watsoncommerce.ibm.com
serviceSIP ServiceThe SIP service being accessed identified by the root path in the url. For example: promising or cas
tenantIdTenant IDYour tenant id provided during on-boarding
clientIdClient IDYour client id provided during on-boarding
clientSecretClient SecretYour client secret provided during on-boarding

Retrieve A Token

These details above can be provided to SIP to generate a token for usage on further API calls as follows:

  1. Calculate Base64(clientId:clientSecret) as variable base64Credentials

  2. Request the server generate a token via a POST API call

    curl --request POST --url {url}/{service}/{tenantId}/v1/oauth2/token \ 
        --header 'Authorization: Basic {base64Credentials}'  \
        --header 'Accept: application/json' \
        --header 'Content-Type: application/x-www-form-urlencoded'  \
        --data 'grant_type=client_credentials'
    
  3. Read the access_token from the response received from during step 2. Json Response Object Format: | Json Field | Description | Value | | ----------- | ------------- | ----------- | | token_type | The type of access_token. | AlwaysBearer | | access_token | The access token for authorized access to APIs | {Generated} | | expires_in | The duration in seconds for which the access_token will be authorized. | Always 43200 |

Use A Token

When making calls to Sterling Intelligent Promising APIs, Include the retrieved access_token in the Authorization header as Authorization: Bearer {access_token}

  • Ensure the token being passed on API invocations was generated for the same service as is being invoked.
  • Avoid generating tokens on each call because doing so will negatively impact your throughput and response times. It is recommended to automatically regenerate the active token at some fixed interval such as every 11 hours, or when a 401 Unauthorized or 403 Forbidden response is encountered.

Open API Specification

About specification
API Version

2025.02.04.1

Legend
Products & Services
Architectures & Deployment models
Industries
Company information
Company logoIBM Inventory Visibility