Open APIs

 View Only

  • 1.  How to adopt Open API?

    Posted Jul 26, 2019 12:17
    Dear Members,

    Please advise as to how could I adopt Open API, or at least just one API to begin with, for example, Trouble Ticket API. Assume that the CSP is not compliant to TMF's Frameworx. 

    When I am adopting Open API, what is it that I'm really adopting?

    I truly appreciate your time and reply.

    Thanks,
    Madhan

    ------------------------------
    Madhanram
    Enterprise Architect
    ------------------------------


  • 2.  RE: How to adopt Open API?

    TM Forum Member
    Posted Jul 29, 2019 06:01
    Hi Madhandram

    The TM Forum Open API program specifies APIs (using REST) over a wide range of telecommunications functionality. The program defines interfaces that standardize communication between API provider and consumer, it does not mandate functional architecture of the consumer.

    A good place to start would be the https://projects.tmforum.org/wiki/display/API/Open+API+Table. You can find here all the assets for the Open APIs, most importantly the swagger file and specification document for each API. The swagger gives you the technical definition of the API, and the spec expands on that by giving use cases, usage instructions, and example payloads. In addition you could look at the quick start page. for more information.

    Let's suppose that you want to provide and API, specifically you want to expose the Trouble Ticket API over your current trouble ticketing system. I would approach this by mapping the functionality that your current system exposes (hopefully with existing documented APIs) and translating this into the corresponding functionality defined in TMF 621 Trouble Ticket Management. This would include mapping between the Open API data model and your underlying API model, and the functional operations.

    You would then design and implement a software layer running on a suitable platform (e.g. Spring Boot if Java is your thing, but there are surely many platforms out there) which exposes the Open API as per the swagger file, and does the transformation to your underlying API set. This might be a trivial attribute mapping (if you are lucky) or need more complex orchestration between APIs in the more likely case.

    Hope it helps


    ------------------------------
    Jonathan Goldberg
    Amdocs Management Limited
    ------------------------------

    Original Message


  • 3.  RE: How to adopt Open API?

    Posted Jul 29, 2019 06:04
    Hi Madhan,

    I am in a similar position - wanting to adopt a single (perhaps 2) Open API's. For me this is for a Marketplace platform that I provide.

    You are registering an existing API to be conformant with Open API standards. You do not need to have full TMF Frameworx compliance.

    There is a cost (~$950) to register/certify a single API. You will need to
    - access the Open API's CTK specification
    - follow instructions
    - run the CTK script
    - share the report with TMF for review and validation. 

    This link will be helpful: https://www.tmforum.org/conformance-certification/open-api-conformance/

    Thanks,
    David.


    ------------------------------
    David Berlin
    Mercato
    ------------------------------

    Original Message