Skip to content

Commit 4219f0c

Browse files
committed
Update readme docs excerpt format
1 parent 452a34f commit 4219f0c

36 files changed

+277
-80
lines changed

v0/about/architecture.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,17 @@
11
---
22
title: API Architecture
3-
excerpt: The Open Gateway API Architecture is a cutting-edge framework designed to enable seamless integration of advanced network capabilities and services into your applications. Developed by the GSMA in collaboration with leading telecommunications operators, aggregators, cloud providers, and other telcos, this architecture focuses on promoting interoperability, enhancing innovation, and improving operational efficiency. By leveraging standardized APIs, the Open Gateway architecture empowers developers to create robust, scalable, and high-performance applications.
4-
category: 680a72d37e76400018040958
3+
category:
4+
uri: About Open Gateway
5+
content:
6+
excerpt: >-
7+
The Open Gateway API Architecture is a cutting-edge framework designed to
8+
enable seamless integration of advanced network capabilities and services
9+
into your applications. Developed by the GSMA in collaboration with leading
10+
telecommunications operators, aggregators, cloud providers, and other
11+
telcos, this architecture focuses on promoting interoperability, enhancing
12+
innovation, and improving operational efficiency. By leveraging standardized
13+
APIs, the Open Gateway architecture empowers developers to create robust,
14+
scalable, and high-performance applications.
515
---
616

717
## Introduction to Open Gateway API Architecture

v0/about/camara.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,17 @@
11
---
22
title: CAMARA project
3-
excerpt: CAMARA is an open-source initiative under the Linux Foundation focused on defining, developing, and testing telecom APIs. In collaboration with the GSMA Operator Platform Group, CAMARA ensures that API requirements are aligned, and API definitions are published for industry-wide use. The project achieves API harmonization by rapidly creating working code and providing developer-friendly documentation. All API definitions and reference implementations are available for free under the Apache 2.0 license.
4-
category: 680a72d37e76400018040958
3+
category:
4+
uri: About Open Gateway
5+
content:
6+
excerpt: >-
7+
CAMARA is an open-source initiative under the Linux Foundation focused on
8+
defining, developing, and testing telecom APIs. In collaboration with the
9+
GSMA Operator Platform Group, CAMARA ensures that API requirements are
10+
aligned, and API definitions are published for industry-wide use. The
11+
project achieves API harmonization by rapidly creating working code and
12+
providing developer-friendly documentation. All API definitions and
13+
reference implementations are available for free under the Apache 2.0
14+
license.
515
---
616

717
With CAMARA Open APIs, enterprise software developers can integrate network capabilities once, and they’re ready to go. Imagine these APIs embedded in cloud provider stacks. Developers could then seamlessly incorporate lines of code from both the cloud provider and global telecommunication standards, covering services like identity, cybersecurity, billing, signaling, geolocation, and more.

v0/about/glossary.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
11
---
22
title: Glossary of Terms
3-
excerpt: Reference guide to key terms and concepts used in the Open Gateway API documentation
4-
category: 680a72d37e76400018040958
3+
category:
4+
uri: About Open Gateway
5+
content:
6+
excerpt: >-
7+
Reference guide to key terms and concepts used in the Open Gateway API
8+
documentation
59
---
610

711
## Aggregator

v0/about/initiative.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,13 @@
11
---
22
title: The Open Gateway Initiative
3-
excerpt: Welcome to Open Gateway APIs, your gateway to leveraging advanced network capabilities in your applications. Whether you're a seasoned developer or just starting your journey, Open Gateway APIs provide the tools and resources you need to create innovative, high-performance applications.
4-
category: 680a72d37e76400018040958
3+
category:
4+
uri: About Open Gateway
5+
content:
6+
excerpt: >-
7+
Welcome to Open Gateway APIs, your gateway to leveraging advanced network
8+
capabilities in your applications. Whether you're a seasoned developer or
9+
just starting your journey, Open Gateway APIs provide the tools and
10+
resources you need to create innovative, high-performance applications.
511
---
612

713
## What is Open Gateway?

v0/about/privacy.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,12 @@
11
---
22
title: Privacy by Design
3-
excerpt: Open Gateway as an industry initiative has been designed with end-user's privacy in mind, to provide developers with telco capabilities while ensuring user data privacy and security.
4-
category: 680a72d37e76400018040958
3+
category:
4+
uri: About Open Gateway
5+
content:
6+
excerpt: >-
7+
Open Gateway as an industry initiative has been designed with end-user's
8+
privacy in mind, to provide developers with telco capabilities while
9+
ensuring user data privacy and security.
510
---
611

712
Open Gateway APIs allow applications to access and utilize end-users' personal information or data. "Utilizing" personal data encompasses any form of handling or processing related to an identified or identifiable individual, including merely viewing the data or having it accesible from the application's code and thus to its developer. Consequently, **the use of personal data must be justified and authorized**.

v0/callflows/apiintegration.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,12 @@
11
---
22
title: API Integration
3-
excerpt: In this guide we will go through the different ways to integrate with Open Gateway APIs so you can find the best fit for your use case and the offering from our Channel Partners.
4-
category: 680a72d37e7640001804095c
3+
category:
4+
uri: API Call Flows
5+
content:
6+
excerpt: >-
7+
In this guide we will go through the different ways to integrate with Open
8+
Gateway APIs so you can find the best fit for your use case and the offering
9+
from our Channel Partners.
510
---
611

712
## RESTful by design

