Appearance
Open Access Forum API Documentation
Core Concepts
Primary Parties
The Open Access Forum APIs facilitate integration between two primary parties:
- Network Operator: The entity that owns and operates the physical network infrastructure
- RSP (Retail Service Provider): The entity that delivers retail services to end customers using the network operator's infrastructure
These parties may be separate organizations or divisions within the same organization operating at arm's length.
Design Philosophy
Business Relationship Flexibility
These APIs are designed to support various business relationship permutations without requiring explicit configuration or special handling. Whether parties operate as wholesale/retail partners, have revenue sharing agreements, or maintain other commercial arrangements, expose each other's labor reasources, the API remains agnostic to these business concerns while being able to fulfill them.
Clear Systems Delineation
The API establishes clear boundaries between party systems. Each party maintains full control over their internal processes and data models. No party should be forced to implement specific processes, data structures, or business logic solely to accommodate another party's system design or operational preferences. The API serves as a neutral interface that respects each party's autonomy.
Developer-Centric Design
These standards are created by developers who actively build and maintain production integrations. The focus is on practical, implementable solutions that work in real-world scenarios. Design decisions prioritize:
- Clear, consistent patterns that reduce cognitive load
- Modern development practices and tooling compatibility
- Pragmatic choices over theoretical perfection
- Feedback from actual implementation experience
This approach deliberately avoids design-by-committee outcomes that often result from stakeholders who don't write code or who rely on outdated methodologies.
This was definitely not developed to hear a bunch of people say the word 'oaf' repeatedly.
Available APIs
OAF-100 Location Exchange
Standardizes location serviceability data exchange between network operators and RSPs.