Open APIs

Dear All,

I am totally new to OpenAPI.

I want to use billingManagementApi. for this I got bunch of collection. Now to test it using the postman tool, how I will get the hostname and port? Could you please tell me?

Thanks,
Vikram Gharge

------------------------------
Vikram Gharge
TO BE VERIFIED
------------------------------

Hi Vikram

Can you give some more details about what you are trying to do?

• Which API are you looking at, we have for example Account Management TMF666, Customer Bill Management TMF678, is it one of these or a different one?
• Are you trying to use the API as a consumer (i.e. to invoke API operations) against some existing implementation, or rather are you trying to implement the API as a provider and test your implementation.

These clarifications can help the community to assist in your query.

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

Original Message:
Sent: Apr 01, 2022 06:04
From: Vikram Gharge
Subject: Hostname and Port

Dear All,

I am totally new to OpenAPI.

I want to use billingManagementApi. for this I got bunch of collection. Now to test it using the postman tool, how I will get the hostname and port? Could you please tell me?

Thanks,
Vikram Gharge

------------------------------
Vikram Gharge
TO BE VERIFIED
------------------------------

Hi Sir,

Thanks for the updates.

I want to use Customer Bill Management TMF678 API

I want to try to use API as a consumer (i.e. to invoke API operations) against some existing implementations.

I need help on the below things. Below is one of the APIs from the list of provided postman collections.

{{scheme}}://{{host}}:{{port}}/tmf-api/customerBillManagement/v4/customerBillOnDemand?fields={{fields}}&offset={{offset}}&limit={{limit}}

This API is given by the TM forum is for "List or Find Customer BillOndemand"

I want to use this API but, I am not getting what will be {host} and {port} and how to configure it. Could you please tell me from where I will get this?

Please see attachment.

Thanks,

------------------------------
Vikram Gharge
TO BE VERIFIED
------------------------------

Original Message:
Sent: Apr 03, 2022 10:17
From: Jonathan Goldberg
Subject: Hostname and Port

Hi Vikram

Can you give some more details about what you are trying to do?

• Which API are you looking at, we have for example Account Management TMF666, Customer Bill Management TMF678, is it one of these or a different one?
• Are you trying to use the API as a consumer (i.e. to invoke API operations) against some existing implementation, or rather are you trying to implement the API as a provider and test your implementation.

These clarifications can help the community to assist in your query.

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

Original Message:
Sent: Apr 01, 2022 06:04
From: Vikram Gharge
Subject: Hostname and Port

Dear All,

I am totally new to OpenAPI.

I want to use billingManagementApi. for this I got bunch of collection. Now to test it using the postman tool, how I will get the hostname and port? Could you please tell me?

Thanks,
Vikram Gharge

------------------------------
Vikram Gharge
TO BE VERIFIED
------------------------------

Hi Vikram

Thanks for your response
First, I advise you to read the API user guide carefully for this API. It might also assist you to read the design guidelines for (published as TMF630) to get an understanding of what Task Resources are and why we use them.
Specifically, BillOnDemand is a task resource that allows the consumer to submit a request to generate a bill/invoice out of the normal (typically monthly) billing cycle.

In order to invoke an API operation, you need to access an existing implementation. Typically implementations are done by vendors (such as Amdocs and our competitors) or CSPs themselves, as part of specific transformation projects - these will not be open to random public use. The TM Forum does provide a reference implementation of APIs, but there is no real business logic or data behind this reference implementation. Specifically for this API, you might succeed in submitting (POSTing) a BillOnDemand request, but don't imagine that a bill will be generated as a result.

I refer you to @Victor Mari or @Henrique Rodrigues for assistance in accessing the reference implementation.​​​

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

Original Message:
Sent: Apr 04, 2022 06:19
From: Vikram Gharge
Subject: Hostname and Port

Hi Sir,

Thanks for the updates.

I want to use Customer Bill Management TMF678 API

I want to try to use API as a consumer (i.e. to invoke API operations) against some existing implementations.

I need help on the below things. Below is one of the APIs from the list of provided postman collections.

{{scheme}}://{{host}}:{{port}}/tmf-api/customerBillManagement/v4/customerBillOnDemand?fields={{fields}}&offset={{offset}}&limit={{limit}}

This API is given by the TM forum is for "List or Find Customer BillOndemand"

I want to use this API but, I am not getting what will be {host} and {port} and how to configure it. Could you please tell me from where I will get this?

Please see attachment.

Thanks,

------------------------------
Vikram Gharge
TO BE VERIFIED

