TM Forum Open APIs Early Adopters | API Specification | Postman Collection | Swagger and Swagger_UI | Reference Implementation Code | Download PDF Specification | Conformance Profile and CTK | Release Status | Frameworx Release version |
---|
Payment Alarm Management APIThis API allows the following operations. Notify of a performed payment, retrieve a list of payments filtered by a given criteria, retrieve a single performed payment, notify of a performed refund, retrieve a list of refunds filtered by a given criteria and retrieve a single performed refund The Alarm Management API applies lessons that were learned in previous generations of similar APIs that were implemented in the Telecommunication industry, starting from ITU recommendations,, TM Forum OSS/J, MTOSI and TIP interfaces, NGMN alignment initiative between 3GPP and TM Forum interfaces, and the more recent ETSI work on requirements for NFV interfaces. | Show If |
---|
| Trackinglink |
---|
Link | https://projects.tmforum.org/wiki/download/attachments/8173515681751327/TMF_PaymentManagement_API_REST_Specification_Proposal_v1draft1CRESTSpec_ALARM-API%20V0-3.docx?version=51&modificationDate=14992670040001502099786000&api=v2 |
---|
Name | Payment Alarm Management API |
---|
| |
|
Show If |
---|
| |
| N/A | Show If |
---|
| Trackinglink |
---|
Type | Swagger |
---|
Link | https://projects.tmforum.org/wiki/download/attachments/81735156/paymentManagementTMF_v0.1.681751327/tmforum-alarm-api-11.0-swagger.json?version=1&modificationDate=14992670250001504604274000&api=v2 |
---|
Name | Payment Alarm Management API |
---|
| |
|
Show If |
---|
| |
| N/A | Show If |
---|
| Trackinglink |
---|
Type | Specification PDF |
---|
Link | https://projects.tmforum.org/wiki/download/attachments/8173515681751327/TMF_PaymentManagement_API_REST_Specification_Proposal_v1draft1CRESTSpec_ALARM-API%20V0-3.pdf?version=1&modificationDate=15050657950001505491066730&api=v2 |
---|
Name | Payment Alarm Management API |
---|
| |
|
Show If |
---|
| |
| Show If |
---|
| Trackinglink |
---|
Type | CTK-Conformance |
---|
Link | https://projects.tmforum.org/wiki/download/attachments/8173515681751327/TMFAlarm_PaymentManagement_ConformanceProfile-v01draft5v05.docx?version=1&modificationDate=14991668130001502099796000&api=v2 |
---|
Name | Payment Alarm Management API |
---|
| |
|
Show If |
---|
| |
| Beta | 17.5.0 |
Resource Catalog Payment Management API | The Resource Catalog Management API REST specification allows the management of the entire lifecycle of the Resource Catalog elements and the consultation of resource catalog elements during several processes such as ordering processThis API allows the following operations. Notify of a performed payment, retrieve a list of payments filtered by a given criteria, retrieve a single performed payment, notify of a performed refund, retrieve a list of refunds filtered by a given criteria and retrieve a single performed refund. | Show If |
---|
| Trackinglink |
---|
Link | https://projects.tmforum.org/wiki/download/attachments/ |
---|
|
|
| 84578548 | TMF634_Resource_Catalog_ManagementTMF_PaymentManagement_API_REST_Specification_Proposal_ |
|
|
| R17 | 5.0. | 2 | 1505206919011 | Resource Catalog | N/A | Show If |
---|
| Trackinglink |
---|
Type | Swagger |
---|
Link | https://projects.tmforum.org/wiki/download/attachments/ |
---|
|
|
| 84578548 | TMF634_Resource_Catalog_Management.regular.swagger-R17.5.0paymentManagementTMF_v0.1.6.json?version=1&modificationDate= |
|
|
| 1504709198000 | Resource Catalog | N/A | | SwaggerUISpecification PDF | Link | https://projects.tmforum.org/wiki/download/attachments/ |
---|
|
|
| 84578548/TMF634_Resource_Catalog_Management.admin.swagger-R17.5.0.json81735156/TMF_PaymentManagement_API_REST_Specification_Proposal_v1draft1C.pdf?version=1&modificationDate= |
|
|
| 1504709206000 | Resource Catalog |
Image Removed Image Removed |
N/A | | Specification PDFCTK-Conformance | Link | https://projects.tmforum.org/wiki/download/attachments/ |
---|
|
|
| 84578548 | TMF634 | Resource_Catalog_Management_API_REST_Specification_R17.5.0.pdfPaymentManagement_ConformanceProfile-v01draft5.docx?version= |
|
|
| 2 | 1505206916249 | Resource Catalog | Beta | 17.5.0 | Performance Management Threshold API Provides a standardized mechanism for performance management such as creation, partial or full update and retrieval of the resources involved in performance management (Measurement Production Job, Measurement Collection Job, and Ad hoc Collection). It allows also notification of events related to performance | Image Removed | | Type | CTK-Conformance | Link | https://projects.tmforum.org/wiki/download/attachments/ |
---|
|
|
| 84578548 | Resource | Catalog_Management | Conformance_Profile_R17.5.0Specification-v0.9.docx?version= |
|
|
| 1 | 1504709255000 | Resource Catalog Performance Management Thresholding API |
| |
|
|
Image Removed Image Removed |
Beta | 17.5.0 | Resource Inventory Management API
The intent of this API is to provide a consistent/standardized mechanism to query and manipulate the Resource inventory. | N/A | Show If |
---|
| Trackinglink |
---|
Type | Swagger |
---|
Link | https://projects.tmforum.org/wiki/download/attachments/84579888/TMF639_Resource_Inventory_Management_REST_API_Specification_R17.5.0.docx?version=2&modificationDate=150530741100084579944/tmforum-open-api-PMThreshold-swagger-v0.9.json?version=1&modificationDate=1505504851000&api=v2 |
---|
Name | Usage Consumption Performance Management Thresholding API |
---|
| |
| Image Removed | N/A | Show If |
---|
| Trackinglink |
---|
Type | SwaggerSpecification PDF |
---|
Link | https://projects.tmforum.org/wiki/download/attachments/84579888/Resource_Inventory_Management.regular.swagger.json84579944/Performance_Threshold_API_REST_Specification-v0.9.pdf?version=1&modificationDate=15053071740001505504835000&api=v2 |
---|
Name | Usage Consumption Performance Management Thresholding API |
---|
| | trackinglink
Type SwaggerUI |
| N/A | Beta | 17.5.0 | Resource Catalog Management API The Resource Catalog Management API REST specification allows the management of the entire lifecycle of the Resource Catalog elements and the consultation of resource catalog elements during several processes such as ordering process. | Show If |
---|
| Trackinglink |
---|
Link | https://projects.tmforum.org/wiki/download/attachments/ |
---|
|
|
| 8457988884578548/TMF634_Resource_ |
|
|
| Inventory | .admin.swagger.json_API_REST_Specification_R17.5.0.docx?version= |
|
|
| 1 | 15053071740001505206919011&api=v2 | Name | Resource |
---|
|
|
| Inventory |
|
| Image Removed | Image Removed
N/A | | Specification PDFSwagger | Link | https://projects.tmforum.org/wiki/download/attachments/ |
---|
|
|
| 84579888 | TMF639 | Inventory | _REST_API_Specification_.regular.swagger-R17.5.0. |
|
|
| pdf | 2 | 1505485999237 | Usage Consumption |
Show If |
---|
|
Trackinglink |
---|
| Type | CTK-Conformance | Link | https://projects.tmforum.org/wiki/download/attachments/ |
---|
|
|
| 8457988884578548/TMF634_Resource_ |
|
|
| Inventory | _Conformance_Profile | docx | 2 | 1505307417000 | Usage Consumption |
| Image Removed | Image Removed | Beta | 17.5.0 | N/A | Service Catalog Management API The Service Catalog Management API allows the management of the entire lifecycle of the service catalog elements. | Show If |
---|
| Trackinglink |
---|
Type | Specification PDF |
---|
Link | https://projects.tmforum.org/wiki/download/attachments/8457853284578548/TMF633TMF634_ServiceResource_Catalog_Management_API_REST_Specification_R17.5.0.docxpdf?version=12&modificationDate=15047084360001505206916249&api=v2 |
---|
Name | Service Resource Catalog API |
---|
| |
| Image Removed | N/A | Show If |
---|
| Trackinglink |
---|
Type | SwaggerCTK-Conformance |
---|
Link | https://projects.tmforum.org/wiki/download/attachments/8457853284578548/TMF633_ServiceResource_Catalog_Management.regular.swagger_API_REST_Conformance_Profile_R17.5.0.jsondocx?version=1&modificationDate=15047085720001504709255000&api=v2 |
---|
Name | Service Resource Catalog API |
---|
| | Trackinglink |
---|
Type | SwaggerUI |
|
| Beta | 17.5.0 | Resource Inventory Management API The intent of this API is to provide a consistent/standardized mechanism to query and manipulate the Resource inventory. | Show If |
---|
| Trackinglink |
---|
Link | https://projects.tmforum.org/wiki/download/attachments/ |
---|
|
|
| 84578532 | TMF633 | Service | Catalog | .admin.swagger_REST_API_Specification_R17.5.0. |
|
|
| json | 1 | 1504708589000 | Service Catalog | Image Removed
Image Removed | N/A | | Specification PDFSwagger | Link | https://projects.tmforum.org/wiki/download/attachments/ |
---|
|
|
| 84578532 | TMF633 | Service_Catalog | _API_REST_Specification_R17.0.pdf.regular.swagger.json?version=1&modificationDate=1505307174000&api=v2 | Name | Usage Consumption API |
---|
| |
Trackinglink |
---|
Type | SwaggerUI |
---|
Link | https://projects.tmforum.org/wiki/download/attachments/84579888/Resource_Inventory_Management.admin.swagger.json?version=1&modificationDate= |
---|
|
|
| 1505125520514 | Service Catalog | Image Removed | N/A | | CTK-ConformanceSpecification PDF | Link | https://projects.tmforum.org/wiki/download/attachments/ |
---|
|
|
| 84578532 | Service | CatalogInventory_Management_REST_API_ |
|
|
| Conformance_Profile | docx | 1 | 1504708603000 | Service Catalog | Image Removed | Image Removed | Beta | 17.5.0 | Usage Consumption Management API This API should allow to view in real-time the balance of the various buckets (SMS, Voice, Data for example) that an user consumes with each of his devices and the usages done out of the bucket. An usage report retrieve the data related to these balances. This API should also allow to perform a direct topup on the balance of a prepaid bucket with voucher references or with a given credit value after a payment done by a credit card or with a credit value transfered. | | | Show If |
---|
| Trackinglink |
---|
| Link | https://projects.tmforum.org/wiki/download/attachments/8173601684579888/TMFResource_UsageInventory_ConsumptionManagement_API_REST_Specification_1Conformance_Profile-R17.5.0-06092017.docx?version=12&modificationDate=15046921760001505307417000&api=v2 |
---|
Name | Usage Consumption API |
---|
| |
|
Image Removed | N/A | Beta | 17.5.0 |
Service Catalog Management API The Service Catalog Management API allows the management of the entire lifecycle of the service catalog elements. | | Type | Swagger |
---|
Link | https://projects.tmforum.org/wiki/download/attachments/ |
---|
|
|
| 81736016/usageConsumption_swagger_06092017.json84578532/TMF633_Service_Catalog_Management_API_REST_Specification_R17.0.docx?version=1&modificationDate= |
|
|
| 1504692203000 | Usage Consumption | Image Removed
Image Removed | N/A | | Specification PDFSwagger | Link | https://projects.tmforum.org/wiki/download/attachments/ |
---|
|
|
| 81736016 | TMF | Usage | Consumption_API_REST_Specification_1.0-06092017.pdfCatalog_Management.regular.swagger_R17.0.json?version=1&modificationDate= |
|
|
| 1505066778000 | Usage Consumption | show-if | special | @anonymous |
---|
Image Removed |
Show If |
---|
|
Trackinglink |
---|
Type | CTK-Conformance |
---|
Link | https://projects.tmforum. |
---|
|
|
| Link | https://projects.tmforum.org/wiki/download/attachments/ |
|
|
| 81736016/UsageConsumption_ConformanceProfile-v101draft5-0609017.docx84578532/TMF633_Service_Catalog_Management.admin.swagger_R17.0.json?version=1&modificationDate= |
|
|
| 1504881055000 | Usage Consumption | Image Removed | Image Removed
Beta | 17.5.0 | Alarm Management API
The Alarm Management API applies lessons that were learned in previous generations of similar APIs that were implemented in the Telecommunication industry, starting from ITU recommendations,, TM Forum OSS/J, MTOSI and TIP interfaces, NGMN alignment initiative between 3GPP and TM Forum interfaces, and the more recent ETSI work on requirements for NFV interfaces. | N/A | Show If |
---|
| Trackinglink |
---|
Type | Specification PDF |
---|
Link | https://projects.tmforum.org/wiki/download/attachments/ |
---|
|
|
| 81751327/RESTSpec_ALARM-API%20V0-3.docx84578532/TMF633_Service_Catalog_Management_API_REST_Specification_R17.0.pdf?version=1&modificationDate= |
|
|
| 1502099786000 | Alarm Management API | |
| Image Removed |
N/A | | SwaggerCTK-Conformance | Link | https://projects.tmforum.org/wiki/download/attachments/ |
---|
|
|
| 81751327/tmforum-alarm-api-11.0-swagger.json84578532/Service_Catalog_Management_API_Conformance_Profile_R17.0.docx?version=1&modificationDate= |
|
|
| 1504604274000 | Alarm Management API | |
| Beta | 17.5.0 | Usage Consumption Management API This API should allow to view in real-time the balance of the various buckets (SMS, Voice, Data for example) that an user consumes with each of his devices and the usages done out of the bucket. An usage report retrieve the data related to these balances. This API should also allow to perform a direct topup on the balance of a prepaid bucket with voucher references or with a given credit value after a payment done by a credit card or with a credit value transfered. |
Image Removed Image Removed |
N/A | Show If |
---|
| Trackinglink | Type |
---|
Specification PDF | Link | https://projects.tmforum.org/wiki/download/attachments/81751327/RESTSpec_ALARM-API%20V0-3.pdf81736016/TMF_Usage_Consumption_API_REST_Specification_1.0-06092017.docx?version=1&modificationDate=15054910667301504692176000&api=v2 |
---|
Name | Alarm Management Usage Consumption API |
---|
| |
| Image Removed | N/A | Show If |
---|
| Trackinglink |
---|
Type | CTK-ConformanceSwagger |
---|
Link | https://projects.tmforum.org/wiki/download/attachments/8175132781736016/Alarm_ConformanceProfile-v05.docxusageConsumption_swagger_06092017.json?version=1&modificationDate=15020997960001504692203000&api=v2 |
---|
Name | Alarm Management API |
---|
| |
|
| Beta | 17.5.0 | Performance Management Threshold API
Provides a standardized mechanism for performance management such as creation, partial or full update and retrieval of the resources involved in performance management (Measurement Production Job, Measurement Collection Job, and Ad hoc Collection). It allows also notification of events related to performance | N/A | Show If |
---|
| Trackinglink |
---|
Type | Specification PDF |
---|
Link | https://projects.tmforum.org/wiki/download/attachments/81751327/RESTSpec_ALARM-API%20V0-3.docx81736016/TMF_Usage_Consumption_API_REST_Specification_1.0-06092017.pdf?version=1&modificationDate=15020997860001505066778000&api=v2 |
---|
Name | Performance Management Thresholding API |
---|
| | |
|
Image Removed | | N/A | N/A | N/A | | Show If |
---|
| Trackinglink |
---|
Type | Specification PDFCTK-Conformance |
---|
Link | https://projects.tmforum.org/wiki/download/attachments/8457994481736016/Performance_Threshold_API_REST_Specification%200.5.pdfUsageConsumption_ConformanceProfile-v101draft5-0609017.docx?version=1&modificationDate=15054915787721504881055000&api=v2 |
---|
Name | Performance Management Thresholding API |
---|
| | |
N/A | Beta | 17.5.0 |