B2B REST APIs available in Sterling B2B Integrator
Each REST resource contains information such as URIs, descriptions, and sample input and output data.
The B2B REST API documentation contains a list of resources that are provided by the B2B REST APIs. You must have a valid license for Sterling B2B Integrator to access the B2B REST APIs.
- Authorization - Type of authorization. Only basic authorization is supported.
- Content-type - Type of the content. Example: Application/JSON, Application/XML.
- Accept - Type of request accepted. Example: Application/JSON, Application/XML.
- Sorting of the API results depends on the MSSQL database settings, whether it is configured as case sensitive or case insensitive.
- Some of the APIs do not function as expected and exceptions are seen in the log files. These
APIs have a dependency on the property
security.passphrase
.Error Stacktrace:
Workaround: Addjava.security.UnrecoverableKeyException
: The private key cannot be retrieved. The system passphrase is incorrect.security.passphrase=password
in thecustomer_overrides.properties
file and restart Sterling B2B Integrator. - Each API can support different parameter formats for their respective calls. As an example, some APIs support XML, others support JSON, while some support both.
B2B REST API | Description |
---|---|
AS2 Organization Services | Services to create, read, update, and delete the AS2 organization profiles. The ReadIdentity Services API is used to retrieve the existing identity names, which is required while creating (POST) AS2Organization profiles. |
AS2 TradingPartner Services | Services to create, read, update, and delete the AS2 Trading Partner profiles. The ReadIdentity Services API is used to retrieve the existing identity names, which is required while creating (POST) AS2TradingPartner profiles. The ReadHTTPClientAdapter Services API is used to retrieve the HTTPClientAdapter value, which is required for creating (POST) and updating(PUT) AS2TradingPartner profiles. Note:
|
AS2 TradingRelationship Services | Services to create, read, update, and delete the AS2 TradingRelationship profiles. The API also supports storing AS2 messages in Global Mailbox in addition to file system and mailbox. |
CodeList Services | Services to create, read, update, and delete Trading Partner code lists stored in the Sterling B2B Integrator database. |
CodeListCode Services | Services to create, read, update, and delete the codes in the code list. |
Community Services | Services to create, read, update, and delete Communities in Sterling File Gateway. Community services support
custom protocols in addition to the ones preconfigured in Sterling File Gateway.
Note: Ensure that the custom
protocol names you specify are valid and are available in your AFTExtension xml file.
|
Custom Protocols | Service to read custom protocols available in the system. |
Custom Sterling File Gateway Extensions Services (Custom Protocols) |
Services to read and update Sterling File Gateway extensions (Custom Protocols)
in Sterling B2B Integrator. The system creates two entries for Sterling File Gateway extensions of type custom protocol during factory setup. One of the entry corresponds to AFTExtensions.xml and AFTProperties.properties file and other entry to AFTExtensionsCustomer.xml and AFTExtensionsCustomer.properties files. The Read API retrieves the contents of the AFTExtensions.xml and AFTProperties.properties and AFTExtensionsCustomer.xml and AFTExtensionsCustomer.properties files. The Update API allows you to specify the Sterling File Gateway extensions like custom protocols and properties. When you update the content using the Update API, the system updates the AFTExtensionsCustomer.xml and AFTExtensionsCustomer.properties files, but does not allow you to modify the content of the AFTExtensions.xml and AFTProperties.properties files. The corresponding validation messages are displayed. |
CustomJar Services | Services to create, read, update, and delete custom jar files that can be deployed in a Sterling B2B Integrator environment. You can upload
and deploy the third party jar files on specific nodes using the APIs. Note:
|
CustomService Services | Services to create, read, update, and delete custom services that can be deployed in a Sterling B2B Integrator environment. Note:
|
Document Services | Services to create, read, update, and delete documents in Sterling B2B Integrator that contain payloads of
messages. In addition to the create, read, update, and delete services, action is provided to append
more data to the body of an existing document and to export data from a document into the storage
subsystem. Note: If you are using Microsoft SQL server database with Sterling B2B Integrator, the document ID that is
returned by the Document Services API is HTTP URL encoded and the colon (:) character in document ID
is replaced with “%3A”.
GetPayload API: Used to export data from a document into the
storage subsystem.
Note: Sample URL:
https://<IP_ADDRESS>:<PORT>/B2BAPIs/getPayloadData/<Document_Id>?isPlainText=false .
While executing the HTTP/HTTPS URL, you need to pass an authorization header that contains the login credentials of B2B APIs. Else, you cannot download the payload document. You can invoke the HTTP URL using custom client code or the CURL tool. For HTTPS, make sure to load the correct SSL certificates. The payload document is downloaded directly to the local file system. |
File Gateway Arrived File Services | Services to read, replay, and redeliver the files that arrive into Sterling File Gateway. Using
the ReadFGArrivedFile API, you can also search the FG arrived files based on document
IDs. Redeliver FGArrived File API: Used to redeliver the files that arrive into Sterling File Gateway. When
the file is redelivered through this API, some of the events listed below are not generated.
However, the redeliver operation is successful.
|
File Gateway Delivery Services | Service to read the Sterling File Gateway
delivery details of the file. ReadFgDeliveryDetails API - Used to read the FGDelivery file
details.
Note: This API lists the details pertaining to File Gateway delivery and does not list any
details related to File Gateway events.
|
File Gateway Route Services | Service to read the Sterling File Gateway route details. |
Mailbox Services | Services to create, read, update, and delete Mailboxes in Sterling B2B Integrator. Shared and linked
mailboxes are supported if the functionality is enabled in Sterling B2B Integrator. Create Mailbox service also supports specifying users and groups that have permissions on the mailbox. |
Mailbox Content Services | Services to read the contents of mailboxes. |
Mailbox Message Services | Services to create, read, update, and delete messages in a mailbox. Along with the create,
read, update, and delete services, a service is provided to create multiple messages in a mailbox
upon receiving a request with the Content-Type header set to "multipart/form-data." Additionally,
actions are provided to:
|
Message Batch Services | Services to read the details of the messages of a specific Mailbox in a batch and to perform batch upload of messages to a Mailbox. |
Partner Group Services | Services to create, read, update, and delete partner groups. |
PropertyFile Services | Services to create, read, update, and delete custom property files when Sterling B2B Integrator is installed using the Docker image. |
PropertyNodeValue Services | Services to create, read, update, and delete custom property values for specific Sterling B2B Integrator nodes. |
PGPKey Services | Services to create, read, and delete PGP Keys from Sterling B2B Integrator. These APIs are developed using SpringBoot framework and are available on Swagger docs. Default URL -
Secret Key APIs:
Secret Key GET API with KEYID and ObjectID gets the actual Secret Key data. Public Key APIs:
Public Key GET API with KEYID and ObjectID gets the actual Public Key data. |
PGP Server Profile Services | Services to create, read, update, and delete PGP Server Profiles. These APIs are developed using SpringBoot framework and are available on Swagger docs. Default URL -
|
Routing Channel Services | Services to create, read, and delete Routing Channels. |
Routing Channel Duplicate Check Services | Service to read Routing Channel Duplicate Checks. |
Routing Channel Template Services | Services to create, read, update, and delete Routing Channel Templates. These APIs are developed using SpringBoot framework and are available on Swagger docs. Default URL -
http://<Install_Host>:<Liberty_port>/sfgapis/swagger-ui.html .Note: In the
Routing Channel Template, you can select how special characters in the
producer filename must be handled. The Special Characters tab has 6 options
that can be selected when creating a Routing Channel Template.
In the XML
request, you can add the following as parameter values for the
ProducerFilenameCleaning
parameter:
In
the JSON request, you can add the following as parameter values for the
ProducerFilenameCleaning
parameter:
|
Routing Rule Services | Services to create, read, update, and delete routing rules in Sterling B2B Integrator. In addition to the create, read, update, and delete services, an action is provided to manually evaluate a Routing Rule. |
Service Instance Services | Services to create, read, update, and delete service instances. You can create instances of
the following Adapters and its related services using the create service instance API:
The READ call for the Service Instance API returns the status of the adapter instance in
binary. The READ call returns Note: When using the CreateServiceInstance API, if under Request &
Response you select application/xml for
Accept and Content-Type, the XML object data that you
pass for instParms must not contain any newline characters or carriage returns and special
characters that are not part of the XML character set.
|
Schedule Services | Services to create, read, update, and delete the schedules. Note:
The following is the error trace for the above mentioned errors:
Workaround: Add
|
SSH Host Identity Key Grabber Services | The ReadSSHHostIdentityKeyGrabber API is used to fetch the host identity
key based on hostname and port number. |
TestSFGDeliveryStatus Services | Service to route the file to the FTP server of the listening consumers and return the
delivery status of file. Note:
|
Trading Partner Services |
|
UI Branding Services | Services to read and update Sterling B2B Integrator UI Branding elements. |
User Account Services | Services to create, read, update, and delete Sterling B2B Integrator user accounts. Note: When
the userAccount.defaultReadFullDetail property in the
/<install_dir>/properties/b2biAPIs.properties file is set to
false :
|
UserExit Services | Services to create, read, update, and delete user exit files. |
Virtual Root Services | Services to create, read, and delete virtual root mailboxes. The virtual root is the first level of the directory path for a user when they are navigating the mailbox navigation pane. |
Workflow Services |
Services to create, read, update, and delete business processes and actions to change the default version of the workflow and enable or disable the workflow. Note: Keep the following points in mind when working with the Workflow API:
|
Workflow Monitor Services | Services to read, restart, and terminate workflow monitors. Note: Keep the following points
in mind when working with the Workflow Monitor API:
|