Any API used for integration in a catalyst or open hack should reuse TMF APIs or an existing resource REST operation from the TMF API’s Catalog (this include the relased and the beta APIs).
Reuse of TMF API’s includes the following :
- Reuse of an existing TMF API Resource Operation for example GET customerAccount from the Customer Management APIs
- The Resource properties exposed must be compliant with the mandatory set of properties for that as defined by the specification (or the conformance profile).
- Reuse of existing TMF API notfications. If a Catalyst or Hack hosting technology exposes notifications related to a Resource then the notfications as defined within the related TMF specification must be reused.
Use the following table to identify the mapping of API’s to TMF API’s.
If the API can’t be mapped then identify if the new / extended API can be considered for Crowdsourcing (i.e will be submitted as a new API ) or if a CR will be raised.
The cells in green are illustrative examples.
API Name | Mapped TMF API | Crowdsourced or Change Request |
CorpX Trouble API | TMF Trouble Ticket API | Adding property X extension and event extension CR |
Corp Y Payment API | No Mapping | Yes new API to be crowdsourced. |
Corp Z Account API | Customer Management API | NA |