Revision history for APIAdministration


Revision [58073]

Last edited on 2023-01-11 14:31:22 by JamesW
Deletions:
==**Special Cases: Students**==
- Ask why they need the API. Strictly academic: $45 is fair but up to you.
- Temporary keys are also an option - no more than 1 month.
- Except for developing apps, see above. Apps are always public-facing.


Revision [57533]

Edited on 2021-04-26 12:08:34 by jpetterson
Additions:
We send an email to API users before December 31st telling them that their key was going to be deactivated but that they could resubscribe. DevComm crafts the letter with the help of the National Director and sent it with iContact to all of our API subscribers from the beginning of time until November 1, 20xx. We sent the letter out in mid-December. The letter needs to be enticing. To accomplish this: talk about fun things we did with our data - speeches added, ratings added, etc. Maybe other fun things our API got used with.
Deletions:
We send an email to API users before December 31st telling them that their key was going to be deactivated but that they could resubscribe. DevComm crafts the letter with the help of the National Director and sent it with iContact to all of our API subscribers from the beginning of time until November 1, 2016. We sent the letter out in mid-December. The letter needs to be enticing. To accomplish this: talk about fun things we did with our data - speeches added, ratings added, etc. Maybe other fun things our API got used with.


Revision [57532]

Edited on 2021-04-26 12:07:37 by jpetterson
Additions:
Next round: December 31, 2022 (this excludes people who are on the "API Subscriptions Calendar" - they get deactivated before this date.
- DevComm pulls a spreadsheet from Donor Perfect of any person who has the "expiration date" of December 31, 2022 in the "expiration date" field.
Deletions:
Next round: December 31, 2018 (this excludes people who are on the "API Subscriptions Calendar" - they get deactivated before this date.
- DevComm pulls a spreadsheet from Donor Perfect of any person who has the "expiration date" of December 31, 2018 in the "expiration date" field.


Revision [57488]

Edited on 2021-03-31 16:43:52 by walker
Additions:
**The National Director should be involved with any cases that are $2,750+**. Those wishing to relicense or resell data must pay a minimum of $15,000. High-volume users, name-brand users, users looking to relicense or resell data, users looking for a separate contract, users looking for additional data not available in the standard API, or other unusual questions should be run by the National Director prior to setting a fee amount. The National Director will need approval from the President for any non-standard agreements. Sometimes a separate agreement may be necessary, or we may want to develop more of a two-way partnership with them. The National Director should also be involved with those who have payment schedules. $2,500+ needs to be in a contract, on the API Subscription Notices calendar, and also be sent invoices.
Deletions:
**The National Director should be involved with any cases that are $2,500+**. Those wishing to relicense or resell data must pay a minimum of $15,000. High-volume users, name-brand users, users looking to relicense or resell data, users looking for a separate contract, users looking for additional data not available in the standard API, or other unusual questions should be run by the National Director prior to setting a fee amount. The National Director will need approval from the President for any non-standard agreements. Sometimes a separate agreement may be necessary, or we may want to develop more of a two-way partnership with them. The National Director should also be involved with those who have payment schedules. $2,500+ needs to be in a contract, on the API Subscription Notices calendar, and also be sent invoices.


Revision [57367]

Edited on 2021-01-22 12:30:55 by walker [updated pricing tiers for 2021-22]
Additions:
- **$55** - I would like to subscribe to the API for personal, non-business use. I am not representing an organization or institution. I will not provide Vote Smart data to the general public, or use it for resale, lobbying or campaigning in any way.
- **$225** - I represent an educational institution or 501 c3 non-profit that is using the API occasionally. My organization is not providing Vote Smart data to the general public, or using it for resale, lobbying or campaigning in any way.
- **$550** - I represent a corporation, news organization, or foundation that is using the API occasionally. My organization is not providing Vote Smart data to the general public, or using it for resale, lobbying or campaigning in any way.
- **$2750** - I represent an organization of any type that is providing Vote Smart data to the general public. I do not expect my organization's sites and online applications to exceed 40k visitors/end users per month, or exceed 25,000 API calls per month. I will not attempt to relicense or resell this information. I understand that if my actual usage is higher that I will be subject to additional fees. **Anyone providing our data to the public falls in this tier.**
- **$3500** - I represent a lobbyist, government, PAC, labor union, law firm, political party, candidate, or an organization seeking to use this information for lobbying or campaigning. I do not expect to exceed 25,000 API calls per month or distribute this content to more than 40,000 people. I will not attempt to relicense or resell this information. I understand that if my actual usage is higher that I will be subject to additional fees.
Deletions:
- **$0** - I am already a member of Project Vote Smart.
- **$45** - I would like to become a Project Vote Smart Member so that I may access the API and receive other member benefits. This tier includes people who want the API for personal, non-business use.
- **$200** - I represent an educational institution or 501 c3 non-profit that is using the API occasionally. My organization is not providing Vote Smart data to the general public, or using it for resale, lobbying or campaigning in any way.
- **$500** - I represent a corporation, news organization, or foundation that is using the API occasionally. My organization is not providing Vote Smart data to the general public, or using it for resale, lobbying or campaigning in any way.
- **$2500** - I represent an organization of any type that is providing Vote Smart data to the general public. I do not expect my organization's sites and online applications to exceed 40k visitors/end users per month, or exceed 25,000 API calls per month. I will not attempt to relicense or resell this information. I understand that if my actual usage is higher that I will be subject to additional fees. **Anyone providing our data to the public falls in this tier.**
- **$3000** - I represent a lobbyist, government, PAC, labor union, law firm, political party, candidate, or an organization seeking to use this information for lobbying or campaigning. I do not expect to exceed 25,000 API calls per month or distribute this content to more than 40,000 people. I will not attempt to relicense or resell this information. I understand that if my actual usage is higher that I will be subject to additional fees.


Revision [57306]

Edited on 2020-12-10 11:17:35 by walker [clarified who writes renewal letter]
Additions:
We send an email to API users before December 31st telling them that their key was going to be deactivated but that they could resubscribe. DevComm crafts the letter with the help of the National Director and sent it with iContact to all of our API subscribers from the beginning of time until November 1, 2016. We sent the letter out in mid-December. The letter needs to be enticing. To accomplish this: talk about fun things we did with our data - speeches added, ratings added, etc. Maybe other fun things our API got used with.
Deletions:
In 2016, we sent an email to API users before December 31st telling them that their key was going to be deactivated but that they could resubscribe. We crafted a letter and with the help of DevComm, sent it with iContact to all of our API subscribers from the beginning of time until November 1, 2016. We sent the letter out in mid-December. The letter needs to be enticing. To accomplish this: talk about fun things we did with our data - speeches added, ratings added, etc. Maybe other fun things our API got used with.
- Making sure some of the orgs (like the $250 ones aren’t exceeding their usage levels) -- if they are, raise their tiers.
- Reaching out to nonsubscribers who may find our data useful with a sales pitch.


Revision [57305]

Edited on 2020-12-10 11:15:35 by walker [clarified who writes renewal letter]
Additions:
Prior to November 1 of an election year (the current start of a new cycle), we will need to reestablish the [[http://wiki.votesmart.org/APIAdministration#hn_Tiers Standard Subscription Terms and Pricing]] with the President and make changes as necessary.
Deletions:
Prior to November 1 of an election year (the current start of a new cycle), we will need to reestablish the [[http://wiki.votesmart.org/APIandDataRequests#hn_Current_Policies_for_Standard_API_Subscriptions Standard Subscription Terms and Charging Policies]] with the President and make changes as necessary.


Revision [57304]

Edited on 2020-12-10 11:14:41 by walker [clarified who writes renewal letter]
Additions:
**The National Director should be involved with any cases that are $2,500+**. Those wishing to relicense or resell data must pay a minimum of $15,000. High-volume users, name-brand users, users looking to relicense or resell data, users looking for a separate contract, users looking for additional data not available in the standard API, or other unusual questions should be run by the National Director prior to setting a fee amount. The National Director will need approval from the President for any non-standard agreements. Sometimes a separate agreement may be necessary, or we may want to develop more of a two-way partnership with them. The National Director should also be involved with those who have payment schedules. $2,500+ needs to be in a contract, on the API Subscription Notices calendar, and also be sent invoices.
Current Partnerships and Potential Partnerships: [[https://docs.google.com/document/d/1iMfcqWyZpQQ0HU8qzN_xcgzzqhB-g0aFA2uPX35U_1Q/edit Partnerships and Large API Users Contact Notes]]. Actual contracts are located in the Outreach Drive.
This is where your judgment comes into play. We make exceptions for users who fall into at least two of the three categories:
- We can be flexible with pricing plans. Ex. They pay $1000 upfront and then pay $1500 in ____ amount of months.
- Except for developing apps, see above. Apps are always public-facing.
Deletions:
**The National Director should be involved with any cases that are $2,500+**. Those wishing to relicense or resell data must pay a minimum of $15,000. High-volume users, name-brand users, users looking to relicense or resell data, users looking for a separate contract, users looking for additional data not available in the standard API, or other unusual questions should be run by the National Director prior to setting a fee amount. The National Director will need approval from the President for any non-standard agreements. Sometimes a separate agreement may be necessary, or we may want to develop more of a two-way partnership with them. The National Director should also be involved with those who have payment schedules. $2,500+ needs to be in a contract, on the calendar, and also be sent invoices.
Current Partnerships and Potential Partnerships: [[https://docs.google.com/document/d/1pRcFGbg3Jv7DFRc2I-nALg1eqyxDWQogdT9gL-ufUtE/edit Partnerships and Large API Users Contact Notes]]. Actual contracts are located in the Outreach Drive.
This is where your judgement comes into play. We make exceptions for users who fall into at least two of the three categories:
- We can be flexible with pricing plans. Ex. They pay $1000 up front and then pay $1500 in ____ amount of months.
- Except developing apps, see above. Apps are always public-facing.


Revision [57303]

Edited on 2020-12-10 11:05:17 by walker [clarified who writes renewal letter]
Additions:
If the subscriber indicates that they are unsure which payment level to choose, then an email will be sent to membership@votesmart.org – [pypvs] API Subscription Intervention Needed. The email will contain a link to the fee schedule. After reviewing the registration form (found in Django administration, http://skittles.votesmart.org/admin/ - Survey Answers, checking the user and submission date) check the box next to the correct payment level, click submit, and an email will be sent to the user. Note: for those subscribers who may be at a level higher than the $3,000 subscription level, you should defer to the National Director to assign the appropriate fee.
Deletions:
If the subscriber indicates that they are unsure which payment level to choose, then an email will be sent to membership@votesmart.org – [pypvs] API Subscription Intervention Needed. The email will contain a link to the fee schedule. After reviewing the registration form (found in Django administration, http://skittles.votesmart.org/admin/ - Survey Answers, checking the user and submission date) check the box next to the correct payment level, click submit, and an email will be sent to the user. Note: for those subscribers who may be at a level higher than the $2,500 subscription level, you should defer to the National Director to assign the appropriate fee.


Revision [57302]

Edited on 2020-12-10 10:59:30 by walker [clarified who writes renewal letter]
Additions:
**National Director** handles high-level API contracts (ex. National Journal) and coordinates the other department contacts
Deletions:
**National Director** handles high level API contracts (ex. National Journal)


Revision [54372]

Edited on 2018-12-17 11:40:09 by walker [how to update tiers in django]
Additions:
These tiers should be examined every two years at the end of an election cycle. They can be updated through [[http://skittles.votesmart.org/admin/misc/apisubscriptiontype/ Django admin]].


Revision [54329]

Edited on 2018-12-12 09:49:24 by walker [updates to new 2019-2020 prices]
Additions:
If the subscriber indicates that they are unsure which payment level to choose, then an email will be sent to membership@votesmart.org – [pypvs] API Subscription Intervention Needed. The email will contain a link to the fee schedule. After reviewing the registration form (found in Django administration, http://skittles.votesmart.org/admin/ - Survey Answers, checking the user and submission date) check the box next to the correct payment level, click submit, and an email will be sent to the user. Note: for those subscribers who may be at a level higher than the $2,500 subscription level, you should defer to the National Director to assign the appropriate fee.
- **$200** - I represent an educational institution or 501 c3 non-profit that is using the API occasionally. My organization is not providing Vote Smart data to the general public, or using it for resale, lobbying or campaigning in any way.
- **$500** - I represent a corporation, news organization, or foundation that is using the API occasionally. My organization is not providing Vote Smart data to the general public, or using it for resale, lobbying or campaigning in any way.
- **$3000** - I represent a lobbyist, government, PAC, labor union, law firm, political party, candidate, or an organization seeking to use this information for lobbying or campaigning. I do not expect to exceed 25,000 API calls per month or distribute this content to more than 40,000 people. I will not attempt to relicense or resell this information. I understand that if my actual usage is higher that I will be subject to additional fees.
We run into scenarios a lot, where an app developer wants to use our API data publicly, but has no idea how many users to expect/profit will be gained and therefore wants an exception to our subscription fee. They often cannot pay the $2,500 we expect for publicly disseminating our data. They often want to have subscription fees that increase in tandem with users and profit, starting at a manageable fee and increasing over time.
- We can be flexible with pricing plans. Ex. They pay $1000 up front and then pay $1500 in ____ amount of months.
Deletions:
If the subscriber indicates that they are unsure which payment level to choose, then an email will be sent to membership@votesmart.org – [pypvs] API Subscription Intervention Needed. The email will contain a link to the fee schedule. After reviewing the registration form (found in Django administration, http://skittles.votesmart.org/admin/ - Survey Answers, checking the user and submission date) check the box next to the correct payment level, click submit, and an email will be sent to the user. Note: for those subscribers who may be at a level higher than the $2,000 subscription level, you should defer to the National Director to assign the appropriate fee.
- **$100** - I represent an educational institution or 501 c3 non-profit that is using the API occasionally. My organization is not providing Vote Smart data to the general public, or using it for resale, lobbying or campaigning in any way.
- **$250** - I represent a corporation, news organization, or foundation that is using the API occasionally. My organization is not providing Vote Smart data to the general public, or using it for resale, lobbying or campaigning in any way.
- **$2500** - I represent a lobbyist, government, PAC, labor union, law firm, political party, candidate, or an organization seeking to use this information for lobbying or campaigning. I do not expect to exceed 25,000 API calls per month or distribute this content to more than 40,000 people. I will not attempt to relicense or resell this information. I understand that if my actual usage is higher that I will be subject to additional fees.
We run into scenarios a lot, where an app developer wants to use our API data publicly, but has no idea how many users to expect/profit will be gained and therefore wants an exception to our subscription fee. They often cannot pay the $2,000 we expect for publicly disseminating our data. They often want to have subscription fees that increase in tandem with users and profit, starting at a manageable fee and increasing over time.
- We can be flexible with pricing plans. Ex. They pay $1000 up front and then pay $1000 in ____ amount of months.


Revision [54286]

Edited on 2018-12-07 09:54:17 by walker [updates to new 2019-2020 prices]
Additions:
**The National Director should be involved with any cases that are $2,500+**. Those wishing to relicense or resell data must pay a minimum of $15,000. High-volume users, name-brand users, users looking to relicense or resell data, users looking for a separate contract, users looking for additional data not available in the standard API, or other unusual questions should be run by the National Director prior to setting a fee amount. The National Director will need approval from the President for any non-standard agreements. Sometimes a separate agreement may be necessary, or we may want to develop more of a two-way partnership with them. The National Director should also be involved with those who have payment schedules. $2,500+ needs to be in a contract, on the calendar, and also be sent invoices.
Deletions:
**The National Director should be involved with any cases that are $2,500+**. Those wishing to relicense or resell data must pay a minimum of $15,000. High-volume users, name-brand users, users looking to relicense or resell data, users looking for a separate contract, users looking for additional data not available in the standard API, or other unusual questions should be run by the National Director prior to setting a fee amount. The National Director will need approval from the President for any non-standard agreements. Sometimes a separate agreement may be necessary, or we may want to develop more of a two-way partnership with them. The National Director should also be involved with those who have payment schedules. $2,000+ needs to be in a contract, on the calendar, and also be sent invoices.


Revision [54285]

Edited on 2018-12-07 09:53:36 by walker [updates to new 2019-2020 prices]
Additions:
**The National Director should be involved with any cases that are $2,500+**. Those wishing to relicense or resell data must pay a minimum of $15,000. High-volume users, name-brand users, users looking to relicense or resell data, users looking for a separate contract, users looking for additional data not available in the standard API, or other unusual questions should be run by the National Director prior to setting a fee amount. The National Director will need approval from the President for any non-standard agreements. Sometimes a separate agreement may be necessary, or we may want to develop more of a two-way partnership with them. The National Director should also be involved with those who have payment schedules. $2,000+ needs to be in a contract, on the calendar, and also be sent invoices.
Deletions:
**The National Director should be involved with any cases that are $2,000+**. Those wishing to relicense or resell data must pay a minimum of $15,000. High-volume users, name-brand users, users looking to relicense or resell data, users looking for a separate contract, users looking for additional data not available in the standard API, or other unusual questions should be run by the National Director prior to setting a fee amount. The National Director will need approval from the President for any non-standard agreements. Sometimes a separate agreement may be necessary, or we may want to develop more of a two-way partnership with them. The National Director should also be involved with those who have payment schedules. $2,000+ needs to be in a contract, on the calendar, and also be sent invoices.


Revision [20799]

Edited on 2018-01-18 12:54:20 by walker [added a step to EOY: survey usage for resubscriber]
Additions:
This renewal contact should be accompanied with a usage survey similar to the current Registration survey for first-time subscribers. This will allow us to evaluate any subscribers whose usage may have changed.


Revision [20214]

Edited on 2017-06-28 10:18:49 by walker [updated 2017 API pricing]
Additions:
- **$2500** - I represent an organization of any type that is providing Vote Smart data to the general public. I do not expect my organization's sites and online applications to exceed 40k visitors/end users per month, or exceed 25,000 API calls per month. I will not attempt to relicense or resell this information. I understand that if my actual usage is higher that I will be subject to additional fees. **Anyone providing our data to the public falls in this tier.**
- **$2500** - I represent a lobbyist, government, PAC, labor union, law firm, political party, candidate, or an organization seeking to use this information for lobbying or campaigning. I do not expect to exceed 25,000 API calls per month or distribute this content to more than 40,000 people. I will not attempt to relicense or resell this information. I understand that if my actual usage is higher that I will be subject to additional fees.
Deletions:
- **$2000** - I represent an organization of any type that is providing Vote Smart data to the general public. I do not expect my organization's sites and online applications to exceed 40k visitors/end users per month, or exceed 25,000 API calls per month. I will not attempt to relicense or resell this information. I understand that if my actual usage is higher that I will be subject to additional fees. **Anyone providing our data to the public falls in this tier.**
- **$2000** - I represent a lobbyist, government, PAC, labor union, law firm, political party, candidate, or an organization seeking to use this information for lobbying or campaigning. I do not expect to exceed 25,000 API calls per month or distribute this content to more than 40,000 people. I will not attempt to relicense or resell this information. I understand that if my actual usage is higher that I will be subject to additional fees.


Revision [19972]

Edited on 2017-04-25 11:08:18 by cassandra@votesmart.org [updated 2017 API pricing]
Additions:
In 2016, we sent an email to API users before December 31st telling them that their key was going to be deactivated but that they could resubscribe. We crafted a letter and with the help of DevComm, sent it with iContact to all of our API subscribers from the beginning of time until November 1, 2016. We sent the letter out in mid-December. The letter needs to be enticing. To accomplish this: talk about fun things we did with our data - speeches added, ratings added, etc. Maybe other fun things our API got used with.
Deletions:
Prior to 2016, Vote Smart sent an email to the API users after December 31st telling them that their key had been deactivated. In 2016, we sent an email to API users before December 31st telling them that their key was going to be deactivated but that they could resubscribe. We crafted a letter and with the help of DevComm, sent it with iContact to all of our API subscribers from the beginning of time until November 1, 2016. We sent the letter out in mid-December. The letter needs to be enticing. To accomplish this: talk about fun things we did with our data - speeches added, ratings added, etc. Maybe other fun things our API got used with.


Revision [19932]

Edited on 2017-04-21 17:00:27 by cassandra@votesmart.org [updated 2017 API pricing]
Additions:
The API is a paid service that serves to raise critical funds for Vote Smart's Operations. Accordingly, prospective API users should be thought of as **sales leads**. Know that as paid subscribers, current subscribers are expecting a certain level of customer service. We should be particularly responsive and accommodating to our higher-paid subscribers, as this will increase their chance of re-subscribing. For more information on what the API is and the data available, visit [[http://wiki.votesmart.org/APIandDataRequests API Overview]]
Deletions:
For more information on what the API is, visit [[http://wiki.votesmart.org/APIandDataRequests API Overview]]


Revision [19921]

Edited on 2017-04-21 16:39:43 by cassandra@votesmart.org [updated 2017 API pricing]
Additions:
Prior to November 1 of an election year (the current start of a new cycle), we will need to reestablish the [[http://wiki.votesmart.org/APIandDataRequests#hn_Current_Policies_for_Standard_API_Subscriptions Standard Subscription Terms and Charging Policies]] with the President and make changes as necessary.


Revision [19918]

Edited on 2017-04-21 16:28:24 by cassandra@votesmart.org [updated 2017 API pricing]
Additions:
If the subscriber indicates that they are unsure which payment level to choose, then an email will be sent to membership@votesmart.org – [pypvs] API Subscription Intervention Needed. The email will contain a link to the fee schedule. After reviewing the registration form (found in Django administration, http://skittles.votesmart.org/admin/ - Survey Answers, checking the user and submission date) check the box next to the correct payment level, click submit, and an email will be sent to the user. Note: for those subscribers who may be at a level higher than the $2,000 subscription level, you should defer to the National Director to assign the appropriate fee.
Deletions:
If the subscriber indicates that they are unsure which payment level to choose, then an email will be sent to membership@votesmart.org – [pypvs] API Subscription Intervention Needed. The email will contain a link to the fee schedule. After reviewing the registration form (found in Django administration, http://skittles.votesmart.org/admin/ - Survey Answers, checking the user and submission date) check the box next to the correct payment level, click submit, and an email will be sent to the user. Note: for those subscribers who may be at a level higher than the $2,000 subscription level, you should defer to the National Director to assign the appropriate fee


Revision [19917]

Edited on 2017-04-21 16:25:59 by cassandra@votesmart.org [updated 2017 API pricing]
Additions:
- The reason we charge for the API is to support the costs of collecting and delivering the data. We attempt to apply these fees as equitably as possible based on the potential for usage.
Deletions:
- The reason we charge for the API is to support the costs of collecting and delivering the data. We attempt to apply these fees as equitably as possible based on the potential for usage. Note: exceptions should only be considered if the user requests an exception


Revision [19915]

Edited on 2017-04-21 16:21:38 by cassandra@votesmart.org [updated 2017 API pricing]
Deletions:
If the subscriber marks that they are a member, the key is not automatically activated. Membership@votesmart.org receives an email, with the subject line: [pypvs] API Subscription Activation Review], asking to verify membership. Membership will then either activate the key if they are a member (by clicking on the link contained in the member verification email) or contact the individual to let them know that their key cannot be activated without the appropriate payment.


Revision [19914]

Edited on 2017-04-21 16:20:20 by cassandra@votesmart.org [updated 2017 API pricing]
Additions:
===** The API Registration Process**===
Deletions:
===** The API Registration Process===


Revision [19913]

Edited on 2017-04-21 16:20:02 by cassandra@votesmart.org [updated 2017 API pricing]

No Differences

Revision [19912]

Edited on 2017-04-21 16:19:26 by cassandra@votesmart.org [updated 2017 API pricing]
Additions:
**National Director** handles high level API contracts (ex. National Journal)
===**Current Policies for Standard API Subscriptions**===
- The reason we charge for the API is to support the costs of collecting and delivering the data. We attempt to apply these fees as equitably as possible based on the potential for usage. Note: exceptions should only be considered if the user requests an exception
- High-volume users, name-brand users, users looking to relicense or resell data, users looking for a separate contract, or other unusual questions should be run by the National Director prior to setting a fee amount
**General Terms:**
- Subscribers are required to fill out the usage survey upon registration and submit the appropriate payment in accordance with our charging policy.
- Subscribers are required to abide by the [[http://wiki.votesmart.org/APIandDataRequests#hn_Terms_of_Use_and_Enforcement terms of use]]
- Each API user is given a unique API key, which gives them access to the API and allows us to control and monitor their usage.
===** The API Registration Process===
In mid-October 2012, a new registration system through Django Admin was instituted to streamline registration with a MyVotesmart account.
1. User creates MyVoteSmart Account
2. User visits http://votesmart.org/share/api/register
3. This is the portal where users select their tier, fill out the API survey, pay, then receive an email from officmgr@ with their API key which is automatically activated.
4. Previous subscribers wishing to resubscribe should be able to simply login to their account and submit their payment due in order to reactivate the key.
5. DevComm adds subscriber into DonorPerfect via Cybersource.
If the subscriber marks that they are a member, the key is not automatically activated. Membership@votesmart.org receives an email, with the subject line: [pypvs] API Subscription Activation Review], asking to verify membership. Membership will then either activate the key if they are a member (by clicking on the link contained in the member verification email) or contact the individual to let them know that their key cannot be activated without the appropriate payment.
If the subscriber indicates that they are unsure which payment level to choose, then an email will be sent to membership@votesmart.org – [pypvs] API Subscription Intervention Needed. The email will contain a link to the fee schedule. After reviewing the registration form (found in Django administration, http://skittles.votesmart.org/admin/ - Survey Answers, checking the user and submission date) check the box next to the correct payment level, click submit, and an email will be sent to the user. Note: for those subscribers who may be at a level higher than the $2,000 subscription level, you should defer to the National Director to assign the appropriate fee
- Multiple Users, Same API Key: **Dupes**
- Free Keys:
Available to the public on http://votesmart.org/share/api/register. This is the portal where users select their tier, fill out the API survey, pay, then receive an email from officmgr@ with their API key. If a person makes a payment by going to votesmart.org/donate, or they pay over the phone, they don’t get automatically assigned a key. For this, go to http://skittles.votesmart.org/admin/ and assign them a key. Email them what their key is.
**The National Director should be involved with any cases that are $2,000+**. Those wishing to relicense or resell data must pay a minimum of $15,000. High-volume users, name-brand users, users looking to relicense or resell data, users looking for a separate contract, users looking for additional data not available in the standard API, or other unusual questions should be run by the National Director prior to setting a fee amount. The National Director will need approval from the President for any non-standard agreements. Sometimes a separate agreement may be necessary, or we may want to develop more of a two-way partnership with them. The National Director should also be involved with those who have payment schedules. $2,000+ needs to be in a contract, on the calendar, and also be sent invoices.
Current Partnerships and Potential Partnerships: [[https://docs.google.com/document/d/1pRcFGbg3Jv7DFRc2I-nALg1eqyxDWQogdT9gL-ufUtE/edit Partnerships and Large API Users Contact Notes]]. Actual contracts are located in the Outreach Drive.
Dear [Person interested in API's Name],
Thank you for your interest in the Vote Smart API. You indicated on your registration form that you are a member; however, we don't have record of your membership in our database. In order to complete your application, you login into My Vote Smart and then review our subscription types (found here: http://votesmart.org/share/api/register) and select the one that is most appropriate for you. If you are unsure of which subscription level to choose, please email me back at [your email] and we can discuss this further.
Please let me know if you have any questions.
Best,
[Your Name]
As of 2016, subscriptions are based on the election cycle. This is a Bi-annual subscription which begins at registration and generally lasts through December 31 of even-numbered (general election) years. Those who sign up between November 1 and December 31 of even-numbered years will have their subscription extended through December 31 of two years later. So, for example, those who sign up between November 1, 2014 and October 31, 2016 will have a subscription term starting upon sign-up and ending December 31, 2016. Those that sign up from November 1, 2016 through October 31, 2018 would have a subscription term starting upon sign-up and ending December 31, 2018.
Deletions:
**National Director** handles high level API contracts (ex. National Journal) and exceptions to pricing
- Multiple Users, Same API Key: *Dupes*
-Free Keys:
Available to the public on http://votesmart.org/share/api/register. This is the portal where users select their tier, fill out the API survey, pay, then receive an email from officmgr@ with their API key.
If a person makes a payment by going to votesmart.org/donate, or they pay over the phone, they don’t get automatically assigned a key. For this, go to http://skittles.votesmart.org/admin/ and assign them a key. Email them what their key is.
The National Director should be involved with any cases that are **$2,000+**. The National Director should also be involved with those who have payment schedules. $2,000+ needs to be in a contract, on the calendar, and also be sent invoices.
Dear [Person interested in API's Name],
Thank you for your interest in the Vote Smart API. You indicated on your registration form that you are a member; however, we don't have record of your membership in our database. In order to complete your application, you login into My Vote Smart and then review our subscription types (found here: http://votesmart.org/share/api/register) and select the one that is most appropriate for you. If you are unsure of which subscription level to choose, please email me back at [your email] and we can discuss this further.
Please let me know if you have any questions.
Best,
[Your Name]


Revision [19911]

Edited on 2017-04-21 16:13:03 by walker [updated 2017 API pricing]
Additions:
**National Director** handles high level API contracts (ex. National Journal) and exceptions to pricing
- Multiple Users, Same API Key: *Dupes*
-Free Keys:
The National Director should be involved with any cases that are **$2,000+**. The National Director should also be involved with those who have payment schedules. $2,000+ needs to be in a contract, on the calendar, and also be sent invoices.
Dear [Person interested in API's Name],
Thank you for your interest in the Vote Smart API. You indicated on your registration form that you are a member; however, we don't have record of your membership in our database. In order to complete your application, you login into My Vote Smart and then review our subscription types (found here: http://votesmart.org/share/api/register) and select the one that is most appropriate for you. If you are unsure of which subscription level to choose, please email me back at [your email] and we can discuss this further.
Please let me know if you have any questions.
Best,
[Your Name]
Deletions:
**National Director** handles high level API contracts (ex. National Journal)
===**Current Policies for Standard API Subscriptions**===
- The reason we charge for the API is to support the costs of collecting and delivering the data. We attempt to apply these fees as equitably as possible based on the potential for usage. Note: exceptions should only be considered if the user requests an exception
- High-volume users, name-brand users, users looking to relicense or resell data, users looking for a separate contract, or other unusual questions should be run by the National Director prior to setting a fee amount
**General Terms:**
- Subscribers are required to fill out the usage survey upon registration and submit the appropriate payment in accordance with our charging policy.
- Subscribers are required to abide by the [[http://wiki.votesmart.org/APIandDataRequests#hn_Terms_of_Use_and_Enforcement terms of use]]
- Each API user is given a unique API key, which gives them access to the API and allows us to control and monitor their usage.
- Multiple Users, Same API Key: **Dupes**
- Free Keys:
**The National Director should be involved with any cases that are $2,000+**. Those wishing to relicense or resell data must pay a minimum of $15,000. High-volume users, name-brand users, users looking to relicense or resell data, users looking for a separate contract, users looking for additional data not available in the standard API, or other unusual questions should be run by the National Director prior to setting a fee amount. The National Director will need approval from the President for any non-standard agreements. Sometimes a separate agreement may be necessary, or we may want to develop more of a two-way partnership with them. The National Director should also be involved with those who have payment schedules. $2,000+ needs to be in a contract, on the calendar, and also be sent invoices.
Current Partnerships and Potential Partnerships: [[https://docs.google.com/document/d/1pRcFGbg3Jv7DFRc2I-nALg1eqyxDWQogdT9gL-ufUtE/edit Partnerships and Large API Users Contact Notes]]. Actual contracts are located in the Outreach Drive.
Dear [Person interested in API's Name],
Thank you for your interest in the Vote Smart API. You indicated on your registration form that you are a member; however, we don't have record of your membership in our database. In order to complete your application, you login into My Vote Smart and then review our subscription types (found here: http://votesmart.org/share/api/register) and select the one that is most appropriate for you. If you are unsure of which subscription level to choose, please email me back at [your email] and we can discuss this further.
Please let me know if you have any questions.
Best,
[Your Name]
As of 2016, subscriptions are based on the election cycle. This is a Bi-annual subscription which begins at registration and generally lasts through December 31 of even-numbered (general election) years. Those who sign up between November 1 and December 31 of even-numbered years will have their subscription extended through December 31 of two years later. So, for example, those who sign up between November 1, 2014 and October 31, 2016 will have a subscription term starting upon sign-up and ending December 31, 2016. Those that sign up from November 1, 2016 through October 31, 2018 would have a subscription term starting upon sign-up and ending December 31, 2018.


Revision [19909]

Edited on 2017-04-21 15:57:46 by cassandra@votesmart.org [updated 2017 API pricing]
Additions:
Current Partnerships and Potential Partnerships: [[https://docs.google.com/document/d/1pRcFGbg3Jv7DFRc2I-nALg1eqyxDWQogdT9gL-ufUtE/edit Partnerships and Large API Users Contact Notes]]. Actual contracts are located in the Outreach Drive.
Deletions:
Current Partnerships and Potential Partnerships: [[https://docs.google.com/document/d/1pRcFGbg3Jv7DFRc2I-nALg1eqyxDWQogdT9gL-ufUtE/edit Partnerships and Large API Users Contact Notes]]
actual contracts are located in the Outreach Drive.


Revision [19908]

Edited on 2017-04-21 15:57:25 by cassandra@votesmart.org [updated 2017 API pricing]
Additions:
**The National Director should be involved with any cases that are $2,000+**. Those wishing to relicense or resell data must pay a minimum of $15,000. High-volume users, name-brand users, users looking to relicense or resell data, users looking for a separate contract, users looking for additional data not available in the standard API, or other unusual questions should be run by the National Director prior to setting a fee amount. The National Director will need approval from the President for any non-standard agreements. Sometimes a separate agreement may be necessary, or we may want to develop more of a two-way partnership with them. The National Director should also be involved with those who have payment schedules. $2,000+ needs to be in a contract, on the calendar, and also be sent invoices.
Deletions:
The National Director should be involved with any cases that are **$2,000+**. High-volume users, name-brand users, users looking to relicense or resell data, users looking for a separate contract, users looking for additional data not available in the standard API, or other unusual questions should be run by the National Director prior to setting a fee amount. The National Director will need approval from the President for any non-standard agreements. Sometimes a separate agreement may be necessary, or we may want to develop more of a two-way partnership with them. The National Director should also be involved with those who have payment schedules. $2,000+ needs to be in a contract, on the calendar, and also be sent invoices.


Revision [19907]

Edited on 2017-04-21 15:56:04 by cassandra@votesmart.org [updated 2017 API pricing]
Additions:
The National Director should be involved with any cases that are **$2,000+**. High-volume users, name-brand users, users looking to relicense or resell data, users looking for a separate contract, users looking for additional data not available in the standard API, or other unusual questions should be run by the National Director prior to setting a fee amount. The National Director will need approval from the President for any non-standard agreements. Sometimes a separate agreement may be necessary, or we may want to develop more of a two-way partnership with them. The National Director should also be involved with those who have payment schedules. $2,000+ needs to be in a contract, on the calendar, and also be sent invoices.
Deletions:
The National Director should be involved with any cases that are **$2,000+**. High-volume users, name-brand users, users looking to relicense or resell data, users looking for a separate contract, users looking for additional data not available in the standard API, or other unusual questions should be run by the National Director prior to setting a fee amount. The National Director will need approval from the President for any non-standard agreements. Sometimes a separate agreement may be necessary, or we may want to develop more of a two-way partnership with them.
The National Director should also be involved with those who have payment schedules. $2,000+ needs to be in a contract, on the calendar, and also be sent invoices.


Revision [19906]

Edited on 2017-04-21 15:55:28 by cassandra@votesmart.org [updated 2017 API pricing]
Additions:
The National Director should be involved with any cases that are **$2,000+**. High-volume users, name-brand users, users looking to relicense or resell data, users looking for a separate contract, users looking for additional data not available in the standard API, or other unusual questions should be run by the National Director prior to setting a fee amount. The National Director will need approval from the President for any non-standard agreements. Sometimes a separate agreement may be necessary, or we may want to develop more of a two-way partnership with them.
The National Director should also be involved with those who have payment schedules. $2,000+ needs to be in a contract, on the calendar, and also be sent invoices.
Current Partnerships and Potential Partnerships: [[https://docs.google.com/document/d/1pRcFGbg3Jv7DFRc2I-nALg1eqyxDWQogdT9gL-ufUtE/edit Partnerships and Large API Users Contact Notes]]
actual contracts are located in the Outreach Drive.
Deletions:
The National Director should be involved with any cases that are **$2,000+**. The National Director should also be involved with those who have payment schedules. $2,000+ needs to be in a contract, on the calendar, and also be sent invoices.


Revision [19905]

Edited on 2017-04-21 15:53:09 by cassandra@votesmart.org [updated 2017 API pricing]
Additions:
===**Current Policies for Standard API Subscriptions**===
Deletions:
===Current Policies for Standard API Subscriptions===


Revision [19904]

Edited on 2017-04-21 15:52:39 by cassandra@votesmart.org [updated 2017 API pricing]
Additions:
===Current Policies for Standard API Subscriptions===
- The reason we charge for the API is to support the costs of collecting and delivering the data. We attempt to apply these fees as equitably as possible based on the potential for usage. Note: exceptions should only be considered if the user requests an exception
- High-volume users, name-brand users, users looking to relicense or resell data, users looking for a separate contract, or other unusual questions should be run by the National Director prior to setting a fee amount
**General Terms:**
- Subscribers are required to fill out the usage survey upon registration and submit the appropriate payment in accordance with our charging policy.
- Subscribers are required to abide by the [[http://wiki.votesmart.org/APIandDataRequests#hn_Terms_of_Use_and_Enforcement terms of use]]
- Each API user is given a unique API key, which gives them access to the API and allows us to control and monitor their usage.


Revision [19903]

Edited on 2017-04-21 15:51:04 by cassandra@votesmart.org [updated 2017 API pricing]

No Differences

Revision [19902]

Edited on 2017-04-21 15:50:51 by cassandra@votesmart.org [updated 2017 API pricing]
Additions:
As of 2016, subscriptions are based on the election cycle. This is a Bi-annual subscription which begins at registration and generally lasts through December 31 of even-numbered (general election) years. Those who sign up between November 1 and December 31 of even-numbered years will have their subscription extended through December 31 of two years later. So, for example, those who sign up between November 1, 2014 and October 31, 2016 will have a subscription term starting upon sign-up and ending December 31, 2016. Those that sign up from November 1, 2016 through October 31, 2018 would have a subscription term starting upon sign-up and ending December 31, 2018.


Revision [19901]

Edited on 2017-04-21 15:42:54 by cassandra@votesmart.org [updated 2017 API pricing]
Additions:
- Multiple Users, Same API Key: **Dupes**
- Free Keys:
Dear [Person interested in API's Name],
Thank you for your interest in the Vote Smart API. You indicated on your registration form that you are a member; however, we don't have record of your membership in our database. In order to complete your application, you login into My Vote Smart and then review our subscription types (found here: http://votesmart.org/share/api/register) and select the one that is most appropriate for you. If you are unsure of which subscription level to choose, please email me back at [your email] and we can discuss this further.
Please let me know if you have any questions.
Best,
[Your Name]
Deletions:
- Multiple Users, Same API Key: *Dupes*
-Free Keys:
Dear [Person interested in API's Name],
Thank you for your interest in the Vote Smart API. You indicated on your registration form that you are a member; however, we don't have record of your membership in our database. In order to complete your application, you login into My Vote Smart and then review our subscription types (found here: http://votesmart.org/share/api/register) and select the one that is most appropriate for you. If you are unsure of which subscription level to choose, please email me back at [your email] and we can discuss this further.
Please let me know if you have any questions.
Best,
[Your Name]


Revision [19900]

Edited on 2017-04-21 15:33:19 by cassandra@votesmart.org [updated 2017 API pricing]
Additions:
Dear [Person interested in API's Name],
Thank you for your interest in the Vote Smart API. You indicated on your registration form that you are a member; however, we don't have record of your membership in our database. In order to complete your application, you login into My Vote Smart and then review our subscription types (found here: http://votesmart.org/share/api/register) and select the one that is most appropriate for you. If you are unsure of which subscription level to choose, please email me back at [your email] and we can discuss this further.
Please let me know if you have any questions.
Best,
[Your Name]
Deletions:
Dear [Person interested in API's Name],
Thank you for your interest in the Vote Smart API. You indicated on your registration form that you are a member; however, we don't have record of your membership in our database. In order to complete your application, you login into My Vote Smart and then review our subscription types (found here: http://votesmart.org/share/api/register) and select the one that is most appropriate for you. If you are unsure of which subscription level to choose, please email me back at [your email] and we can discuss this further.
Please let me know if you have any questions.
Best,
[Your Name]


Revision [19898]

Edited on 2017-04-21 15:23:42 by cassandra@votesmart.org [updated 2017 API pricing]
Additions:
- Reaching out to nonsubscribers who may find our data useful with a sales pitch.


Revision [19896]

Edited on 2017-04-21 15:21:26 by cassandra@votesmart.org [updated 2017 API pricing]
Additions:
====**Administrating the API**====
Deletions:
=====**Administrating the API**=====


Revision [19895]

Edited on 2017-04-21 15:21:11 by cassandra@votesmart.org [updated 2017 API pricing]
Additions:
===**Receipts**===
Deletions:
===**Invoices**===


Revision [19894]

Edited on 2017-04-21 15:20:52 by cassandra@votesmart.org [updated 2017 API pricing]
Additions:
===**Invoices**===
Some people ask for a receipt. You can either send them a copy of their CyberSource receipt or send them a copy of their thank you letter for their API subscription
There is also a more formal template form is located at /outreach/PARTNERSHIPS & API SALES/API Information/Pricing/API invoice template with logo.doc.
===**Future Potential Projects**===
- Adding/removing questions from the API survey
- Beginning of 2018, contact the groups that didn’t re-subscribe and see if they would like to subscribe. Why? 2018 is an election year. 2017 is an off year that doesn’t really matter - so, it’s kind of understandable why they wouldn’t want to re-subscribe January 2017. If we start the convo again in 2018, it’s fresh. I made a list in the 2017 notes of some of the “larger” ($2,000 donors) groups that we used to have subscribing to the API.
- Making sure some of the orgs (like the $250 ones aren’t exceeding their usage levels) -- if they are, raise their tiers.
Deletions:
Invoices
Some people ask for invoices. These are easy to put together.
A template form is located at /outreach/PARTNERSHIPS & API SALES/API Information/Pricing/API invoice template with logo.doc.
The phone number at the bottom will have to change to the IA office
Copy out the template into a blank document. Change the date, who you’re billing it to, the amount, and the dates under the description. Save as a .doc.
We send them a .pdf file, so all you have to do from here is convert the .doc to a .pdf using a website, and you’ll be good to go.
Both the .doc and the .pdf go in /outreach/PARTNERSHIPS & API SALES/API Information/Pricing/Records of Invoices Requested
Future Potential Projects
Adding/removing questions from the API survey
Beginning of 2018, contact the groups that didn’t re-subscribe and see if they would like to subscribe. Why? 2018 is an election year. 2017 is an off year that doesn’t really matter - so, it’s kind of understandable why they wouldn’t want to re-subscribe January 2017. If we start the convo again in 2018, it’s fresh. I made a list in the 2017 notes of some of the “larger” ($2,000 donors) groups that we used to have subscribing to the API.
Make sure some of the orgs (like the $250 ones aren’t exceeding their usage levels) -- if they are, raise their tiers.
Random Notes: The API in General
Caching data helps the stress on our organization. It doesn’t get queried every day. It depends on the organization. NBC (when they had our API) cached data.
In a call, ? indicates a command (similar to the WHERE clause in SQL)
In a call, & indicates a section command
The method you use is important (JSON vs XML)


Revision [19893]

Edited on 2017-04-21 15:17:16 by cassandra@votesmart.org [updated 2017 API pricing]
Additions:
Available to the public on http://votesmart.org/share/api/register. This is the portal where users select their tier, fill out the API survey, pay, then receive an email from officmgr@ with their API key.
If a person makes a payment by going to votesmart.org/donate, or they pay over the phone, they don’t get automatically assigned a key. For this, go to http://skittles.votesmart.org/admin/ and assign them a key. Email them what their key is.
- Other amount approved by Vote Smart. **See High End API Users**.
===**API Subscription Activation Review**===
Membership@votesmart.org receives emails with the subject line “[pypvs] API Subscription Activation Review”. These emails are auto-generated from people on our site stating that they are a member and are requesting access for our API. Though, the majority of these people are not members, so it is DevComm’s job to confirm whether or not they have a membership with us. Membership for the API is defined as any current member (donating in the past 3 years) of Vote Smart.
- First check the name and address in Donor Perfect.
- If you cannot find them in Donor Perfect, check their name in Cybersource to see if they donated recently and you haven’t data entered them yet.
- **If they are NOT in Donor Perfect or in Cybersource,** respond and say:

Dear [Person interested in API's Name],
Thank you for your interest in the Vote Smart API. You indicated on your registration form that you are a member; however, we don't have record of your membership in our database. In order to complete your application, you login into My Vote Smart and then review our subscription types (found here: http://votesmart.org/share/api/register) and select the one that is most appropriate for you. If you are unsure of which subscription level to choose, please email me back at [your email] and we can discuss this further.
Please let me know if you have any questions.
Best,
[Your Name]

- **If they ARE a member as defined above**:
- Click the link in the email “If this registrant is a valid member, please visit this link”:
- Clicking the link activates their API. You should see a message saying something along the lines of “1 Key Activated”
Sometimes they reply, sometimes they don’t. I don’t know if the non-repliers pay. For those that reply: some are confused about MyVoteSmart and how that membership doesn’t actually give them a real membership; some are students that can’t afford it; some just want a one time data dump; it’s a case by case adventure. One way to figure out how much a person should pay is to look at their survey - link located on the bottom of the second page of their admin pages. You will have to haggle with some people over email about what payment option fits best for them. Payment options: http://votesmart.org/share/api/register
**After negotiating a payment amount with the user**: If they don’t fall into the normal tiers, don’t have a key and they haven’t paid yet: To make a payment on our website, they login to MyVoteSmart, select the fee type we decided on and hit "Next" and "Checkout" and then make their payment and they should be automatically assigned and sent a key.
==**Key Deactivation**==
Deletions:
Available to the public on http://votesmart.org/share/api/register
- Other amount approved by Vote Smart. **See Next Section**.
==**Key Deactivation:**==
Payment
If a person, after figuring out a payment with them & they don’t fall into the normal tiers, asks what their next step is, and they don’t have a key and they haven’t paid yet: To make a payment on our website, they login to MyVoteSmart, select the fee type we decided on and hit "Next" and "Checkout" and then make their payment and they should be automatically assigned and sent a key.
If a person makes a payment by calling DevComm, they don’t get automatically assigned a key. For this, go to http://skittles.votesmart.org/admin/ and assign them a key. Email them what their key is.
How to log in: http://skittles.votesmart.org/admin/
Use your MyVoteSmart username and password to log in
So, the majority of the job is officemgr@votesmart.org emailing Cassie(devcomm) “Someone has subscribed to the PVS API stating that they are a current member. Please check against the following information.
Name:
Email:
Address:
If this registrant is a valid member, please visit this link. If they are not a valid member, please reply to officemgr@votesmart.org. Cassie seemingly usually replies “Not a member” and then Walker sends it to me to deal with.
From here, I send them this email, but using jamie@votesmart.org instead of officemgr@votesmart.org:
Thank you for your interest in the Vote Smart API. You indicated on your
registration form that you are a member; however, we don't have record of
your membership in our database. In order to complete your application,
you will need to review our subscription types (found here:
http://votesmart.org/share/api/register) and select the one that is most
appropriate for you. If you are unsure of which subscription level to
choose, please give our office a call, or email officemgr@votesmart.org, and we can discuss this further.
Please let me know if you have any questions.
Sometimes they reply, sometimes they don’t. I don’t know if the non-repliers pay. For those that reply: some are confused about MyVoteSmart and how that membership doesn’t actually give them a real membership; some are students that can’t afford it; some just want a one time data dump; it’s a case by case adventure.
One way to figure out how much a person should pay is to look at their survey - link located on the bottom of the second page of their admin pages. You will have to haggle with some people over email about what payment option fits best for them. Payment options: http://votesmart.org/share/api/register


Revision [19891]

Edited on 2017-04-21 15:08:19 by cassandra@votesmart.org [updated 2017 API pricing]
Additions:
==**Temporary Keys**==
===**Subscription Renewal**===
==**December Even Years Project**==
Prior to 2016, Vote Smart sent an email to the API users after December 31st telling them that their key had been deactivated. In 2016, we sent an email to API users before December 31st telling them that their key was going to be deactivated but that they could resubscribe. We crafted a letter and with the help of DevComm, sent it with iContact to all of our API subscribers from the beginning of time until November 1, 2016. We sent the letter out in mid-December. The letter needs to be enticing. To accomplish this: talk about fun things we did with our data - speeches added, ratings added, etc. Maybe other fun things our API got used with.
==**Key Deactivation:**==
Next round: December 31, 2018 (this excludes people who are on the "API Subscriptions Calendar" - they get deactivated before this date.
- DevComm pulls a spreadsheet from Donor Perfect of any person who has the "expiration date" of December 31, 2018 in the "expiration date" field.
- It will likely be done without IT’s assistance thus having to deactivate keys manually. Keys just get deactivated. __They do not get deleted__.
**How to deactivate a key:**
1. Go to the person's account in My Vote Smart under "user"
2. Click on the green plus sign next to "User API"
3. Unchck the "Active" box inside API registration.
4. Click "Save"
5. Click the “Save and Add Another” button in the user profile because it saves on the first time.
Note: there are 2 “Actives.” One under "Permissions" on the first page and One under "API Registration". "Permissions" is for the MyVoteSmart account. If you make this one inactive and the one under API Registration stays Active, the person will still have access to their API key. To fix this, just make the “Active” under API Registration inactive.
Deletions:
**==Temporary Keys==**
December Even Years Project: Subscription Renewal
Prior to 2016, Vote Smart sent an email to the API users after December 31st telling them that their key had been deactivated.
In 2016, we sent an email to API users before December 31st telling them that their key was going to be deactivated but that they could resubscribe.
We (Jamie Willett, Database Specialist and Walker McKusick, National Director) crafted a letter and with the help of DevComm, sent it with iContact to all of our API subscribers from the beginning of time until November 1, 2016. We sent the letter out in mid-December.
The letter needs to be enticing. To accomplish this: talk about fun things we did with our data - speeches added, ratings added, etc. Maybe other fun things our API got used with.
Key Deactivation: December 31, 2018
Ask DevComm for an excel document from Donor Perfect with:
Any person who has an API subscriber flag from the beginning of time up to or on November 1, 2018.
Any API subscriber who made a payment after November 1, 2018.
Everyone on this listing minus those that have made a payment after 11/1/2018 are to be deactivated December 31, 2018.
It will likely be done without IT’s assistance thus having to deactivate keys manually.
Keys just get deactivated. They do not get deleted.
*** For key deactivation, there are 2 “Actives” one under Permissions on the first page and one under API Registration (bottom of first page link or here for an example). The one under Permissions is for the MyVoteSmart account. If you make this one inactive and the one under API Registration stays Active, the person will still have access to their API key. To fix this, just make the “Active” under API Registration inactive. Use the “Save and Add Another” button because it saves on the first time.
Key Deactivation: Multiple Actives Thus Key Not Actually Being Deactivated
Mentioned more up in key deactivation
Duplicate Keys
Unfortunately, dupes exist even in API keys. Sheet 2 of this google doc displays all the duplicate keys that I am aware of. There are probably others. To check, ask IT to query out all the API keys and the information attached to them.
How to fix these dupes
Not sure yet.


Revision [19890]

Edited on 2017-04-21 14:55:51 by cassandra@votesmart.org [updated 2017 API pricing]
Additions:
**==Temporary Keys==**
Deletions:
**Temporary Keys==**


Revision [19889]

Edited on 2017-04-21 14:55:26 by cassandra@votesmart.org [updated 2017 API pricing]
Additions:
- For the people who really seem like they’re going to create something cool with our data - we’d rather have them try our API service out instead of using another organization’s API service.
- Sometimes it’s okay to give a free temporary key to an organization so that they can experience our API and see if it’s what they want. A short, 2 week - 1 month API key should suffice them and give them enough experience with our API.
- We can be flexible with pricing plans. Ex. They pay $1000 up front and then pay $1000 in ____ amount of months.
Deletions:
- For the people who really seem like they’re going to create something cool with our data - we’d rather have them try our API service out instead of using another organization’s API service.
- Sometimes it’s okay to give a free temporary key to an organization so that they can experience our API and see if it’s what they want. A short, 2 week - 1 month API key should suffice them and give them enough experience with our API.
- We can be flexible with pricing plans. Ex. They pay $1000 up front and then pay $1000 in ____ amount of months.


Revision [19888]

Edited on 2017-04-21 14:54:33 by cassandra@votesmart.org [updated 2017 API pricing]
Additions:
=====**Administrating the API**=====
Deletions:
=====Administrating the API=====


Revision [19887]

Edited on 2017-04-21 14:54:22 by cassandra@votesmart.org [updated 2017 API pricing]
Additions:
==**Tiers**==
We run into scenarios a lot, where an app developer wants to use our API data publicly, but has no idea how many users to expect/profit will be gained and therefore wants an exception to our subscription fee. They often cannot pay the $2,000 we expect for publicly disseminating our data. They often want to have subscription fees that increase in tandem with users and profit, starting at a manageable fee and increasing over time.
**Temporary Keys==**
The same process as administering a real key (see above). Only difference? Temporary keys expire quicker.
The calendar "API Subscription Notices" is filled with reminders to deactivate API keys along with reminders about payments coming due for larger users. (example: National Journal). If you give someone a temporary key, put on this calendar the expiration date so you remember to deactivate. When passing on the API, make sure you share this calendar with the new people. Calendar settings > share this calendar > add by email with permission settings “Make changes AND manage sharing”
Deletions:
==**Tiers:**==
We run into scenarios a lot, where an app developer wants to use our API data publicly, but has no idea how many users to expect/profit will be gained and therefore wants an exception to our subscription fee.
We often have subscribers that are not in a position to pay the $2,000 we expect for publicly disseminating our data. They often want to have subscription fees that increase in tandem with users and profit, starting at a manageable fee and increasing over time.
Temporary Keys
Basically the same thing as real keys.
Only difference? Temporary keys expire quicker.
The calendar API Subscription Notices is filled with reminders to deactivate API keys along with reminders about payments coming due for larger users. (example: National Journal)
When passing on the API, make sure you share this calendar with the new people. Calendar settings > share this calendar > add by email with permission settings “Make changes AND manage sharing”


Revision [19886]

Edited on 2017-04-21 14:52:02 by cassandra@votesmart.org [updated 2017 API pricing]
Additions:
- **$2000** - I represent a lobbyist, government, PAC, labor union, law firm, political party, candidate, or an organization seeking to use this information for lobbying or campaigning. I do not expect to exceed 25,000 API calls per month or distribute this content to more than 40,000 people. I will not attempt to relicense or resell this information. I understand that if my actual usage is higher that I will be subject to additional fees.
- Other amount approved by Vote Smart. **See Next Section**.
==**High-End API Users**==
The National Director should be involved with any cases that are **$2,000+**. The National Director should also be involved with those who have payment schedules. $2,000+ needs to be in a contract, on the calendar, and also be sent invoices.
==**Special Cases: App Developers**==
We run into scenarios a lot, where an app developer wants to use our API data publicly, but has no idea how many users to expect/profit will be gained and therefore wants an exception to our subscription fee.
This is where your judgement comes into play. We make exceptions for users who fall into at least two of the three categories:
- Not a direct competitor
- Very low usage
- Financial constraints
**Pro:** We make money as they do, which could turn into a real profit for us. There's no downfall for us if their site doesn't generate profit/users.
**Con:** We truly have little way/resources to be monitoring their users. So we would be trusting the user to report user/profit increases.
A good way to deal with people like this is **staggered fees**.
- For the people who really seem like they’re going to create something cool with our data - we’d rather have them try our API service out instead of using another organization’s API service.
- Sometimes it’s okay to give a free temporary key to an organization so that they can experience our API and see if it’s what they want. A short, 2 week - 1 month API key should suffice them and give them enough experience with our API.
- We can be flexible with pricing plans. Ex. They pay $1000 up front and then pay $1000 in ____ amount of months.
==**Special Cases: Students**==
- Ask why they need the API. Strictly academic: $45 is fair but up to you.
- Temporary keys are also an option - no more than 1 month.
- Except developing apps, see above. Apps are always public-facing.
Deletions:
High-End API Users
The National Director should be involved with any cases that are $2,000+.
The National Director should also be involved with those who have payment schedules.
$2,000+ needs to be in a contract, on the calendar, and also be sent invoices.
Special Cases: App Developers
So we run into these scenarios a lot, where an app developer wants to use our API data publicly, but has no idea how many users to expect/profit will be gained and therefore wants an exception to our subscription fee.
This is where your judgement comes into play. We make exceptions for users who fall into at least two of the three categories: Not a direct competitor, very low usage, financial constraints.
Pro: We make money as they do, which could turn into a real profit for us. There's no downfall for us if their site doesn't generate profit/users.
Con: We truly have little way/resources to be monitoring their users. So we would be trusting the user to report user/profit increases.
A good way to deal with people like this is staggered fees.
For the people who really seem like they’re going to create something cool with our data - we’d rather have them try our API service out instead of using another organization’s API service.
Sometimes it’s okay to give a free temporary key to an organization so that they can experience our API and see if it’s what they want. A short, 2 month API key should suffice them and give them enough experience with our API.
Special Cases: Students
Ask why they need the API.
Strictly academic: $45 is fair but up to you.
A lot of students will make the case that they can’t pay $45. It’s really up to you if you want to give them the “$15 millennial fee” or if you want to just go ahead and give them a free key for the duration of their project.
Except developing apps, see above. Apps are always public-facing.
Temporary keys work best with students.


Revision [19885]

Edited on 2017-04-21 14:45:14 by cassandra@votesmart.org [updated 2017 API pricing]
Additions:
===**Pricing:**===
Available to the public on http://votesmart.org/share/api/register
==**Tiers:**==
- **$0** - I am already a member of Project Vote Smart.
- **$45** - I would like to become a Project Vote Smart Member so that I may access the API and receive other member benefits. This tier includes people who want the API for personal, non-business use.
- **$100** - I represent an educational institution or 501 c3 non-profit that is using the API occasionally. My organization is not providing Vote Smart data to the general public, or using it for resale, lobbying or campaigning in any way.
- **$250** - I represent a corporation, news organization, or foundation that is using the API occasionally. My organization is not providing Vote Smart data to the general public, or using it for resale, lobbying or campaigning in any way.
- **$2000** - I represent an organization of any type that is providing Vote Smart data to the general public. I do not expect my organization's sites and online applications to exceed 40k visitors/end users per month, or exceed 25,000 API calls per month. I will not attempt to relicense or resell this information. I understand that if my actual usage is higher that I will be subject to additional fees. **Anyone providing our data to the public falls in this tier.**


Revision [19884]

Edited on 2017-04-21 14:40:20 by cassandra@votesmart.org [updated 2017 API pricing]
Additions:
- **We don’t want more than one person having the same API key**. If you give 2 people the same API key and deactivate the key for 1 user, then the other person looses access.
- Multiple Users, Same API Key: *Dupes*
- There are currently some users using the same key - see the [[https://docs.google.com/spreadsheets/d/1qCkULW664BTuUtNzcfZlV7OcJq1sWfkDilTThTP6fgU/edit#gid=534095835 API Users and their keys]] doc - sheet 2.
- A work around: deleting one of the users and then adding them back into the system. (Only did this with Britton’s account, because we don’t want to change the usernames/passwords for actual users.)
-Free Keys:
- Not so much a quirk but moreso we don’t know how many we have in the system because they aren’t tracked by Donor Perfect.
- Easy fix: get IT to query out these keys.
Deletions:
- We don’t want more than one person having the same API key. If you give 2 people the same API key and deactivate the key for 1 user, then the other person looses access.
- There are currently some users using the same key - see the [[https://docs.google.com/spreadsheets/d/1qCkULW664BTuUtNzcfZlV7OcJq1sWfkDilTThTP6fgU/edit#gid=534095835 API Users and their keys]] doc
- Multiple Users, Same API Key: Dupes
- Raises the issue of how many users are like this. IT should be able to query this importation out
- Raises the issue that if we do ever get around to being able to track how many calls keys do - having multiple users with the same API key will obstruct that data.
Only way I have managed the work around is by deleting one of the users and then adding them back into the system. (Only did this with Britton’s account, because I don’t want to change the usernames/passwords for actual users. But this could be the only way.)
Free keys
Not so much a quirk but moreso we don’t know how many we have in the system because they aren’t tracked by Donor Perfect.
Easy fix: get IT to query out these keys.
Receipts
I have no experience with receipts. Walker and/or Cassie might.


Revision [19883]

Edited on 2017-04-21 14:34:08 by cassandra@votesmart.org [updated 2017 API pricing]
Additions:
==**API Admin Quirks**==
Deletions:
===**API Admin Quirks**===


Revision [19882]

Edited on 2017-04-21 14:33:56 by cassandra@votesmart.org [updated 2017 API pricing]
Additions:
===**Backend of API Administration**===
Deletions:
===**Backend of API Administration*===


Revision [19881]

Edited on 2017-04-21 14:33:45 by cassandra@votesmart.org [updated 2017 API pricing]
Additions:
===**Backend of API Administration*===
1. Log in to the user's profile
2. Next to "user API", click the little green plus sign
3. Find a key you already know is in use and change a few letters/numbers around in it. This has a 100% success rate thus far.
4. Do NOT ever select a key from the drop down list. This is a key that is already in use
5. You’ll have to add other info: subscription type, Reg subscription other amount:, reg date, Reg subscription start. You’ll have to check “Active” & “Accepted tos” boxes for the key to work.
6. Hit save on the popup and also “save and add another” in the user profile for the key to save. By doing the “save and add another” save, API admin will alert you if you tried adding an already in-use key. Double check that it saved by going back into that user and checking if the key is listed in the "User API" box.
**ALWAYS** test the key out prior to letting the people know what their key is.
To test: http://api.votesmart.org/Election.getElectionByYearState?&key=KEY&year=2016 Where it says KEY paste that key you just created and hit enter. If the message is “Authorization failed” it means that key didn’t work and you’ll have to try again.
===**API Admin Quirks**===
- Multiple Users, Same API Key: Dupes
- Dupes end up sharing everything: same key, same survey. If you make one of the dupes inactive, both keys become inactive. If you change one of the keys to something else, both keys change to the same thing.
- Raises the issue of how many users are like this. IT should be able to query this importation out
- Raises the issue that if we do ever get around to being able to track how many calls keys do - having multiple users with the same API key will obstruct that data.
Deletions:
1. Do NOT select a key from the drop down list. This is a key that is already in use
2. Do the little green plus button which is “add another key” and make up a series of letters and numbers.
When you do this, you’ll also have to add a bunch of other information: subscription type, etc. You’ll also have to check “Active” and “Accepted tos” for the key to be able to work.
You’ll have to hit save on the popup and also “save and add another” for the key to save.
By doing the “save and add another” save, API admin will alert you if you tried adding an already in-use key.
Double check that it saved by going back into that user and checking.
It doesn’t always accept the random letters/numbers series you come up with. ALWAYS test the key out prior to letting the people know what their key is.
To test: http://api.votesmart.org/Election.getElectionByYearState?&key=KEY&year=2016 Where it says KEY paste that key you just created and hit enter. If the message is “Authorization failed” it means that your random numbers/letters series didn’t work and you’ll have to try again.
My work around: start with a key you already know is in use and change a few letters/numbers around in it. This has a 100% success rate thus far.
API Admin Quirks
Multiple Users, Same API Key: Dupes
Dupes end up sharing everything: same key, same survey
Raises the issue of how many users are like this. IT should be able to query this importation out
Raises the issue that if we do ever get around to being able to track how many calls keys do - having multiple users with the same API key will obstruct that data.
If you make one of the dupes inactive, both keys become inactive
If you change one of the keys to something else, both keys change to the same thing


Revision [19880]

Edited on 2017-04-21 14:21:51 by cassandra@votesmart.org [updated 2017 API pricing]

No Differences

Revision [19879]

Edited on 2017-04-21 14:21:39 by cassandra@votesmart.org [updated 2017 API pricing]
Additions:
>>{{{toc}}}>>
For more information on what the API is, visit [[http://wiki.votesmart.org/APIandDataRequests API Overview]]
==**Getting to a user's profile on Django Admin**==
Deletions:
==**Backend of API Administration**==


Revision [19878]

Edited on 2017-04-21 14:20:17 by cassandra@votesmart.org [updated 2017 API pricing]
Additions:
==**Who takes care of what**==
Deletions:
===**Who takes care of what**===


Revision [19877]

Edited on 2017-04-21 14:20:06 by cassandra@votesmart.org [updated 2017 API pricing]
Additions:
=====Administrating the API=====
Deletions:
=====Administrating the API====


Revision [19876]

The oldest known version of this page was created on 2017-04-21 14:19:52 by cassandra@votesmart.org [updated 2017 API pricing]
Valid XHTML :: Valid CSS: :: Powered by WikkaWiki