Open APIs

 View Only
  • 1.  Approach to implement one or more of the TMF Open API's

    TM Forum Member
    Posted Dec 06, 2023 23:45

    Hi there,

    I'm still working my way around the various TMF Open API's their intended focus. But one of the things I am struggling with is how organisation might implement one or more of the TMF Open API's.

    Does one only look to use the components that might be needed for their business scenario and extend/tailor where required?

    My feeling is that the API's are really a framework, where some of the structure might be adopted and where others business needs are developed for, within the framework of a particular API to create our own compliant versions of say 622, 629 and 620 etc..

    I ask this question as I have had comments from developers saying it would be hard to implement all of what is contained in the API's.

    So now I am thinking about how I go back to the devs and say this is how we go about leveraging the API for our organisation.

    Many thanks in advance.

    Bryn  



    ------------------------------
    Bryn Langdown
    Aussie Broadband Limited
    ------------------------------


  • 2.  RE: Approach to implement one or more of the TMF Open API's

    TM Forum Member
    Posted Dec 09, 2023 15:25

    Hi Bryn

    It's completely up to you and your organization about how far you want to go in implementing TMF Open APIs. It depends on which business areas your organization covers, and what the expectations are of potential consumers of the APIs.

    For example, if you were creating a digital commerce solution, you would presumably be interested in APIs such as product catalog, product configuration, product offering qualification, shopping cart, product ordering, product inventory, and more. On the other hand, if you are closer to the network, you would be more interested in service catalog, service order, service inventory, resource catalog, resource order, resource inventory, etc.

    Hope it helps



    ------------------------------
    Jonathan Goldberg
    Amdocs Management Limited
    Any opinions and statements made by me on this forum are purely personal, and do not necessarily reflect the position of the TM Forum or my employer.
    ------------------------------



  • 3.  RE: Approach to implement one or more of the TMF Open API's

    TM Forum Member
    Posted Dec 10, 2023 20:56

    Hi Jonathan,

    Thanks for your reply and my apologies if I wasn't quite clear with my question. I guess what I am trying to understand is how much you would utilize/implement from each API. 

    My assumption is that there are mandatory components within, let's say in TMF620 that must be used and some that may not be used and that you would extend where needed. On further investigation, it is also my assumption that IG1228 is a place to start to identify what to use, and that the use cases listed in IG1228 help to determine your approach.

    Regards Bryn



    ------------------------------
    Bryn Langdown
    Aussie Broadband Limited
    ------------------------------



  • 4.  RE: Approach to implement one or more of the TMF Open API's

    TM Forum Member
    Posted Dec 11, 2023 03:23

    Hi Bryn

    The TMF Open APIs are just that, APIs. The published assets describe the contract between the provider/exposer of the API and the consumer.

    There are no "components" in the APIs, and no real implementation.

    Perhaps you are referring to gaining formal certification of conformance to the standard? One of the published assets is a conformance profile, that defines the minimum expectation from an implementation for the API. For example, in TMF620 Product Catalog, we believe that the API implementation must support the entities Product Specification, Product Offering, Product Offering Price. However the other managed entities Catalog, Category, ImportJob, ExportJob are not crucial, and an implementation can gain conformance without implementing these entities.



    ------------------------------
    Jonathan Goldberg
    Amdocs Management Limited
    Any opinions and statements made by me on this forum are purely personal, and do not necessarily reflect the position of the TM Forum or my employer.
    ------------------------------



  • 5.  RE: Approach to implement one or more of the TMF Open API's

    TM Forum Member
    Posted Dec 18, 2023 01:37

    Thanks Jonathan, 

    And my apologies for the late reply, I do believe that things are starting to becoming somewhat clearer to me in regards to how/what we might implement.

    And no I wasn't referring to formal certification, I think I my comment in IG1228 have confused the issue, as we are now starting to use PlantUML to map out some of our use cases..

    Regards Bryn



    ------------------------------
    Bryn Langdown
    Aussie Broadband Limited
    ------------------------------