Accessing the Partner Onboarding REST APIs and documentation

To use the Partner Onboarding Rest APIs, you must have a valid license for and install Sterling File Gateway. Once you download and install the APIs, you must configure your system to use them.

About this task

To access the Partner Onboarding REST APIs and documentation:

Procedure

  1. Install Sterling File Gateway. You must have Sterling File Gateway installed to access the Partner Onboarding REST APIs.
  2. Create a new system user account (or use an existing account) and give it the APIUser permissions.
    CAUTION:
    The APIUser permission is equivalent to admin and includes the permissions to create, delete, update and read all system configurations within a supported API.
    Note: To use the B2B API property, set the JNDI_URL_PORT property in the b2bapis.properties.in file for JNDI communication between the Liberty server/API JVM and the Noapp JVM.

    The default JNDI_URL_PORT value is 12345. Once you change the JNDI URL port, you must remove the existing Liberty node entry from the OPS_NODE_INFO table.

  3. Run the following command (even if you are running a non-clustered install): 
    startCluster.cmd true 1
    This also enables startup of the Liberty API server.
    Note: The Partner Onboarding REST APIs require a clustered instance, but you can run a non-clustered instance in cluster mode. A true cluster is not required to use the REST APIs, unless you are implementing a high-availability (HA) scenario.
  4. Install the APIs. For more information, see Installing B2B REST APIs.
  5. Obtain the LIBERTY_HTTPS_PORT value from sandbox.cfg. This is typically the base port + 75.
  6. Go to <Host_Name>:<port>/B2BAPIs/svc/doc.
    Where,
    • <Host_Name> is the server address where Sterling File Gateway is installed
    • <port> is the Liberty server port number
    This is a unique IP/Port for each node. Typically, a deployment consists of many nodes that share a common port for all nodes. If you are creating a vertical cluster, every node could have a unique port.
  7. Optional: To make the REST API HA-ready, configure a REST API DNS/VIP address for the B2Bi REST API service and configure your load balancer to spray across the physical IP address and port for each of your Sterling File Gateway nodes.
    The load balancer hosts the received DNS/VIP and routes the requests to the configured destinations:
    • <Host_Name1>:<port1>/B2BAPIs/svc/doc
    • <Host_Name2>:<port2>/B2BAPIs/svc/doc
    • <Host_Name3>:<port3>/B2BAPIs/svc/doc
  8. Log in to Sterling File Gateway as the system user with APIUser permissions. The Web Service Browser: API Reference is displayed.