CAMARA API Overview
Cloud & Core
CAMARA API Overview
Agenda
- CAMARA and GSMA Open Gateway overview
- CAMARA API Introduction
- Summary
Enterprise Offering
The Telco Global API alliance
CAMARA-TheTelcoGlobalAPIAlliance
Accelerate
technology
development
Standardization
of APIs
Education and
promotion
Accelerate
commercial
adoption
An open-source project within Linux Foundation
to define, develop and test the harmonized telco
APIs
Close collaboration with the GSMA Operator
Platform Group and 5GFF
Announced in MWC 2022 with 22 launch
partners
Over 230 companies participating (June 2023)
● 4
5G network capabilities
Introduction
Quality on Demand / Traffic influence
Enable augmented reality
Wake up UEs
Support low energy IoT devices
Block UEs in geographic region
Crisis management
Reachability and Location of UEs
Identify (last known) location of drone
# of UEs in geographic region
Traffic jam or Corona warning
# of UEs in slice, network congestion
Adapt resolution for video transmission
CAMARAAPIArchitecture
Abstraction from Network APIs to
Service APIs is critical:
●Hide telco complexity
●Make APIs developer (no telco
expertise) friendly
●Fulfil data privacy and regulatory
requirements
●Facilitate application to network
integration
* Camara APIs could be consumed either by
aggregators or directly enterprises
● 7
CAMARA
Scope
We differentiate between 3 types of Northbound APIs:
• Service APIs: APIs intended for end consumers and
integrated by developers to invoke a certain telco
capability.
• Service Management APIs: APIs intended for end
consumers to manage or get data about offered Service
APIs in application runtime, e.g., check service availability
or performance information.
• Operate APIs: Operational and maintenance APIs provided
by a telco to channel partners for the purpose of service
fulfillment and assurance to their [channel partner]
customers. This may include service provisioning for a
mobile user, technical API performance monitoring, fault
ticketing, information exchange such as product catalog,
pricing, settlement, etc.
Service APIs and Service Management APIs
are in scope of CAMARA. Operate APIs are out of
scope of CAMARA (these are already covered by
other SDOs = Standards Development
Organizations like TM Forum).
● 8
CAMARA
Scope
Hyperscalers and aggregators have the possibility to create own enriched products based on the
CAMARA APIs and expose that in addition to the CAMARA APIs.
● 9
CAMARA
Scope
CAMARA project defines
CAMARA APIs.
TMForum develops the Operate
APIs.
Several SDOs cover the different
technology domains that provide
the telco capabilities.
More details can be found in the
whitepaper “The Ecosystem for
Open Gateway NaaS API
Development” (jointly published
by GSMA, CAMARA, Linux
Foundation and TMForum)
available here.
GSMAOpenGateway
● A GSMA-led initiative in the telco sector that
seeks to transform the communications
networks into platforms
● Open up telco capabilities in an
interoperable, intuitive and programmable
way.
● A framework of common network APIs
designed to provide universal access to
operator networks for developers
● Launched with 8 APIs and the support of 21
mobile network operators in MWC’23
GSMAOpenGatewayAPIs(MWC’23)
AsubsetofCAMARAAPIs
● Quality on Demand
● SIM Swap
● Device Status (Connected or Roaming Status)
● Number Verification
● Edge Site Selection and Routing
● Number Verification (SMS 2FA)
● Carrier Billing – Check Out
● Verify Location
https://www.gsma.com/futurenetworks/gsma-open-
gateway-api-descriptions/
CAMARAProject
APIworkgroups
Identity and
Consent Mgmt
Provides solutions to
capture, store and
manage user consent
Device Identifier
Check the identity of the
subscribers’ device
Allows users to set mobile
connection quality
and get notifications
Quality on
Demand
Edge Cloud
Carrier Billing
CheckOut
Purchase, pay, and follow
up on fulfilment of
products
Provide and manage
network and compute
resources for an
application
Device
Location
Check the location
of a device.
Number
Verification
Allows users to
verify the phone
number of the
connected device
OTP Validation
To offer secure user
authentication to
service providers.
Anonymised
Subscriber ID
Device Status
Identify a client device
trying to access network
services
Check the network
connection and
roaming status of a
device
Blockchain
Public Address
Manage a blockchain
public address associated
to a phone number
SIM Swap
Allows users to get
information on SIM
pairing changes
Home Devices
QoD
Request prioritization of
traffic on a specific
device on the home
network.
Common-alities
Guidelines and assest
mandatory for all
CAMARA Sub Projects
https://github.com/camaraproject
CAMARAProject
APIworkgroups
Identity and
Consent Mgmt
Provides solutions to
capture, store and
manage user consent
Device Identifier
Check the identity of the
subscribers’ device
Allows users to set mobile
connection quality
and get notifications
Quality on
Demand
Edge Cloud
Carrier Billing
CheckOut
Purchase, pay, and follow
up on fulfilment of
products
Provide and manage
network and compute
resources for an
application
Device
Location
Check the location
of a device.
Number
Verification
Allows users to
verify the phone
number of the
connected device
OTP Validation
To offer secure user
authentication to
service providers.
Anonymised
Subscriber ID
Device Status
Identify a client device
trying to access network
services
Check the network
connection and
roaming status of a
device
Blockchain
Public Address
Manage a blockchain
public address associated
to a phone number
SIM Swap
Allows users to get
information on SIM
pairing changes
Home Devices
QoD
Request prioritization of
traffic on a specific
device on the home
network.
Common-alities
Guidelines and assest
mandatory for all
CAMARA Sub Projects
https://github.com/camaraproject
Quality on Demand
Overview
● Current version: 0.9.0
● Simplify and enhance NEF AsSessionWithQos
– v0.8.0
● Parameterized
● No IP Filter Rule required
● Assigned UE IP address supported
● Only a single flow supported
● Duration is added
– v0.9.0
● QoS status and corresponding notification
● Support NATed UE IP address
● QoS profile discovery
Camara QoD API v0.9.0
POST /qod/v0/sessions
{
"duration": 86400,
“device": {
“ipv4Address": {
“publicAddress“: “152.190.161.1“,
“publicPort”: “123456”
},
“applicationServer": {
"ipv4addr": "192.176.1.84"
},
“devicePorts": {
“ports: [12345],
},
“applicationServerPorts": {
"ports": [8082]
},
"qosProfile": "QOS_E",
"qosStatus": "AVAILABLE",
"notificationUri": "http://as.com/notifications"
}
NEF AsSessionWithQoS API
POST /3gpp-as-session-with-qos/v1/subscriptions
{
"ueIpv4Addr" : "152.190.161.1",
"flowInfo":[
{
"flowId": 1
"flowDescriptions": [
"permit in IP from 152.190.161.1 45342 to 192.176.1.84 8082",
"permit out IP 192.176.1.84 8082 to 152.190.161.1 45342"
],
}],
"qosReference": "LOW_LATENCY",
"notificationDestination": "http://camara-layer.com/notifications"
}
CAMARAQoDAPI–QoSProfileDiscovery
● CAMARA QoD API is a developer-friendly service API for accessing 3GPP AsSessionWithQos capability
● CAMARA QoD API v0.9.0 introduces a QoS Profile Discovery endpoint
– For developers to know the characteristic of a specific QoS profile
– For developers to discover the proper QoS profile which fulfil the QoS requirements
CAMARAQoDAPIBenefit/Valuecomparingwith3GPPAPI
CAMARA QoD API is a developer-friendly service API to expose the QoS capability with following
main benefits comparing with 3GPP defined API,
● Simplification:
- Only IP flow
- Only single flow
- Notification endpoint is optional
●Enhancement:
- Session duration
- QoS Profile and discovery
- NATed IP
● Transformation:
- Easy to understand concepts/terminologies
- No IPFilter Rules
- QoS status
Device Status
Overview
● Current version: 0.5
● Monitor device connectivity
– Currently only GET roaming status supported
– Issues about adding more event types and subscription/notification mode
– NWaaP decides to contribute ‘Device Reporting’ to this WG, excluding location reporting
● Use cases
– IoT devices connectivity monitoring throughout device lifecycle (e.g. activation, configuration,
remote operations, software updates, troubleshooting)
– Fraud prevention – banking/payments (roaming status)
APIdefinition(1)
APIdefinition(2)
Location Verification
Overview
● Current version: 0.1.0
● To verify a UE claimed location (untrusted) is valid or not using the network location (trusted)
● Less privacy sensitive as not disclosing UE’s network location
● NWaaP may contribute the location reporting operations of ‘Device Reporting’ to this WG
● Use cases
– Fraud prevention – banking/payments
– Risk-based authentication (RBA)
– Traffic management of drones
APIdefinition
Number Verification
Overview
● Current version: 0.4.0-WIP
● To verify a UE claimed phone number (MSISDN) is valid or not, or retrieve the phone number
(MSISDN) of a UE
● Replace SMS/OTP with better user experience and security
● Leverage the authentication methods via mobile network (excluding SMS/OTP or
username/password)
● Provide CAMARA and GSMA Mobile Connect APIs in parallel
● Use cases
– Mobile App onboarding
– Mobile App login
– Mobile App password reset
APIdefinition(1/2)
APIdefinition(2/2)
SIM Swap
Overview
● Current version: 0.5.0
● To obtain information on recent SIM pairing change (MSISDN <-> IMSI pairing change) related
to the user’s mobile account.
● Provide CAMARA and GSMA Mobile Connect APIs in parallel
● Use cases
– SIM swap fraud detection
● Fraud prevention – banking/Fintech
● Fraud prevention for password reset
● Risk-based authentication (RBA)
SIMswapscam
APIdefinition(1/2)
APIdefinition(2/2)
Overview
● Current version: 0.5.0
● The Carrier Billing family features 2 APIs with distinct business scope:
– Carrier billing checkout : Service that provides functionality for enabling first the purchase and
then the payment request against Carrier Billing Systems.
– Carrier billing payment : Service enabling payments and payment follow-up against Carrier
Billing Systems.
● Use cases
– Mobile payment using mobile account
APIDefinition
CarrierBillingCheckout
APIDefinition
CarrierBillingPayment

