Sterling B2B Integrator REST API services list with examples

Sterling B2B Integrator REST API services list as of version 5263_8. With some code examples.

CRUD stands for Create, Read, Update,Delete .

• CA Digital Certificate Services : CRUD CA digital certificates.
• CodeList Services : CRUD codelists. Create Example at the end of this post.
• CodeListCode Services: CRUD codes in a code list
• Community Services: CRUD communities. Example here.
• CustomProtocol Services: Reading custom protocols.
• Digital Certificate Duplicate Check Services: Digital Certificate Duplicate Checks.
• Document Services: Create, Read, Append and Delete Documents and getpayload. Example here.
• External User Services: CRUD external users.
• FgArrivedFile Services: Read, Update and Replay arrived files in SFG.
• FgRoute Services: reading FGRoute details of File Gateway.
• Generated Password Services: Service for reading generated passwords.
• JDBC Service Tracking Services: Reading JDBC tracking services.
• Mailbox Services: CRUD mailboxes.
• Mailbox Content Services: Reading mailbox contents. Example here.
• Mailbox Message Services: CRUD, Extract and Move mailbox messages.
• Message Batch Services: read and Create message batches. Example here.
• Partner Group Services: CRUD partner group
• Permission Services: CRUD permissions.
• PGPKey Services: Read, Create and Delete PGP keys.
• PGP Server Profile Services: CRUD PGP server profiles.
• Routing Channel Services: Create, Read and Delete SFG routing channels.
• Routing Channel Duplicate Check Services: Routing Channel Duplicate Checks.
• Routing Rule Services: CRUD routing rules.
• Schedule Services: CRUD B2B Integrator Schedules.
• ServiceDefinition Services: Read B2B services definition.
• ServiceInstance Services: CRUD service instances.
• SSH Authorized User Key Services: CRUD SSH authorized key.
• SSH Duplicate Check Services: SSH Duplicate Checks.
• SSH Known Host Key Services: CRUD SSH known host keys.
• SSH Remote Profile Services: CRUD SSH remote profiles.
• SSH User Identity Key Services: CRUD SSH user identity keys.
• Sterling Connect Direct Netmap Services : CRUD Sterling Connect Direct Netmaps.
• Sterling Connect Direct Netmap Xref Services: CRUD Connect : Direct Netmap Xrefs.
• Sterling Connect Direct Node Services: CRUD C: D nodes.
• Sterling Connect Direct Node Duplicate Check Services.
• Sterling Connect Direct XREF Duplicate Check Services.
• System Digital Certificate Services: CRUD.
• Test Trading Partner Services: View test trading partner.
• Trading Partner Services: CRUD. Example here.
• Trusted Digital Certificate Services: CRUD.
• User Account Services: CRUD user accounts.
• User Group Services: CRUD user groups.
• UserVirtualRoot Services: CRUD user virtual root.
• Workflow Services: Read, create, update, delete, change default version, enable or disable a workflow.
• WorkFlowMonitor Services : Read, Restart and terminate a workflow.

New! REST services introduced in IBM Sterling B2B Integrator 6.0.1:

PropertyFile Services: CRUD custom property files.

UserExit Services: CRUD jar files for user exits on specific node.

FGArrivedFiles: new POST action to Redeliver files which takes a redeliverComment as an input.

How to call a REST API with Curl ?

Curl Example on how to call a REST service to create (POST) a resource with a json input:

curl -X POST -u admin:myPassword -H "Content-Type: application/json" -d @input.json http://0.0.0.0:10074/B2BAPIs/svc/codelists/

input.json:

{
	"codeListName": "CLTest",
	"codes": [{
		"receiverCode": "REC1",
		"senderCode": "RE",
		"description": "receiver 1"
	},
	{
		"receiverCode": "REC2",
		"description": "Receiver 2 ",
		"senderCode": "RR"
	}]
}

Got Swagger?:

The description of the APIs can be found in the swagger document at http://yourIP:Port/B2BAPIs/svc/swagger.json

There is a link to the swagger specification on the top right hand API reference screen in the Web Service Browser. As shown in the screen shot:

Further reading:

Sterling B2B Integrator REST API Architecture.

Bulk REST API calls to create multiple resources (trading partners) automatically using node.js .

AngularJS REST API Mailbox Explorer for Sterling B2B Integrator.