IBM SmartCloud™ SaaS Business Support System (BSS) APIs are REST based and can be invoked in variety of programming languages. IBM provides a simple tool for exploring and testing APIs and some samples for invoking APIs through cURL, a free utility.
BSS API explorer
The BSS API explorer is a tool for experimenting with APIs with no coding. To access the explorer, go to the
Lotus Greenhouse
website.
cURL utility
You can use cURL to try and test BSS APIs. cURL is a free utility for making HTTP calls via a command-line interface. To download cURL, go to the
cURL download website. Be sure to download the library with SSL support.
To learn more about cURL, try the
Using cURL to automate HTTP jobs tutorial on the cURL website.
Note: BSS APIs were tested with cURL version 7.9.16.
The following examples demonstrate how to invoke BSS APIs. Contact the
IBM® Customer Service Group (CSG) to obtain the
server-url value.
Get customer with ID (HTTP GET)curl -u username@example.com:somepassword <server-url>/api/bss/resource/customer/12345678
Get subscriber by email address (HTTP GET with query parameters)curl -u username@example.com:somepassword -X GET "<server-url>/api/bss/resource/subscriber?_namedQuery=getSubscriberByEmailAddress&emailAddress=user2@example.com"
Note: Be sure to enclose the URL with double quotation marks.
Register customer (HTTP POST)curl -u username@example.com:somepassword -X POST --data-binary @customer.json <server-url>/api/bss/resource/customer
Unsuspend customer ((HTTP POST with HTTP header)curl -u username@example.com:somepassword -X POST --header "x-operation: unsuspendCustomer" <server-url>/api/bss/resource/customer/12345678
Update customer (HTTP PUT)curl -u username@example.com:somepassword -X PUT --data-binary @customerUpdated.json <server-url>/api/bss/resource/customer/12345678
Delete customer (HTTP DELETE)curl -u username@example.com:somepassword -X DELETE <server-url>/api/bss/resource/customer/12345678