Consumption reporting¶
Vilocify customers buy different sized packages of API requests and component requests (see MLFBs) that are consumed over a time period. We call this time period the consumption period. The ordered packages cannot be used after the consumption period ends and unused API requests cannot be transferred to the next consumption period. Consumption periods of an organization cannot overlap.
During the consumption period Vilocify tracks consumption based on the API requests that organizations and their users make. Admins can see all usage of all members of their organization in the Portal At the end of a consumption period every admin receives an email with a report detailing the usage of the period. The report includes the overall amount of ordered packages and usage details of every membership. Users can see their own consumption and the overall organization consumption on the dashboard, but cannot see usage of other users.
When the organization runs out of available requests no user of the organization can perform API requests. This includes usage of the Web Portal, because the portal uses the API. There is no enforcement to restrict a single user, or in other words:
Warning
A single user can consume all requests allocated to an organization
What happens when you run out of requests¶
When an organization used up all the ordered reqests, the API will respond with a 402 error code and almost all features in Web UI will be locked.
It is possible to order extensions during a consumption period.
Contact your regional Siemens sales person or open a support ticket.
API Details¶
API Details reagarding consumption reporting and enforcement are documented in the API documentation.
Available MLFBs¶
For our external customers, Vilocify can be procured using MLFB order numbers. These are listed for your reference in the following table.
| Name of the product | MLFB | Description |
|---|---|---|
| API V2 - Small | 9LA1110-1DV14-1AA2 | 36000 API requests for 3 memberships in one organization for one year |
| API V2 - Standard | 9LA1110-1DV14-1AB2 | 300000 API requests for 50 memberships in one organization for one year |
| API V2 - Individual* | 9LA1110-1DV14-1AC2 | individual offer |
| API V2 - Extension | 9LA1110-1DV14-1AD2 | additional 6000 API requests for the current period (only in combination with Small or Standard) |
| API V2 - Initial Setup | 9LA1110-1DV14-2AB2 | Setup organization and 8 hours of technical support |
| API V2 - New component | 9LA1110-1DV14-3AA2 | Mapping or creation of one new component submitted through a component request |
* Please note that individual offers are available upon request.