Overview
The RS-ORDER microservice is the main service of the set of Restitution Services (Functional overview).
The RS-ORDER microservice allows authenticated users to order files from the REGARDS catalog and download them.
To do so, RS-ORDER provides these functionalities:
- an user basket - you can add a selection of catalog products to your cart and order them later
- create order - you can transform your user basket selection into an order
- retrieve order status - the order may be running or even wait for user to download a subset of the order (SubOrders)
- download ordered files
- process ordered files - your ordered files can be reprocessed before you download them
There is no limit on the number of files or the size of the files that users can order. However, if the order is too large, it will be divided into multiple groups of files, which we call Suborders. In this case, the user must retrieve the available files from the completed Suborder before the next one can be processed by the system.
Users are subject to download quotas : max quota and rate quota. You can find more explanation of these quotas in the user parameters configuration
| Concept | Compatibility | Description |
|---|---|---|
| Multitenant | Yes | Can handle multiple tenants/projects |
| Vertical scalability | Yes | Uses Jobs system |
| Horizontal scalability | No | Service can not be deployed with multiple instances |
You can learn how the service works with the How it works section.
How to use
You can learn how to operate with the microservice thanks to the API Guides :
- Create Order using REST API or using AMQP API show you how to create a basket selection and create the order in a single request. Recommended for interoperability since v1.12
- Get Order status using REST API or progress threw AMQP API show you how to create a basket selection and create the order in a single request. Recommended for interoperability since v1.12
- Download ordered files using REST API
- Browse all REST API available endpoints.
How to configure
To learn how the microservice is configured with static parameters from properties files see Configuration section.
To understand the configuration of specific tenant (aka project) see Import/export configuration section.
How to access through UI
You can follow the User manuel to learn about the administrator UI related functionalities :
How to access source code
Microservice source code is available on GitHub.