Postman
Here a link to download a postman collection with an exemple of a body of product order allowing to order a new FTTH access (using the others United way APIs to build the body of the order).
You will also find a video explaining how to use this postman collection in order to make an order for FTTH Access.
You will find below the different steps needed to implement a quote and an order process, the corresponding sequence diagram and a postman collection making available an order process to test.
#1 I want to get a quote for a new configuration from a product offering
To implement this use case, the following uses cases are needed:
- I want to create an individual (see Party Management API
- I want to search for an individual and use it as an interlocutor to place a quote (see Party Management API for more information)
- I want to search for my organization to fill it in the quote as the buyer (see Party Management API for more information)
- I want to get the framework of a new product offering (see Product catalog management API for more information)
- I want to search for a collect in product inventory (see Product inventory management API for more information)
- I want to post a quote (see Quote management API for more information)
Below the corresponding sequence diagram:
Each call of API before the post quote enable to enrich the quote body:
- Party management API enables to retrieve the identifers of the party involved in the quote (a party can be an individual or an organization)
- Product Catalog management API enables to get the information necessary to fill the quoteItem of the quote based on the catalog framework:
- the mandatory criteria depending on the offer and the type of operation (acquisition, modification, termination)
- the structure of the offer
- Product Inventory Management API enables to get the identifier of the collect and fill it in the quote Note that the call of the eligibility operator API is not mandatory, but it allows checking upstream that the offer is eligible.
#2 - I want to make an order
To implement this use case, the following uses cases are needed:
- I want to create an individual (see Party Management API for more information)
- I want to search for an individual and use it as an interlocutor to place an order (see Party Management API for more information)
- I want to search for my organization to fill it in the order as the buyer (see Party Management API for more information)
- I want to get the framework of a new product offering (see Product catalog management API for more information)
- I want to search for a collect in product inventory (see Product inventory management API for more information)
- I want to post an order (see Product order management API for more information)
Below the corresponding sequence diagram:
Same as quote creation use case, it is necessary to call the party, catalog and product inventory API to enrich the order body.
Currently, there is no API available allowing to make appointments and search ressources. It is necessary in this case to use the existing web services eRdv and TAO (the documentation for those web services is available in your Espace opérateur: Mon compte> Mon espace documentaire).
Note that the call of the eligibility operator API is not mandatory, but it allows checking upstream that the offer is eligible.