TM Forum APIs - Introduction,

Primer and Methodology

Pierre Gauthier - TM Forum Chief API Architect
pgauthier@tmforum.org
© 2016 TM Forum Live! 2016 | 1
TMF Forum APIs…

A suite of APIs making it

easier to IoT

• create Next Gen

OSS/BSS
Smart
City

• build TM
Forum
• and operate APIs

complex, innovative
Smart
Big Data
Grid

services NFV

REST based

© 2016 TM Forum Live! 2016 | 2

Forum APIs are for Developers…

Swagger
2 Specs
REST
Developer
Level 2
Portal
Based

API
API
specifications
specifications TM
in
in Open Client
Open
Source
Source
Forum SDKs
repository
repository
GitHub
API
GitHub

JSON End to
Schema End Open
for Open Data
Data Model
Model Common UML
REST API
Guidelines
Guidelines

© 2016 TM Forum Live! 2016 | 3

Scope of current TM FORUM APIs

TMF Ecosystem APIs

Service
SLA Activation
Product Product Product Service Perfor- Trouble On- Federated
Billing Manage- And
Ordering Catalog Inventor Catalog mance Ticket boarding Identity
API ment Provision
API API y API API API API API API -ing
API
API

From IoT Device Management

to
Complex B2B Value Fabrics

© 2016 TM Forum Live! 2016 | 4

End to End APIs…

Product
Product Usage
Usage Billing
Billing
Product
Product and
and Mediation
Mediation Invoicing
Invoicing
Ordering/Activa
Ordering/Activa
Product
Product tion
tion
Offering
Offering
Product
Definition

Product
Product Usage
Lifecycle Product
Ordering Managemen Billing API
Managemen Catalog API
API t API
t API

© 2016 TM Forum Live! 2016 | 5

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

© 2016 TM Forum Live! 2016 | 6

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

© 2016 TM Forum Live! 2016 | 7

Implementation Tooling

J2EE Reference Cloud SandBox

Implementations
Common Java
J2EE
Framework
JPA, JAX-RS 2.0,
OAUth2,PubSub
etc..
GItHub
Developer Portal

Conformance and
Test Kits
POSTMAN

© 2016 TM Forum Live! 2016 | 8

Simple Data Model with Hyperlinks…

Product Catalog
API example
© 2016 TM Forum Live! 2016 | 9
Postman example - For Testing the APIs

© 2016 TM Forum Live! 2016 | 10

Swagger Example Entity Provisioning API
JSON Schema 4 based

© 2016 TM Forum Live! 2016 | 11

Swagger Example - Editor

© 2016 TM Forum Live! 2016 | 12

Forum APIs Sandbox and Testing…
Reference
Reference
Implementati
Implementati
ons in Java
available
(JAX_RS
(JAX_RS 2.0
2.0
Open based)
based)
Security
Enabled Conforman
Open ID ce Test Kits
Connect in Node.js
and
OAUth2
Sandbox
Sandbox running
running
Live
Live
Implementations
Implementations
of
of the
the APIs
APIs

Google
Swagger
and JSON POSTMAN
Collections
Schema 4
For Testing
based
Hub the APIS
Listener
Testing
Component
s for PUB
SUB
Testing

© 2016 TM Forum Live! 2016 | 13

https://github.com/tmforum

ST
RE
an d
ub
G i tH
rc e
Sou
pen
O ed
Bas

© 2016 TM Forum Live! 2016 | 14

© 2016 TM Forum Live! 2016 | 15
Where to find…
Download API Specifications GitHub 
Get all the TM Forum Specifications with examples from GitHub. 
https://github.com/tmforum/TMFORUMAPISPECS14.5

Download POSTMAN Collections GitHub
https://github.com/tmforum/TMFAPIPOSTMAN
Download  the POSTMAN Collections and test all the TM Forum APIs running on our Sandbox.You
can try the APIs on our running Sandbox. 

Download Swaggers from GitHub

https://github.com/tmforum/TMFAPISWAGGER
Download the Swaggers and test all the TM Forum APIs running on our Sandbox

You can also use the Swaggers from there. They are served by Orange.

© 2016 TM Forum Live! 2016 | 16

Development assets - API Developer Portal

17 © 2016 TM Forum Live! 2016 | 17