Creating an API Suite

  1. Open Infor OS Portal’s navigation menu.
  2. In the Applications, select OS > API Gateway.
  3. Select Available APIs.
  4. Select Import Non-Infor API Suite.
  5. Browse for BirstApiSuite.xml that you downloaded. See Downloading required artifacts and click Open.
  6. Click Edit Details and specify details for Proxy Context = api.
    1. Specify Target Endpoint URL based on your region:
      Region Target Endpoint URL
      APAC1 https://app2103.apac1.birst.com/api
      APAC2 https://app2103.apac2.birst.com/api
      CN https://login.cn1.birst.com/api
      EU https://app2103.eu1.birst.com/api
      KOCH https://koch.bws.birst.com/api
      US https://app2103.bws.birst.com/api

      Pre-prod:

      https://app2102.bws.birst.com/api

      US-E1 https://default.birstapp.prd3.inforcloudsuite.com/api

      Pre-prod:

      https://beta.birstapp.prd3.inforcloudsuite.com/api

    2. Specify this information:
      Target Endpoint Access Key
      Specify the consumer-key that you generated.
      Target Endpoint Secret Key
      Specify the consumer-secret that you generated.
      See Creating OAuth credentials.
  7. Click Next.
  8. Specify details for Proxy Context = api_SMD.
    1. Specify the Target Endpoint URL based on your region.
      Region Target Endpoint URL
      APAC1 https://app2103.apac1.birst.com/api
      APAC2 https://app2103.apac2.birst.com/api
      CN https://login.cn1.birst.com/api
      EU https://app2103.eu1.birst.com/api
      KOCH https://koch.bws.birst.com/api
      US https://app2103.bws.birst.com/api

      Pre-prod:

      https://app2102.bws.birst.com/api

      US-E1 https://default.birstapp.prd3.inforcloudsuite.com/api

      Pre-prod:

      https://beta.birstapp.prd3.inforcloudsuite.com/api

    2. Specify this information:
      Note: For IGS customers, use the same Target Endpoint Access Key and Target Endpoint Secret Key used in #6.
      Target Endpoint Access Key
      Specify the consumer-key that you generated.
      Target Endpoint Secret Key
      Specify the consumer-secret that you generated.
      See Creating OAuth credentials for an SMD User.
  9. Click Save.
  10. Click Import.