TM Forum Open API Conformance Testing and Validation Instructions Page


The following guidelines will take you through the various steps needed to run self-testing for your APIs to achieve conformance certification.

Self-Certification is based on the TM Forum Open API conformance profiles, it is the process by which an implementation is confirmed to support the standard definition of a TM Forum Open API.  The TM Forum provides a set of scripts useful to self-certify your implementation of TM Forum Open API specifications. You will need to install and run the applicable API CTK. As of April 2023, there are 59 CTKs available for conformance testing and the list continues to grow steadily.  Currently available conformance profiles and CTKs can be found in our TM Forum Open API portal. 

Appears in the following playbooks



<style>.widget_list {
    margin: 0;
    padding: 0;
}
.widget_list li{
    margin: 0 0 20px;
    padding: 0;
    list-style:none;
}
.widget_list li a{
    display:block;
  color: #000 !important;
    font-weight: 600;
    padding: 10px;
    border:1px solid #ccc;
    background-color:#f6f6f6;
    padding: 25px 25px 25px 80px;
   position:relative;
}
.widget_list li a:hover {
    color: #133595 !important;
    text-decoration: none;
}
.widget_list li a img {
    max-width: 100% !important;
    height: auto !important;
}
.widget_list li a .confluence-embedded-file-wrapper {
    position: absolute;
    width: 50px !important;
    display: block !important;
    left: 10px;
    top: 50%;
    transform: translateY(-50%);
}
</style>



The following instructions describe how to install and run an Open API CTK:  

(This example is covering Product Offering Qualification for the 18.0 Release, but the steps to run a CTK are similar, unless stated on the readme.md that comes with the CTK).

1.

Installing and Running Conformance Test Kit
The CTK is dependent on the installation of node.js and npm to work.
Node.js and NPM can be downloaded and installed from:

>https://nodejs.org/

Once Node.js and npm are installed download and unzip the TMF679-ProductOfferingQualification ZIP file within your test directory.

You should see the following files between many others :

Windows-RUNCTK.ps1

Linux-RUNCTK.sh

2.

For Windows:
Right click Windows-RUNCTK.ps1 and select run with PowerShell, press Y and Enter, wait for the dependencies to be installed go to Step 2.

For Linux and Mac:
You need to give executable permission for the Linux-RUNCTK.sh file, you can do that by opening a terminal and typing:

bash Linux-RUNCTK.sh

Wait for NPM to install the dependencies and go to step 2.

3.

Enter the URL for the base of your API, for example, if you can get a resource on:

https://tm-forum-open-api-reference-implementation.mybluemix.net/tmf-api/productOfferingQualificationManagement/v1/productOfferingQualification

You should input:
https://tm-forum-open-api-reference-implementation.mybluemix.net/tmf-api/productOfferingQualificationManagement/v1

The script will now run for a few minutes and when it ends, you will have a resultsHTML.html file inside the folder, this is the file you need to forward to TMForum to get your certification if your API passed every test, the file should look like this:


If there are no failures then you have passed the CTK and your API is conformant with all
the Mandatory features.

The following link points to the TM Forum Open API Self Certification Web Page in which conformance results are published:  TM Forum Open API Self Certification Web Page

You can also submit a link to your webpage along with your test results . 




<!-- Hotjar Tracking Code for https://projects.tmforum.org/ -->
<script>
    (function(h,o,t,j,a,r){
        h.hj=h.hj||function(){(h.hj.q=h.hj.q||[]).push(arguments)};
        h._hjSettings={hjid:2277887,hjsv:6};
        a=o.getElementsByTagName('head')[0];
        r=o.createElement('script');r.async=1;
        r.src=t+h._hjSettings.hjid+j+h._hjSettings.hjsv;
        a.appendChild(r);
    })(window,document,'https://static.hotjar.com/c/hotjar-','.js?sv=');
</script>