Original Message:
Sent: Apr 03, 2022 10:17
From: Jonathan Goldberg
Subject: Hostname and Port

Hi Vikram

Can you give some more details about what you are trying to do?

• Which API are you looking at, we have for example Account Management TMF666, Customer Bill Management TMF678, is it one of these or a different one?
• Are you trying to use the API as a consumer (i.e. to invoke API operations) against some existing implementation, or rather are you trying to implement the API as a provider and test your implementation.

These clarifications can help the community to assist in your query.

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

Original Message:
Sent: Apr 01, 2022 06:04
From: Vikram Gharge
Subject: Hostname and Port

Dear All,

I am totally new to OpenAPI.

I want to use billingManagementApi. for this I got bunch of collection. Now to test it using the postman tool, how I will get the hostname and port? Could you please tell me?

Thanks,
Vikram Gharge

------------------------------
Vikram Gharge
TO BE VERIFIED
------------------------------

Hi Sir,

Thanks for the quick help.

I will go through the mentioned API guidelines for sure.

Could you please elaborate on the line mentioned by you in the earlier reply? 
The line is - "Typically implementations are done by vendors (such as Amdocs and our competitors) or CSPs themselves, as part of specific transformation projects - these will not be open to random public use. "

Based on the above-mentioned line. Below is my understanding:
1. I want to use Customer Bill Management TMF678 API. This I need to use to get customer billing data from one of the telecom companies (e.g. Orange telecom) 
2. Before using APIs, I want hostname, port, and other configuration details. To get the hostname, port, and other configuration details I need to contact "Orange Telecom", right?
3. Could you please tell me, how I can contact them for the details of implementations (hostname, port, and other configuration)? is there any portal where I can request the details?
4. Once I will get implementation details(hostname, port, and other configuration) from the telecom company then I can use the provided APIs (Postman collection), right?

Thanks,

------------------------------
Vikram Gharge
TO BE VERIFIED
------------------------------

Original Message:
Sent: Apr 04, 2022 07:23
From: Jonathan Goldberg
Subject: Hostname and Port

Hi Vikram

Thanks for your response
First, I advise you to read the API user guide carefully for this API. It might also assist you to read the design guidelines for (published as TMF630) to get an understanding of what Task Resources are and why we use them.
Specifically, BillOnDemand is a task resource that allows the consumer to submit a request to generate a bill/invoice out of the normal (typically monthly) billing cycle.

In order to invoke an API operation, you need to access an existing implementation. Typically implementations are done by vendors (such as Amdocs and our competitors) or CSPs themselves, as part of specific transformation projects - these will not be open to random public use. The TM Forum does provide a reference implementation of APIs, but there is no real business logic or data behind this reference implementation. Specifically for this API, you might succeed in submitting (POSTing) a BillOnDemand request, but don't imagine that a bill will be generated as a result.

I refer you to @Victor Mari or @Henrique Rodrigues for assistance in accessing the reference implementation.​​​

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

Original Message:
Sent: Apr 04, 2022 06:19
From: Vikram Gharge
Subject: Hostname and Port

Hi Sir,

Thanks for the updates.

I want to use Customer Bill Management TMF678 API

I want to try to use API as a consumer (i.e. to invoke API operations) against some existing implementations.

I need help on the below things. Below is one of the APIs from the list of provided postman collections.

{{scheme}}://{{host}}:{{port}}/tmf-api/customerBillManagement/v4/customerBillOnDemand?fields={{fields}}&offset={{offset}}&limit={{limit}}

This API is given by the TM forum is for "List or Find Customer BillOndemand"

I want to use this API but, I am not getting what will be {host} and {port} and how to configure it. Could you please tell me from where I will get this?

Please see attachment.

Thanks,

------------------------------
Vikram Gharge
TO BE VERIFIED

Original Message:
Sent: Apr 03, 2022 10:17
From: Jonathan Goldberg
Subject: Hostname and Port

Hi Vikram

Can you give some more details about what you are trying to do?

• Which API are you looking at, we have for example Account Management TMF666, Customer Bill Management TMF678, is it one of these or a different one?
• Are you trying to use the API as a consumer (i.e. to invoke API operations) against some existing implementation, or rather are you trying to implement the API as a provider and test your implementation.

These clarifications can help the community to assist in your query.

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

Original Message:
Sent: Apr 01, 2022 06:04
From: Vikram Gharge
Subject: Hostname and Port

Dear All,

I am totally new to OpenAPI.