v0/callflows/authorization/authorization.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
11
---
22
title: Authorization
3-
excerpt: In this guide you will find a briefly introduction to authorization mechanisms and best practices for secure access to Open Gateway APIs
4-
category: 680a72d37e7640001804095c
3+
category:
4+
uri: API Call Flows
5+
content:
6+
excerpt: >-
7+
In this guide you will find a briefly introduction to authorization
8+
mechanisms and best practices for secure access to Open Gateway APIs
59
---
610

711
## Authorization standards
@@ -40,4 +44,4 @@ In case the lawful basis of the Open Gateway API and the purpose of your use cas
4044

4145
The frontend authorization flow, as per the OIDC standard, will redirect your request to the operator's consent capture URL if needed, and then resume all the way to your application's redirect URI according to the user event.
4246

43-
In case of implementing a backend authorization flow, there is no standard way to make the operator subscriber to get to a consent capture frontend, so you will have to implement a secondary flow, known as out-of-band, to capture the consent by other mean, so when your backend calls the Open Gateway API the user consent has been already granted. This secondary flow will usually be a registration, subscription or activation process on your customer journey, or similar.
47+
In case of implementing a backend authorization flow, there is no standard way to make the operator subscriber to get to a consent capture frontend, so you will have to implement a secondary flow, known as out-of-band, to capture the consent by other mean, so when your backend calls the Open Gateway API the user consent has been already granted. This secondary flow will usually be a registration, subscription or activation process on your customer journey, or similar.

v0/callflows/authorization/backend.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,13 @@
11
---
22
title: Backend authorization flow
3-
excerpt: If your use case does not involve end-user's interaction you will want to integrate with Open Gateway APIs from the backend. This guide will help you understand the flows to get your application authorized to call the APIs from your server or any other environment without a human interface.
4-
category: 680a72d37e7640001804095c
3+
category:
4+
uri: API Call Flows
5+
content:
6+
excerpt: >-
7+
If your use case does not involve end-user's interaction you will want to
8+
integrate with Open Gateway APIs from the backend. This guide will help you
9+
understand the flows to get your application authorized to call the APIs
10+
from your server or any other environment without a human interface.
511
---
612

713
From a developer perspective, the backend authorization flow consists of two sequential steps implemented by performing HTTP requests to the following Open Gateway Channel Partner's API gateway endpoints, compliant with the ODIC standard **CIBA** (Client-Initiated Backchannel Authentication Flow).
@@ -83,4 +89,4 @@ In this portal, you can find the following references:
8389

8490
External references:
8591
- [CAMARA APIs Access and User Consent Management](https://github.com/camaraproject/IdentityAndConsentManagement/blob/r0.2.0/documentation/CAMARA-API-access-and-user-consent.md)
86-
- [OIDC Client-Initiated Backchannel Authentication Flow](https://openid.net/specs/openid-client-initiated-backchannel-authentication-core-1_0.html)
92+
- [OIDC Client-Initiated Backchannel Authentication Flow](https://openid.net/specs/openid-client-initiated-backchannel-authentication-core-1_0.html)

v0/callflows/authorization/frontend.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,14 @@
11
---
22
title: Frontend authorization flow
3-
excerpt: If your application offers a human interface to provide your users with features enabled by Open Gateway, this is its frontend component, running on the end-user's device, that will trigger the API calling flow. This guide will show you how to authorize your application by identifying the end-user from their network connected devices.
4-
category: 680a72d37e7640001804095c
3+
category:
4+
uri: API Call Flows
5+
content:
6+
excerpt: >-
7+
If your application offers a human interface to provide your users with
8+
features enabled by Open Gateway, this is its frontend component, running on
9+
the end-user's device, that will trigger the API calling flow. This guide
10+
will show you how to authorize your application by identifying the end-user
11+
from their network connected devices.
512
---
613

714
From a developer perspective, the frontend authorization flow consists of two sequential steps implemented by performing HTTP requests to the following Open Gateway Channel Partner's API gateway endpoints, compliant with the OIDC standard **Authorization Code Flow**.
@@ -100,4 +107,4 @@ In this portal, you can find the following references:
100107

101108
External references:
102109
- [CAMARA APIs Access and User Consent Management](https://github.com/camaraproject/IdentityAndConsentManagement/blob/r0.2.0/documentation/CAMARA-API-access-and-user-consent.md)
103-
- [OIDC Authorization Code flow specification](https://openid.net/specs/openid-connect-core-1_0.html#CodeFlowAuth)
110+
- [OIDC Authorization Code flow specification](https://openid.net/specs/openid-connect-core-1_0.html#CodeFlowAuth)

v0/catalog/ageverification/ageverification.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,13 @@
11
---
22
title: Age Verification API
3-
excerpt: The Age Verification API enables businesses to verify if users meet required age thresholds for age-restricted services using verified data from mobile network operators, ensuring compliance with regulations while protecting privacy.
4-
category: 681879c3afc1a0003709c745
3+
category:
4+
uri: API Catalog
5+
content:
6+
excerpt: >-
7+
The Age Verification API enables businesses to verify if users meet required
8+
age thresholds for age-restricted services using verified data from mobile
9+
network operators, ensuring compliance with regulations while protecting
10+
privacy.
511
---
612

713
The standardized Age Verification API allows businesses to determine if users meet required age thresholds for accessing age-restricted subscriptions and services using verified data from mobile network operators.

0 commit comments

Comments
 (0)