inform innovate accelerate optimize

TM FORUM
APIs

Pierre Gauthier
TM Forum Chief API Architect
[email protected]
© 2013 TM Forum | 1
V2013.5
TMF Forum APIs…

A family of APIs making it IoT  

easier to Next  
Digital  
•  create Gen  
OSS/BSS  
TM  
Health  

•  build Forum    
APIs  
•  and operate Big  Data  
Smart  
Grid  
complex, innovative
services NFV  

REST
2  
based
 TMF  API  Ecosystem  

Service  
Product   Product   Product   Service   SLA   Trouble   Federated   Ac?va?on  
Ordering     Catalog     Billing   Catalog   Performance   Management   Ticket     Onboarding   Iden?ty  
Inventory   And  
API   API   API    API   API   API   API   API   API    API   Provisioning    
API  

From IoT Device Management

to
Complex B2B Value Fabrics
End to End APIs…

Product  Usage   Billing    

Product   and  MediaEon   Invoicing  
Ordering/
AcEvaEon  
Product  Offering  
Product  
DefiniEon  
 Simple Data Model with Hyperlinks…

Product Catalog
API
5  
Related Party is an Organization…

Party Management
API
6  
API Inventory Q4 2014
•   TMF629  Customer  Management  API  
–  The  customer  management  API  provides  standardized  mechanism  for  customer  and  customer  account  
management,  such  as  creaEon,  update,  retrieval,  deleEon  and  noEficaEon  of  events.  
•  TMF632  Party  Management    API  
–  The  party  management  API  provides  standardized  mechanism  for  party  management  such  as  creaEon,  update,  
retrieval,  deleEon  and  noEficaEon  of  events.  
–  Party  can  be  an  individual  or  an  organizaEon  that  has  any  kind  of  relaEon  with  the  enterprise.  
•  TMF634  Resource  Catalog  Management  API  
–  The  Resource    Catalog  Management  API  provides  a  standardized  soluEon  for  adding  rapidly  Resource  
SpecificaEons  to  an  exisEng  Catalog.    
•  TMF633  Service  Catalog  Management  API  
–  The  Service  Catalog  Management  API  provides  a  standardized  soluEon  for  adding  rapidly  partners’  Service  
SpecificaEonto  an  exisEng  Catalog.    
•  TMF635  Usage  API  
–  The  usage  API  provides  standardized  mechanism  for  usage  management  such  as  creaEon,  update,  retrieval,  import  and  
export  of  a  collecEon  of  usages.  
•   TMF637  Product  Inventory  Management  API  
–  The  Product  Inventory  API  provides  standardized  mechanism  for  product  inventory  management  such  as  creaEon,  
parEal  or  full  update  and  retrieval  of  the  representaEon  of  a  product  in  the  inventory.  It  also  allows  the  
noEficaEon  of  events  related  to  product  lifecycle.

7  
API Inventory 2014
•  TMF636  Billing  Account  Management,  Invoices  and  SeZlements  API  
–  The  Billing  API  provides  standardized  mechanisms  for  billing  account,  bill  item  and  seZlement  note  advice  management  
either  in  B2B  or  B2B2C  contexts.    
•   TMF638  Service  Inventory  Management  API  
–  The  Service  Inventory  API  provides  standardized  mechanism  for  service  inventory  management  such  as  creaEon,  
parEal  or  full  update  and  retrieval  of  the  representaEon  of  a  service  in  the  inventory.  It  allows  also  noEficaEon  of  
events  related  to  service  lifecycle.  
•  TMF639  Resource  Inventory  Management  API  
–  The  Resource  Inventory  API  provides  standardized  mechanism  for  resource  inventory  management  such  as  
creaEon,  parEal  or  full  update  and  retrieval  of  the  representaEon  of  a  resource  in  the  inventory.  It  allows  also  
noEficaEon  of  events  related  to  resource  lifecycle.  
•   TMF623  SLA  Management  API  
–  The  SLA  API  provides  a  standardized  interface  for  SLA  life  cycle  Management  (SLA  NegoEaEon,  SLA  configuraEon  
SLA  AcEvaEon/enforcement,  SLA  OperaEons,  SLA  violaEon  /  consequence  handling,  SLA  reporEng)  between  a  
Customer  and    a  Service  Provider  which  provides  offers  (product  with  aZached  SLA  in  its  catalogue)  the  customer  
can  discover,  browse,  trigger  and  order.  
•  TMF628  Performance  Management  API  
–  The  performance  management  API  provides  standardized  mechanism  for  performance  management  such  as  
creaEon,  parEal  or  full  update  and  retrieval  of  the  resources  involved  in  performance  management  (Measurement  
ProducEon  Job,  Measurement  CollecEon  Job,  and  Ad  hoc  CollecEon).  