I want to use billingManagementApi. for this I got bunch of collection. Now to test it using the postman tool, how I will get the hostname and port? Could you please tell me?

Thanks,
Vikram Gharge

------------------------------
Vikram Gharge
TO BE VERIFIED
------------------------------

Hi Vikram
Telcos are not going to be opening their information systems and exposing APIs to anyone from outside who just "wants" to invoke APIs. There are security and privacy concerns.
You will have to have a valid reason and business case, and make this case to the relevant people in the telco.
It's really difficult to help you more without understanding what your motives are, what exactly are you trying to, what business you represent, etc.
But since you mention Orange, they have a developer portal here https://developer.orange.com/
Maybe you will find some assistance there.

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

Original Message:
Sent: Apr 05, 2022 08:34
From: Vikram Gharge
Subject: Hostname and Port

Hi Sir,

Thanks for the quick help.

I will go through the mentioned API guidelines for sure.

Could you please elaborate on the line mentioned by you in the earlier reply?
The line is - "Typically implementations are done by vendors (such as Amdocs and our competitors) or CSPs themselves, as part of specific transformation projects - these will not be open to random public use. "

Based on the above-mentioned line. Below is my understanding:
1. I want to use Customer Bill Management TMF678 API. This I need to use to get customer billing data from one of the telecom companies (e.g. Orange telecom)
2. Before using APIs, I want hostname, port, and other configuration details. To get the hostname, port, and other configuration details I need to contact "Orange Telecom", right?
3. Could you please tell me, how I can contact them for the details of implementations (hostname, port, and other configuration)? is there any portal where I can request the details?
4. Once I will get implementation details(hostname, port, and other configuration) from the telecom company then I can use the provided APIs (Postman collection), right?

Thanks,

------------------------------
Vikram Gharge
TO BE VERIFIED

Original Message:
Sent: Apr 04, 2022 07:23
From: Jonathan Goldberg
Subject: Hostname and Port

Hi Vikram

Thanks for your response
First, I advise you to read the API user guide carefully for this API. It might also assist you to read the design guidelines for (published as TMF630) to get an understanding of what Task Resources are and why we use them.
Specifically, BillOnDemand is a task resource that allows the consumer to submit a request to generate a bill/invoice out of the normal (typically monthly) billing cycle.

In order to invoke an API operation, you need to access an existing implementation. Typically implementations are done by vendors (such as Amdocs and our competitors) or CSPs themselves, as part of specific transformation projects - these will not be open to random public use. The TM Forum does provide a reference implementation of APIs, but there is no real business logic or data behind this reference implementation. Specifically for this API, you might succeed in submitting (POSTing) a BillOnDemand request, but don't imagine that a bill will be generated as a result.

I refer you to @Victor Mari or @Henrique Rodrigues for assistance in accessing the reference implementation.​​​

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

Original Message:
Sent: Apr 04, 2022 06:19
From: Vikram Gharge
Subject: Hostname and Port

Hi Sir,

Thanks for the updates.

I want to use Customer Bill Management TMF678 API

I want to try to use API as a consumer (i.e. to invoke API operations) against some existing implementations.

I need help on the below things. Below is one of the APIs from the list of provided postman collections.

{{scheme}}://{{host}}:{{port}}/tmf-api/customerBillManagement/v4/customerBillOnDemand?fields={{fields}}&offset={{offset}}&limit={{limit}}

This API is given by the TM forum is for "List or Find Customer BillOndemand"

I want to use this API but, I am not getting what will be {host} and {port} and how to configure it. Could you please tell me from where I will get this?

Please see attachment.

Thanks,

------------------------------
Vikram Gharge
TO BE VERIFIED

Original Message:
Sent: Apr 03, 2022 10:17
From: Jonathan Goldberg
Subject: Hostname and Port

Hi Vikram

Can you give some more details about what you are trying to do?

• Which API are you looking at, we have for example Account Management TMF666, Customer Bill Management TMF678, is it one of these or a different one?
• Are you trying to use the API as a consumer (i.e. to invoke API operations) against some existing implementation, or rather are you trying to implement the API as a provider and test your implementation.

These clarifications can help the community to assist in your query.

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

Original Message:
Sent: Apr 01, 2022 06:04
From: Vikram Gharge
Subject: Hostname and Port

Dear All,

I am totally new to OpenAPI.

I want to use billingManagementApi. for this I got bunch of collection. Now to test it using the postman tool, how I will get the hostname and port? Could you please tell me?

Thanks,
Vikram Gharge

------------------------------
Vikram Gharge
TO BE VERIFIED
------------------------------