Home

Wiki for Product Order API

An instance of the Catalog API server is already deployed, please contact the TM Forum organisation to retrieve IP adresses.

Detailed API can be found here API specification

Exposed API

Description
Two resources are managed through the API, productOrder and hub. Hub is a subscribe / notification mechanism

productOrder
GET /productOrder/ Get all product offering
GET /productOrder/{id} Get a product offering
POST /productOrder/{id} Create a product offering

hub
You will need a listening server to use this feature. As an alternative a mock server is provided in the sources, see below in the documentation.

Create a hub containing at least your callback URL, add a query if you want more specific event filtering
POST /hub
GET /hub/{id}
DELETE /hub/{id}

JSON Samples

Location
'src/script/json'

Test a deployed API with curl based script

Description
Some shell scripts to play with the API
po.sh -> Post/Get on productOrder
hub.sh -> Post/Get/Delete on hub
clean.sh -> Remove clients logs

Location
'src/script'

Configure
Edit 'conf.sh' with servername, port, context, basic auth credentials

Help
Run po.sh, hub.sh without parameters

Test a deployed API with soapUI

Description
Contains sample requests to play with the API

Install
Install SOAP UI from http://www.soapui.org/
Load SOAP UI project located under /soapui

Mock a callback server

Description
a lite J2SE server that logs incoming request to file

Location
'src/script'

Run
mockService.sh {port} {pathToLogFile}

Deploy & run the API from sources

Download Netbeans 7.3 ( only )
Install with glassfish
Import sources from GIT ( menu Team / Clone )
Deploy