The API provides methods for accessing information.
info/quota
Provides information about contract-based usage limits and permissions.
The following fields are output:
API access
This is only output if the contract allows API access. If this entry is missing, there is no API access.
Possible values:
- Unlimited
Order-API access
Indicates whether the contract allows access to the Order API. The Order API covers the submission and validation of orders via the API.
Possible values:
- true
- false
Individual API calls quota
The configured request limit for individual API integrations under the contract (e.g. ‘10000’). If set to ‘0’, no quota is configured.
Individual API calls last 30 days
Actual API calls from individual API integrations over the last 30 days.
Examples
e.g.: A customer with access to the API, access to the Order API, and a usage of 500 out of 1500
<quotas>
<quota productName="API access">Unlimited</quota>
<quota productName="Order-API access">true</quota>
<quota productName="Individual API calls quota">1500</quota>
<quota productName="Individual API calls last 30 days">500</quota>
</quotas>e.g. customers with access to the API, no access to the Order API, and no contract-based limit on individual API calls
<quotas>
<quota productName="API access">Unlimited</quota>
<quota productName="Order-API access">false</quota>
<quota productName="Individual API calls quota">0</quota>
<quota productName="Individual API calls last 30 days">0</quota>
</quotas>e.g. a customer without access to the API
<quotas>
<quota productName="Order-API access">false</quota>
<quota productName="Individual API calls quota">0</quota>info/schema
Provides the XML schema as an XSD file for the ITscope API types listed here: