cartodb4/dataservices-api
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update quota_management.md

Browse Source
This commit is contained in:
Carla 2016-05-17 16:05:47 +02:00
parent eb6fe79a4c
commit 8a8a5e11b5
1 changed files with 16 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
doc/internal/quota_management.md
View File

@ -3,22 +3,22 @@ All the services from Dataservices API are subject to quota management: check, l
There are three main fields in the quota management: There are three main fields in the quota management:
- **Quota**: Number of requests of this kind the user could make, eg. Number of street geocoding requests - **Quota**: Number of requests of this kind the user could make, eg. Number of street geocoding requests
- **Soft limit**: This flag enables the user to surpass his/her assigned quota. When this flag is activated, there is no quota check so the user could make all the resquests that he/she wants. - **Soft limit**: This flag enables the user to surpass their assigned quota. When this flag is activated, there is no quota check so the user could make all the requests that they want.
- **Block price**: Price for every 1000 requests - **Block price**: Price for every 1000 requests
All the user/organization quota information is stored in the user metadata in Redis but managed by the CartoDB Rails app through its models. Nevertheless you could change/read the redis information through the following keys: All the user/organization quota information is stored in the user metadata in Redis but managed by the CartoDB Rails app through the User/Organization models. Nevertheless you could change/read the Redis information through the following keys:
- hgetall rails:users:username - `hgetall rails:users:username`
- hgetall rails:orgs:orgname - `hgetall rails:orgs:orgname`
This whole information is managed by the CartoDB Rails App too so we could make a numer of useful operations in order to know how many quota do you have, how many quota have you spent this month and so on: This whole information is managed by the CartoDB Rails App too so we could make a number of useful operations in order to know how many quota do you have, how many quota have you spent this month, and so on:
- How can I know the current quota, number of uses, etc for a user? - How can I know the current quota, number of uses, etc for a user?
> You could use the following endpoint to know it: https://<username>.cartodb.com/api/v1/users/<user_id>?api_key=<api_key> You could use the following endpoint to know it: `https://<username>.cartodb.com/api/v1/users/<user_id>?api_key=<api_key>`
> In the result of this endpoint you can see blocks with all the information. Eg: In the result of this endpoint you can see blocks with all the information. Eg:
``` ```json
"geocoding": { "geocoding": {
"quota": 1000, "quota": 1000,
"block_price": 1500, "block_price": 1500,
@ -29,12 +29,12 @@ This whole information is managed by the CartoDB Rails App too so we could make
- How can I set a new quota for a user: - How can I set a new quota for a user:
> This operation could be done through the rails console: This operation could be done through the rails console:
- First you have to connect to the rails console: `bundle exec rails c` - First you have to connect to the rails console: `bundle exec rails c`
- One in the console you have to get the target user/organization: - Once in the console you have to get the target user/organization:
- `u = User.find(username: '<username>')` - `u = User.find(username: '<username>')`
- `o = Organization.find(name: '<orgname>')` - `o = Organization.find(name: '<orgname>')`
- After we have the user/organization, we could change the quota or the hard limit flag for the desired service. I'm going to use geoding as an example but it could be done with all the services : - After we have the user/organization, we could change the quota or the hard limit flag for the desired service. I'm going to use geocoding as an example but it could be done with all the services:
- ``` - ```
u.geocoding_quota = 2000 u.geocoding_quota = 2000
[u.soft_geocoding_limit = true|false] [u.soft_geocoding_limit = true|false]
@ -44,12 +44,12 @@ This whole information is managed by the CartoDB Rails App too so we could make
o.geocoding_quota = 2000 o.geocoding_quota = 2000
o.save o.save
``` ```
- This way the user now has 2000 request as his/her current quota - This way the user now has 2000 requests as their current quota
- We can only change the hard limit flag for users not for organizations - We can only change the hard limit flag for users, not for organizations
- What services we could change?: - What services could we edit?:
The following list numbers all the current services but this is a living list so it could keep growing in the future: The following list numbers all the current services but this is a living list so it could keep growing in the future:
- Geocoding: `geocoding_quota`, `soft_geocoding_limit` - Geocoding: `geocoding_quota`, `soft_geocoding_limit`
- Isolines: `here_isolines_quota`, `soft_here_isolines_limit` - Isolines: `here_isolines_quota`, `soft_here_isolines_limit`