8  
API Inventory Q4 2014
•  TMF622  Product  Ordering  API  
–  The  Product  Ordering  API  provides  a  standardized  mechanism  for  placing  a  product  order  with  all  of  the  necessary  order  
parameters.    
•  TMF620  Product  Catalog  Management  API  
–  The  Product  Catalog  Management  API  provides  a  standardized  soluEon  for  adding  rapidly  partners’  products  to  an  
exisEng  Catalog.    
–  It  brings  the  capability  for  Service  Providers  to  directly  feed  partners  systems  with  the  technical  descripEon  of  the  
products  they  propose  to  them.    
•   TMF621  Trouble  Ticket  API  
–  The  Trouble  EckeEng  API  provides  a  standardized  client  interface  to  Trouble  Ticket  Management  Systems  for  creaEng,  
tracking  and  managing  trouble  Eckets  among  partners  as  a  result  of  an  issue  or  problem  idenEfied  by  a  customer  or  
another  system.    

9  
Forum APIs are for Developers…

Swagger  2  Specs  
Q1  2015  

Apigee   REST  Level  2  

Developer  Portal   Based  

TM  
API  SpecificaEons   Forum  
are  available  
from  Open  
Source  
API   End  to  End  Open  
Data  Model  UML    
Repository  
GitHub  

JSON  Schema  for  

Open  Data   Common    REST  
API  Guidelines  
Model  

10  
 APIGEE   API  Sandbox  running  on  the  
Console  and  Proxy   Cloud  
Forum APIs Sandbox and Testing…
Reference  
ImplementaEons  
in  J2EE  available  
on  GitHub  

Open  Security  
Enabled    Open  ID   Conformance  
Connect  and     Test  Kits  
OAUth2    

Sandbox  running  
Live  
ImplementaEons  
of  the  APIs  

Google  
POSTMAN  
Apigee    Consoles   CollecEons  For  
TesEng    

Hub  Listener  
TesEng  
Components  for  
PUB  SUB  TesEng  

12  
https://github.com/tmforum
Spec Tooling
ODE  UML  
Data  Model   Swagger  2  Editor  
GitHub  
Papyrus  UML  
with  
Model  
Governance  
JSON SHEMA ODE  Data  
GENERATOR Model   Swagger  2  API  
JSON     Specs  in  GitHub  
Schemas  

14  
Implementation Tooling

J2EE  Reference   Cloud  SandBox  

ImplementaEons    
Common  Java  
J2EE    
Framework  
JPA,  JAX-­‐RS  2.0,  
OAUth2,PubSub  
etc..   GItHub   ApIgee  Consoles  
and  Developer  
Portal  
Conformance  and  
Test  Kits  
POSTMAN  

15  
TMF APIS ARE SERVICE AGNOSTIC
•  TMF APIs are generic framework APIs which can be used for any type of L2/L3/etc service for
the communications industry as well as other industries.
•  Any Service deployed in the TMF API Ecosystem can be instrumented with a set of generic
APIs
•  Service can be:
–  Ordered via the Service Ordering API
–  Activated and Provisioned via Service Activation and Provisioning API
–  Offered in Service Catalog via Service Catalog API
–  Hyperlinked to Product Offerings in Product Catalogs via Product Catalog API
–  Hyperlinked to Service Level Agreement in SLA Management System supporting SLA APIs

16  
Generic ODE Service Model
•  TMF is not developing MEF Carrier Ethernet Service Order, Configuration and
Activation APIs.
•  TMF and MEF are looking at how to implement/map the MEF Service Model so
that the TMF Generic APIs can be used i.e Catalog, SLA, Ordering, Configuration
etc…
•  MEF Service State State Model follow core Service State Model
•  MEF Service Specification with configurable and fixed Characteristics
•  MEF ServiceConfigSpec shaping the possible Service Configurations
•  This is being worked on and should be available as a working draft December
2014

17  
ODE Generic Service in the API Ecosystem…

Service     Service    Usage  

AcEvaEon    and   and  MediaEon  
Service  
Ordering/ Provisioning  
AcEvaEon  
Service  Offering  
Service  
DefiniEon  
API Roadmap Q4 2014
•  Service Ordering APIs –Q1 2015
•  Service Activation and Provisioning APIs – Q1 2015
•  Pre-ordering Processes
•  Order Validation, Feasibility etc…
–  Quotes
–  Appointments
–  Qualification
•  Service Quality Management
–  SLO Thresholds Alarms etc..
•  Federated identity / profile, privacy
•  Partner on-boarding APIs Agreements
•  OTT API

19  
E2E API Use Cases…

O2C U2P
O2C   T2R

I2L

20  
NFV and the TMF API Ecosystem…

Order Management Get Catalog & Inventory Management

API Product APIs
Details

Update Customer Update Inventory

Service Order
API Provision,
Real-time Billing Configure,
Get Usage API Monitor
Virtual Network
Usage Functions

Notify SLA Violation Mano

Provision,
Configure,
SLA Management Get
Network Function
Performance Monitor,
API Performance
Optimize Virtualization Infrastructure
API

21  
APIs and Ecosystems Priority for 2015

Catalog API

Catalog API

TM  Forum  
Digital  Ecosystem  
Complex Value
Chains
Across Ecosystems

22