IBM Connections Cloud
™ 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 https://greenhouse.lotus.com/bssapiexplorer
" target="external">Lotus Greenhouse
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 http://curl.haxx.se/download.html
" target="external">cURL download website
. Be sure to download the library with SSL support.
To learn more about cURL, try the http://curl.haxx.se/docs/httpscripting.html
" target="external">Using cURL to automate HTTP jobs
tutorial on the cURL website.
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
Get customer with ID (HTTP GET)
curl -u email@example.com:somepassword <server-url>/api/bss/resource/customer/12345678Get subscriber by email address (HTTP GET with query parameters)
curl -u firstname.lastname@example.org:somepassword -X GET "<server-url>/api/bss/resource/subscriber?_namedQuery=getSubscriberByEmailAddress&emailAddressemail@example.com"Register customer (HTTP POST)
Note: Be sure to enclose the URL with double quotation marks.
curl -u firstname.lastname@example.org:somepassword -X POST --data-binary @customer.json <server-url>/api/bss/resource/customerUnsuspend customer ((HTTP POST with HTTP header)
curl -u email@example.com:somepassword -X POST --header "x-operation: unsuspendCustomer" <server-url>/api/bss/resource/customer/12345678Update customer (HTTP PUT)
curl -u firstname.lastname@example.org:somepassword -X PUT --data-binary @customerUpdated.json <server-url>/api/bss/resource/customer/12345678Delete customer (HTTP DELETE)
curl -u email@example.com:somepassword -X DELETE <server-url>/api/bss/resource/customer/12345678