Open APIs

 View Only
  • 1.  TMF620 - Product Catalog Management API - "Internal Server Error

    Posted Apr 20, 2022 09:37
    Hello,

    I downloaded the Postman collection, along with the Postman environment file for the TMF620 - Product Catalog Management API.
    But no matter which API call I try to test, I always receive the following response:

    {

    "code": 1,

    "reason": "Internal Server Error",

    "message": "Internal database error"

    }

    For example, I am trying to call:

    {{Product_Catalog_API}}/tmf-api/productCatalogManagement/v4/catalog?fields=name&offset=1&limit=10
    where Product_Catalog_API has the value of "https://api-product-catalog-v4-0-0.mybluemix.net"
    Am I doing something wrong? I did not change anything in the Environment variables.



    ------------------------------
    Paul Isaris
    TO BE VERIFIED
    ------------------------------


  • 2.  RE: TMF620 - Product Catalog Management API - "Internal Server Error

    TM Forum Member
    Posted 29 days ago
    Hi Paul
    Please clarify - are you trying to invoke your own implementation of the product catalog API? I guess from the URL (mybluemix.net - goes to IBM Bluemix) that this is the case. The error message is presumably coming either from the Bluemix platform or from your implementation, so perhaps you need to examine the root cause of the error message.
    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: TMF620 - Product Catalog Management API - "Internal Server Error

    Posted 27 days ago

    Hello Jonathan,

    Thanks for your answer. As a matter of fact, I am new to the TMI Forum API, so I haven't set up my own implementation.
    I just downloaded the Postman collection in order to see how the API works.
    Do I need to set up my own implementation of the TMI Forum in order to use the API?
    About the IBM Bluemix you referred to, is this an implementation of the TMI Forum that IBM has set up?

    Best,

    Paul 



    ------------------------------
    Paul Isaris
    TO BE VERIFIED
    ------------------------------



  • 4.  RE: TMF620 - Product Catalog Management API - "Internal Server Error

    TM Forum Member
    Posted 26 days ago
    Hi Paul
    I have no idea who owns the Bluemix end-point.
    In principle, many APIs have what is called a reference implementation (RI) hosted by TMF, but I have never used an RI and I don't know how to access. Perhaps @Victor Mari can assist.
    Good luck​

    ------------------------------
    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: TMF620 - Product Catalog Management API - "Internal Server Error

    Posted 26 days ago
    Dear Jonathan,

    So, just to understand, do I need also a server implementation of the TMI Forum, in order to use the Open API? Or just a client? (For example the Postman collections that are available on the Open API Table page)?
    I am trying to find out if I need to set up a new instance of the TMI Forum backend in order to use the Open APIs, against that back-end.

    Thanks,
    Paul

    ------------------------------
    Paul Isaris
    TO BE VERIFIED
    ------------------------------



  • 6.  RE: TMF620 - Product Catalog Management API - "Internal Server Error

    TM Forum Member
    Posted 25 days ago
    Without an implementation, an API definition (swagger, user guide) is a good way to give a common vocabulary to talk e.g. about business flows and persistent entities. But at the end of the day we want working software, and this means that if you want to invoke an API operation (e.g. POST Customer to create a customer) you will need some piece of software that has implemented and exposed the operation (and of course actually does the business work implied by the operation).

    ------------------------------
    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.
    ------------------------------



  • 7.  RE: TMF620 - Product Catalog Management API - "Internal Server Error

    Posted 20 days ago
    I'm sorry, but just to make sure that I understand correctly. I want to write a client application that will use the TMF620 - Product Catalog Management API.
    I would like to use this in order to store information about Products (product catalogue and product categories).
    So I would use the TMI Forum APIs as the backend and I would only write client-side code.
    This would save me development time. Τ
    t seems that there is no available server up and running in order to do so. Is this correct?
    Or are there available docker images that I could use, for example, in order to initialize a server that utilizes the TMF620 - Product Catalog Management API?

    ------------------------------
    Paul Isaris
    TO BE VERIFIED
    ------------------------------



  • 8.  RE: TMF620 - Product Catalog Management API - "Internal Server Error

    TM Forum Member
    Posted 20 days ago
    Hi Paul
    As I mentioned earlier, TMF does have a reference implementation for its published APIs. You could download this and (hopefully) run it on a convenient server. At some point TMF also had a sandbox hosting API implementations, but I have no idea whether this still exists, and if TMF620 is included there, calling out @Victor Mari for assistance.
    It's unlikely that you will find a random running implementation of ​Open APIs "out there on the internet". Vendors (like Amdocs, Velocity, and others) have implemented such APIs, and some service providers have probably done so as well. But these will not be open to the outside world, for obvious reasons.
    Good luck with your journey.

    ------------------------------
    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.
    ------------------------------



  • 9.  RE: TMF620 - Product Catalog Management API - "Internal Server Error

    TM Forum Member
    Posted 20 days ago
    Hi @Paul Isaris,

    You can download and run locally the reference implementation from the API table here:​ https://projects.tmforum.org/wiki/display/API/Open+API+Table.

    The ris come with a dockerfile so you can run them using docker or docker compose.

    Here is an example on how you can run the api with a mongoDB database using docker compose. The api will be available at "http://localhost:8620
    /tmf-api/productCatalogManagement/v4/". You will need to put the path to the ri dockerfile and then do "docker-compose up".

    services:
        mongo:
            image: mongo:4.4.6
            ports: ['27017:27017']
            volumes: ['ri_persistance:/data/db']
        tmf655:
            build: path/to/dockerfile
            image: tmforumorg/api-changemanagement_tmf-655:4.0.0
            ports: ['8620:8080']
            stdin_open: true
            tty: true
    version: '3.9'
    volumes:
        ctk_data: {}
    


    ------------------------------
    Victor Rodriguez
    TM Forum
    ------------------------------



  • 10.  RE: TMF620 - Product Catalog Management API - "Internal Server Error

    Posted 18 days ago
    Edited by Paul Isaris 18 days ago
    Hello @Victor Rodriguez,
    Thanks for your answer. I went and downloaded the sample implementation code for the "Product Catalog Management API", but there is no Dockerfile inside. It has the following:


    Even though in README.md it says "start local mongoDB (or change /service/config.json file for external mongoDB)", there is no service/config.json file.
    Do you know where I can find the Dockerfile? Also, the code that you wrote in your answer must go in a docker-compose.yml file that I will create from scratch, correct?

    Best,
    Paul

    ------------------------------
    Paul Isaris
    TO BE VERIFIED
    ------------------------------



  • 11.  RE: TMF620 - Product Catalog Management API - "Internal Server Error

    TM Forum Member
    Posted 18 days ago
    Hi @Paul Isaris,

    You are correct the the code I wrote should go in a docker-compose.yaml file ideally at the root of the folder next to the dockerfile. With that configuration the path in the build attribute of the compose file should be only a dot ".".

    Thanks for letting me know about the missing dockerfile. There is an updated version of the RI available in the table.

    Best Regards,

    Victor Mari

    ------------------------------
    Victor Rodriguez
    TM Forum
    ------------------------------