From functional perspective the scope is limited to telco APIs, that means APIs in the domain of telco mobile networks, telco fixed line networks or supporting these (e.g. for authentication). The respective API families are clarified during the ramp up of the CAMARA Project, specifically the ones exposed to customers.
Technically the scope is about northbound Service APIs, that means an abstraction / aggregation of e.g. 3GPP APIs or TM Forum APIs to hide telco complexity, keep control at the operator side and fulfill regulatory and data privacy constraints. Optionally in scope are east-/westbound APIs on the same abstraction / aggregation level.
The Service APIs (incl. mapping tables for the attributes to the southbound APIs if useful) are in scope of the Project and in scope of the harmonization. The transformations functions (business logic that calls the southbound APIs, transforms the data and provides the function for the Service APIs) are in scope of the Project as example / reference implementations, but not in scope of the harmonization. So each telco operator can implement the transformation functions in the best manner considering network topology and vendors, and can use the reference implementation as an orientation and starting point.
The service scope of the CAMARA Project is limited to the following activities:
- Collect API requirements from GSMA OPG subgroup and other sources. That can be a (prioritized) list of API families seen as useful for the customers, a functional descriptions of the APIs (attributes, function, result), and also non-functional requirements for the APIs (response time, scalability, performance, etc.). All APIs developed within GSMA/OPG and contributed to the CAMARA Project will be developed under Apache-2.0.
- Define Service APIs (e.g. by Swagger) and create test plan / cases / tools from a business and API consumer perspective
- Develop Service APIs (and reference implementation for transformation functions)
- Create test cases and perform verification/tests from developer perspective (to show that the Service API / transformation function has been developed correctly)
- Create developer friendly documentation for Service APIs
- Test Service APIs from business/customer perspective (validation) in telco network(s)
- Create deployment packages for Service APIs
- Create a reference architecture for Service APIs (if possible preferred solution is to refer to an existing architecture)
- Define a standard API lifecycle, development and test process incl. tools for the project
The following deliverables are provided by the CAMARA Project:
- Service API code (incl. API descriptions and reference implementation for transformation functions) and documentation and
- Test plan, cases and tools
both contained in deployment packages. In addition a
- Reference architecture for Service APIs
- Description of the standard API lifecycle, development and test process is created.