Camara Application Programming Interface (API) Overview.pdf

  • 1.
  • 2.
    Cloud & Core CAMARAAPI Overview Agenda - CAMARA and GSMA Open Gateway overview - CAMARA API Introduction - Summary Enterprise Offering The Telco Global API alliance
  • 3.
    CAMARA-TheTelcoGlobalAPIAlliance Accelerate technology development Standardization of APIs Education and promotion Accelerate commercial adoption Anopen-source project within Linux Foundation to define, develop and test the harmonized telco APIs Close collaboration with the GSMA Operator Platform Group and 5GFF Announced in MWC 2022 with 22 launch partners Over 230 companies participating (June 2023)
  • 4.
    ● 4 5G networkcapabilities Introduction Quality on Demand / Traffic influence Enable augmented reality Wake up UEs Support low energy IoT devices Block UEs in geographic region Crisis management Reachability and Location of UEs Identify (last known) location of drone # of UEs in geographic region Traffic jam or Corona warning # of UEs in slice, network congestion Adapt resolution for video transmission
  • 5.
    CAMARAAPIArchitecture Abstraction from NetworkAPIs to Service APIs is critical: ●Hide telco complexity ●Make APIs developer (no telco expertise) friendly ●Fulfil data privacy and regulatory requirements ●Facilitate application to network integration * Camara APIs could be consumed either by aggregators or directly enterprises
  • 6.
    ● 7 CAMARA Scope We differentiatebetween 3 types of Northbound APIs: • Service APIs: APIs intended for end consumers and integrated by developers to invoke a certain telco capability. • Service Management APIs: APIs intended for end consumers to manage or get data about offered Service APIs in application runtime, e.g., check service availability or performance information. • Operate APIs: Operational and maintenance APIs provided by a telco to channel partners for the purpose of service fulfillment and assurance to their [channel partner] customers. This may include service provisioning for a mobile user, technical API performance monitoring, fault ticketing, information exchange such as product catalog, pricing, settlement, etc. Service APIs and Service Management APIs are in scope of CAMARA. Operate APIs are out of scope of CAMARA (these are already covered by other SDOs = Standards Development Organizations like TM Forum).
  • 7.
    ● 8 CAMARA Scope Hyperscalers andaggregators have the possibility to create own enriched products based on the CAMARA APIs and expose that in addition to the CAMARA APIs.
  • 8.
    ● 9 CAMARA Scope CAMARA projectdefines CAMARA APIs. TMForum develops the Operate APIs. Several SDOs cover the different technology domains that provide the telco capabilities. More details can be found in the whitepaper “The Ecosystem for Open Gateway NaaS API Development” (jointly published by GSMA, CAMARA, Linux Foundation and TMForum) available here.
  • 9.
    GSMAOpenGateway ● A GSMA-ledinitiative in the telco sector that seeks to transform the communications networks into platforms ● Open up telco capabilities in an interoperable, intuitive and programmable way. ● A framework of common network APIs designed to provide universal access to operator networks for developers ● Launched with 8 APIs and the support of 21 mobile network operators in MWC’23
  • 10.
    GSMAOpenGatewayAPIs(MWC’23) AsubsetofCAMARAAPIs ● Quality onDemand ● SIM Swap ● Device Status (Connected or Roaming Status) ● Number Verification ● Edge Site Selection and Routing ● Number Verification (SMS 2FA) ● Carrier Billing – Check Out ● Verify Location https://www.gsma.com/futurenetworks/gsma-open- gateway-api-descriptions/
  • 11.
    CAMARAProject APIworkgroups Identity and Consent Mgmt Providessolutions to capture, store and manage user consent Device Identifier Check the identity of the subscribers’ device Allows users to set mobile connection quality and get notifications Quality on Demand Edge Cloud Carrier Billing CheckOut Purchase, pay, and follow up on fulfilment of products Provide and manage network and compute resources for an application Device Location Check the location of a device. Number Verification Allows users to verify the phone number of the connected device OTP Validation To offer secure user authentication to service providers. Anonymised Subscriber ID Device Status Identify a client device trying to access network services Check the network connection and roaming status of a device Blockchain Public Address Manage a blockchain public address associated to a phone number SIM Swap Allows users to get information on SIM pairing changes Home Devices QoD Request prioritization of traffic on a specific device on the home network. Common-alities Guidelines and assest mandatory for all CAMARA Sub Projects https://github.com/camaraproject
  • 12.
    CAMARAProject APIworkgroups Identity and Consent Mgmt Providessolutions to capture, store and manage user consent Device Identifier Check the identity of the subscribers’ device Allows users to set mobile connection quality and get notifications Quality on Demand Edge Cloud Carrier Billing CheckOut Purchase, pay, and follow up on fulfilment of products Provide and manage network and compute resources for an application Device Location Check the location of a device. Number Verification Allows users to verify the phone number of the connected device OTP Validation To offer secure user authentication to service providers. Anonymised Subscriber ID Device Status Identify a client device trying to access network services Check the network connection and roaming status of a device Blockchain Public Address Manage a blockchain public address associated to a phone number SIM Swap Allows users to get information on SIM pairing changes Home Devices QoD Request prioritization of traffic on a specific device on the home network. Common-alities Guidelines and assest mandatory for all CAMARA Sub Projects https://github.com/camaraproject
  • 13.
  • 15.
    Overview ● Current version:0.9.0 ● Simplify and enhance NEF AsSessionWithQos – v0.8.0 ● Parameterized ● No IP Filter Rule required ● Assigned UE IP address supported ● Only a single flow supported ● Duration is added – v0.9.0 ● QoS status and corresponding notification ● Support NATed UE IP address ● QoS profile discovery
  • 16.
    Camara QoD APIv0.9.0 POST /qod/v0/sessions { "duration": 86400, “device": { “ipv4Address": { “publicAddress“: “152.190.161.1“, “publicPort”: “123456” }, “applicationServer": { "ipv4addr": "192.176.1.84" }, “devicePorts": { “ports: [12345], }, “applicationServerPorts": { "ports": [8082] }, "qosProfile": "QOS_E", "qosStatus": "AVAILABLE", "notificationUri": "http://as.com/notifications" } NEF AsSessionWithQoS API POST /3gpp-as-session-with-qos/v1/subscriptions { "ueIpv4Addr" : "152.190.161.1", "flowInfo":[ { "flowId": 1 "flowDescriptions": [ "permit in IP from 152.190.161.1 45342 to 192.176.1.84 8082", "permit out IP 192.176.1.84 8082 to 152.190.161.1 45342" ], }], "qosReference": "LOW_LATENCY", "notificationDestination": "http://camara-layer.com/notifications" }
  • 17.
    CAMARAQoDAPI–QoSProfileDiscovery ● CAMARA QoDAPI is a developer-friendly service API for accessing 3GPP AsSessionWithQos capability ● CAMARA QoD API v0.9.0 introduces a QoS Profile Discovery endpoint – For developers to know the characteristic of a specific QoS profile – For developers to discover the proper QoS profile which fulfil the QoS requirements
  • 18.
    CAMARAQoDAPIBenefit/Valuecomparingwith3GPPAPI CAMARA QoD APIis a developer-friendly service API to expose the QoS capability with following main benefits comparing with 3GPP defined API, ● Simplification: - Only IP flow - Only single flow - Notification endpoint is optional ●Enhancement: - Session duration - QoS Profile and discovery - NATed IP ● Transformation: - Easy to understand concepts/terminologies - No IPFilter Rules - QoS status
  • 19.
  • 21.
    Overview ● Current version:0.5 ● Monitor device connectivity – Currently only GET roaming status supported – Issues about adding more event types and subscription/notification mode – NWaaP decides to contribute ‘Device Reporting’ to this WG, excluding location reporting ● Use cases – IoT devices connectivity monitoring throughout device lifecycle (e.g. activation, configuration, remote operations, software updates, troubleshooting) – Fraud prevention – banking/payments (roaming status)
  • 22.
  • 23.
  • 24.
  • 26.
    Overview ● Current version:0.1.0 ● To verify a UE claimed location (untrusted) is valid or not using the network location (trusted) ● Less privacy sensitive as not disclosing UE’s network location ● NWaaP may contribute the location reporting operations of ‘Device Reporting’ to this WG ● Use cases – Fraud prevention – banking/payments – Risk-based authentication (RBA) – Traffic management of drones
  • 27.
  • 28.
  • 30.
    Overview ● Current version:0.4.0-WIP ● To verify a UE claimed phone number (MSISDN) is valid or not, or retrieve the phone number (MSISDN) of a UE ● Replace SMS/OTP with better user experience and security ● Leverage the authentication methods via mobile network (excluding SMS/OTP or username/password) ● Provide CAMARA and GSMA Mobile Connect APIs in parallel ● Use cases – Mobile App onboarding – Mobile App login – Mobile App password reset
  • 31.
  • 32.
  • 33.
  • 35.
    Overview ● Current version:0.5.0 ● To obtain information on recent SIM pairing change (MSISDN <-> IMSI pairing change) related to the user’s mobile account. ● Provide CAMARA and GSMA Mobile Connect APIs in parallel ● Use cases – SIM swap fraud detection ● Fraud prevention – banking/Fintech ● Fraud prevention for password reset ● Risk-based authentication (RBA)
  • 36.
  • 37.
  • 38.
  • 40.
    Overview ● Current version:0.5.0 ● The Carrier Billing family features 2 APIs with distinct business scope: – Carrier billing checkout : Service that provides functionality for enabling first the purchase and then the payment request against Carrier Billing Systems. – Carrier billing payment : Service enabling payments and payment follow-up against Carrier Billing Systems. ● Use cases – Mobile payment using mobile account
  • 41.
  • 42.