From HEXONET Wiki
m (Wording) |
|||
Line 2: | Line 2: | ||
== System Usage Restrictions == | == System Usage Restrictions == | ||
− | To | + | To increase the security and save availability of our network resources, HEXONET users are only allowed to send a limited amount of API requests in a short time period. To regulate the amount of allowed requests we use a quota system, which regulates the API connection by using quota points. |
=== Commands adding quota points === | === Commands adding quota points === | ||
− | Currently, the following commands | + | Currently, the following commands will add quota points to the user account of the user executing them: |
* [[API:CheckDomain | CheckDomain]]: 1 point | * [[API:CheckDomain | CheckDomain]]: 1 point | ||
Line 34: | Line 34: | ||
=== Reducing quota points === | === Reducing quota points === | ||
− | The collected quota points will get reduced automatically by the system. Every 60 seconds, the quota amount will get multiplied | + | The collected quota points will get reduced automatically by the system. Every 60 seconds, the quota amount will get multiplied by 0.8, meaning that your quota point amount gets reduced by 20% every minute. |
=== Quota related XIRCA user relations === | === Quota related XIRCA user relations === |
Revision as of 17:25, 4 September 2015
System Usage Restrictions
To increase the security and save availability of our network resources, HEXONET users are only allowed to send a limited amount of API requests in a short time period. To regulate the amount of allowed requests we use a quota system, which regulates the API connection by using quota points.
Commands adding quota points
Currently, the following commands will add quota points to the user account of the user executing them:
- CheckDomain: 1 point
- CheckDomains: 1 points for each given domain name (DOMAIN# parameter)
- AddDomain: 10 points
- TradeDomain: 10 point
- TransferDomain: 10 point
- CheckDomainApplication: 1 point
- AddContact: 10 points
Soft and hard quota marks
Every HEXONET account has a
- soft quota mark (300 points by default)
- hard quota mark (500 points by default)
If the soft quota mark is reached, the system responses will get a delay of 5 seconds. That means that the response time is slowed down so that the user recognizes that he may sent too many requests within a short time.
If an account reached the hard quota mark, the account will get temporarily locked and the system will respond "Service temporarily locked; usage exceeded". Further API requests will not be accepted and will be answered with this message, although they keep increasing the quota points!
Reducing quota points
The collected quota points will get reduced automatically by the system. Every 60 seconds, the quota amount will get multiplied by 0.8, meaning that your quota point amount gets reduced by 20% every minute.
The following XIRCA user relations exist to use the quota system:
SERVICE_USAGE_DOMAINREGISTRY_HARDQUOTA = (INTEGER)
SERVICE_USAGE_DOMAINREGISTRY_SOFTQUOTA = (INTEGER)
common system quota (currently not used):
SERVICE_USAGE_SYSTEM_HARDQUOTA = (INTEGER)
SERVICE_USAGE_SYSTEM_SOFTQUOTA = (INTEGER)