At most operators, product catalog, ordering, inventory, and network APIs are spread across many systems and versions. API Portal brings their specs into one catalog and gives each partner exactly the APIs they need.
// The Challenge
An operator's business IT is rarely built in one piece. CRM, ordering, inventory, and network come from different vendors, and every API has its own consumers inside the company and at partners.
The ordering system speaks TMF622 v4, the new product catalog already runs TMF620 v5, and both carry their own extensions. Usually only the team that runs an API knows which version is live where.
Resellers, MVNOs, and wholesale customers order through ordering and qualification APIs. The documentation often goes out as a PDF, and every new version triggers another round of questions.
CAMARA and GSMA Open Gateway bring in consumers who don't know the network. They need a spec they can try in the browser and a clear path to access.
// Use Cases
TM Forum publishes its Open APIs as spec files, with version 4 in Swagger 2.0 and version 5 in OpenAPI 3.0. The catalog accepts both formats, so TMF620, TMF622, or TMF641 sit next to your own APIs, extensions included. Teams can see at a glance which system offers which version.
Each partner group gets its own portal with its ordering, qualification, and inventory APIs. Business groups and roles control who sees which spec, and new versions show up there with a changelog.
CAMARA defines network APIs such as SIM Swap, Number Verification, and Quality on Demand as OpenAPI specs, and operators in GSMA Open Gateway offer them in a consistent way. In the portal, you can document these specs, try them in the explorer, and version them per meta-release.
// Security & Operations
Telecom networks are critical infrastructure, and NIS2 sets high expectations for the systems behind them. The portal provides building blocks that can feed into your security concepts.
Roles, business groups, and environment policies define who can see and change which API. Sign-in runs through SSO with Okta, Azure AD, or Keycloak.
The audit log records who changed which spec and when. That gives internal reviews and external audits a traceable record.
On the Enterprise plan, the platform can also run in your own infrastructure.
The cloud version runs in EU data centers in Frankfurt, and your data stays in the EU.
// API Landscape
The examples range from product catalog and ordering to network APIs. The paths come from the published TM Forum and CAMARA specs.
Product offerings, prices, and categories shared by CRM, web shop, and partner channels.
Orders from end customers and partners, with order items, status, and cancellation.
Checks before ordering whether a service is available at an address or access line.
Technical orders to the network, such as activating or changing a service.
Reports whether and when the SIM card for a phone number was last swapped, for example to prevent fraud.
Requests a specific network quality for a session and checks its status.
// Architecture
In an ODA architecture, every component exposes its functions through Open APIs, and legacy systems usually keep their specs in their own repositories. With the CLI and CI/CD, these specs reach the portal on every release, and nobody has to upload them by hand.
# .gitlab-ci.yml · Telco API Portal Sync
stages:
- validate
- deploy
validate-specs:
stage: validate
script:
- apiportal lint ./specs/tmf/*.yaml
- apiportal lint ./specs/camara/*.yaml
deploy-portal:
stage: deploy
script:
- apiportal deploy --env prod
only:
- main
// FAQ
Still have questions? Our team is happy to help.
Contact SalesIn a demo, we show how catalog, versioning, and partner portals work together with TMF specs.