Open APIs

Expand all | Collapse all

API URL pattern

  • 1.  API URL pattern

    Posted 7 days ago
    Hello

    We are implementing few micro services and their REST API's are as per TMF specifications. We will eventually go through certification process with TMF. However i have few queries regarding it

    Should base URL as per TMF specification to obtain the certification? For instance in TMF 676 Payment management sample POST URL is https://host:port/paymentManagement/v4/payment/.

    However conformance document doesn't mandate anything about base URL rather it simply says POST method should be /payment. So i assume URL can be anything as long as document is at /payment
    I have checked conformance tool kit and url in config.json also has base URL as http://tmf676-payment-v4.mybluemix.net/paymentManagement/v4/. So which also means base URL can be anything as long as document is at /payment and resource is as per TMF spec.

    Is this understanding correct and applicable for all the API's ?

    ------------------------------
    ~Dheeraj Joshi

    Nokia
    dheeraj.joshi@nokia.com
    ------------------------------


  • 2.  RE: API URL pattern

    TM Forum Member
    Posted 6 days ago
    Hi
    To my best understanding, the mandatory part of the endpoint uri starts at the API name, i.e. paymentManagement in your example. All the stuff before (host, port, apiroot) is obviously environment-specific and cannot be expected to be part of the standard.
    But deferring to @Henrique Rodrigues,​ the TMF Open API expert responsible for the conformance test kits.
    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: API URL pattern

    Posted 14 hours ago
    Thanks for the reply Jonathan

    @Henrique Rodrigues Could you please confirm anything till resource identifier (In my example till /payment) is base URL (API root - In my example it would be https://host:port/paymentManagement/v4/) and it can be anything? ​

    ------------------------------
    ~Dheeraj Joshi

    Nokia
    dheeraj.joshi@nokia.com
    ------------------------------