Revision history for APIandDataRequests


Revision [57660]

Last edited on 2021-06-15 14:56:28 by walker
Additions:
As of 2013, our key stated use policy is: "Vote Smart does not permit the use of its name or programs in any campaign activity, including advertising, debates, and speeches."
Deletions:
As of 2013, our key stated use policy is: "Project Vote Smart does not permit the use of its name or programs in any campaign activity, including advertising, debates, and speeches."

Revision [57301]

Edited on 2020-12-10 10:55:50 by walker [clarifier on caching]
Additions:
**Random Note:** Caching data helps the stress on our organization's servers. Since most of our data is not updated every day, subscribers don't need to call on our API as frequently. Most large subscribers cache our data. It's our job to give them a sense of the frequency that data updates.
Deletions:
**Random Note:** 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.

Revision [57300]

Edited on 2020-12-10 10:51:09 by walker [update attached docs]
Additions:
- [[http://wiki.votesmart.org/APIandDataRequests/files.xml?action=download&file=VS%20API%20Fact%20Sheet.pdf API Fact Sheet for Subscribers]]
Deletions:
- [[http://wiki.votesmart.org/APIandDataRequests/files.xml?action=download&file=PVS%20Data%20Graphic%20%28Exists%20in%20Canva%21%29.pdf Data available via API- graphic]]

Revision [57299]

Edited on 2020-12-10 10:47:21 by walker [update attached docs]
Additions:
**[[https://votesmart.org/share/widgets Widgets]]** - Vote Smart provides some ‘widgets’ which are essentially completed code so users can just cut and paste them into their websites. This is an easy way for users to integrate Vote Smart data. Widgets are built on top of the API and will require a valid key.
Deletions:
**Widgets** - Vote Smart provides some ‘widgets’ which are essentially completed code so users can just cut and paste them into their websites. This is an easy way for users to integrate Vote Smart data. Widgets are built on top of the API and will require a valid key.

Revision [57298]

Edited on 2020-12-10 10:44:40 by walker [update attached docs]
Additions:
Inquiries about campaign finance data should be directed to [[CRP]] and [[NIMSP]]. We do offer [[https://github.com/votesmart/political-id-match ID matching]] in order to help subscribers use both data sets.
Deletions:
Inquiries about campaign finance data should be directed to CRP and NIMSP. We do offer [[https://github.com/votesmart/political-id-match ID matching]]
in order to help subscribers use both data sets.

Revision [57297]

Edited on 2020-12-10 10:43:56 by walker [add campaign finance info]
Additions:
- candidates: basic background, educational experience, political experience, professional experience, contact information, issue positions;
Inquiries about campaign finance data should be directed to CRP and NIMSP. We do offer [[https://github.com/votesmart/political-id-match ID matching]]
in order to help subscribers use both data sets.
Deletions:
- candidates: basic background, educational experience, political experience, professional experience, contact information;

Revision [57295]

Edited on 2020-12-10 10:39:27 by walker [add campaign finance info]
Additions:
- Message to academics that we give PCT Archive access to: "Please cite us if you end up publishing a paper/article that uses our data, and do not make the PCT archive raw data directly accessible to the public. Publishing conclusions based on analysis of our data is alright and encouraged, however our proprietary raw data needs to be protected from redistribution. Feel free to call or email any questions on this."
- In 2020, we had success granting access to issue position research via UndocumentedAPIMethods. These still require a key for access. This data is typically treated as more valuable and proprietary than others.
Deletions:
- Message to acedemics that we give PCT Archive access to: "Please cite us if you end up publishing a paper/article that uses our data, and do not make the PCT archive raw data directly accessible to the public. Publishing conclusions based on analysis of our data is alright and encouraged, however our proprietary raw data needs to be protected from redistribution. Feel free to call or email any questions on this."

Revision [54547]

Edited on 2019-03-08 09:59:28 by walker [add campaign finance info]
Additions:
-raw data provided by our [[CategoryExternalDataSources data partners]], including [[http://wiki.votesmart.org/Aristotle Aristotle]] (though zip-to-district queries may be done via the API and our widget)
Deletions:
-raw data provided by our [[CategoryExternalDataSources data partners]] (though zip-to-district queries may be done via the API and our widget)

Revision [21376]

Edited on 2018-04-13 15:55:02 by walker [add campaign finance info]
Additions:
[[UndocumentedAPIMethods Undocumented API Methods]] - used mostly for VoteEasy (may only be given out on a case-by-case basis, with permission from the National Director)
Deletions:
[[UndocumentedAPIMethods Undocumented API Methods]] (may only be given out on a case-by-case basis, with permission from the National Director)

Revision [20938]

Edited on 2018-01-30 14:36:25 by Peter [add campaign finance info]
Additions:
- Message to acedemics that we give PCT Archive access to: "Please cite us if you end up publishing a paper/article that uses our data, and do not make the PCT archive raw data directly accessible to the public. Publishing conclusions based on analysis of our data is alright and encouraged, however our proprietary raw data needs to be protected from redistribution. Feel free to call or email any questions on this."

Revision [20931]

Edited on 2018-01-30 11:06:03 by Peter [add campaign finance info]
Additions:
- 2016 PCT Archive Data is limited because we changed questions and retested during the GE Election. The Archives only store the answers from candidates who took it after the change. Candidate 171448 is an example of a candidate who passed in 2016 but is not included in the archives.
Deletions:
- 2016 PCT Archive Data is limited because we changed questions and retested during the GE Election. The Archives only store the answers from candidates who took it after the change.

Revision [20301]

Edited on 2017-10-10 12:28:52 by Peter [add campaign finance info]
Additions:
- Special permission may be granted on a case-by-case basis to our "PCT" (for journalists and academics only), as long as they abide by our terms of use. The Director of Elections Research and National Director should be consulted for approval. They must create a MyVoteSmart account on our site first. Then, they can be granted access via Django Admin: the user permission "pctarch" will grant access. They would then access the data by logging in and going to their User Panel. As of 6/7/16 the PCT Archives may be a little buggy, but we currently do not have the resources to apply to updates at present, or to provide users with this historical data in bulk in some other format
Deletions:
- Special permission may be granted on a case-by-case basis to our "PCT
-
- " (for journalists and academics only), as long as they abide by our terms of use. The Director of Elections Research and National Director should be consulted for approval. They must create a MyVoteSmart account on our site first. Then, they can be granted access via Django Admin: the user permission "pctarch" will grant access. They would then access the data by logging in and going to their User Panel. As of 6/7/16 the PCT Archives may be a little buggy, but we currently do not have the resources to apply to updates at present, or to provide users with this historical data in bulk in some other format

Revision [20294]

Edited on 2017-10-06 18:00:37 by Peter [add campaign finance info]
Additions:
- Special permission may be granted on a case-by-case basis to our "PCT
-
- " (for journalists and academics only), as long as they abide by our terms of use. The Director of Elections Research and National Director should be consulted for approval. They must create a MyVoteSmart account on our site first. Then, they can be granted access via Django Admin: the user permission "pctarch" will grant access. They would then access the data by logging in and going to their User Panel. As of 6/7/16 the PCT Archives may be a little buggy, but we currently do not have the resources to apply to updates at present, or to provide users with this historical data in bulk in some other format
- 2016 PCT Archive Data is limited because we changed questions and retested during the GE Election. The Archives only store the answers from candidates who took it after the change.
Deletions:
- Special permission may be granted on a case-by-case basis to our "PCT Archives" (for journalists and academics only), as long as they abide by our terms of use. The Director of Elections Research and National Director should be consulted for approval. They must create a MyVoteSmart account on our site first. Then, they can be granted access via Django Admin: the user permission "pctarch" will grant access. They would then access the data by logging in and going to their User Panel. As of 6/7/16 the PCT Archives may be a little buggy, but we currently do not have the resources to apply to updates at present, or to provide users with this historical data in bulk in some other format

Revision [20283]

Edited on 2017-09-07 09:49:06 by walker [add campaign finance info]
Deletions:
*Currently, historical PCT information is not currently available in bulk due to resource limitations.

Revision [20282]

Edited on 2017-09-07 09:47:34 by walker [add campaign finance info]
Additions:
- Neither API PCT calls nor the PCT Archives include researched Issue Position Data, only answers from candidate who have taken the PCT
- The difference between API PCT calls and the PCT Archives is that the API only offers access to candidates' most recent PCT responses, whereas the PCT Archives include all past PCT questions and candidate answers
Deletions:
- Neither API PCT calls nor the PCT Archives include researched Issue Position Data, only answers from candidate who have taken the PCT
- The difference between API PCT calls and the PCT Archives is that the API only offers access to candidates' most recent PCT responses, whereas the PCT Archives include all past PCT questions and candidate answers

Revision [20281]

Edited on 2017-09-06 11:30:00 by Peter [add campaign finance info]
Additions:
- Neither API PCT calls nor the PCT Archives include researched Issue Position Data, only answers from candidate who have taken the PCT
- The difference between API PCT calls and the PCT Archives is that the API only offers access to candidates' most recent PCT responses, whereas the PCT Archives include all past PCT questions and candidate answers

Revision [20280]

Edited on 2017-09-06 11:08:26 by walker [add campaign finance info]
Additions:
- Special permission may be granted on a case-by-case basis to our "PCT Archives" (for journalists and academics only), as long as they abide by our terms of use. The Director of Elections Research and National Director should be consulted for approval. They must create a MyVoteSmart account on our site first. Then, they can be granted access via Django Admin: the user permission "pctarch" will grant access. They would then access the data by logging in and going to their User Panel. As of 6/7/16 the PCT Archives may be a little buggy, but we currently do not have the resources to apply to updates at present, or to provide users with this historical data in bulk in some other format
Deletions:
- Special permission may be granted on a case-by-case basis to our "PCT Archives" (for journalists and academics only), as long as they abide by our terms of use. The Director of Officials Research and National Director should be consulted for approval. They must create a MyVoteSmart account on our site first. Then, they can be granted access via Django Admin: the user permission "pctarch" will grant access. They would then access the data by logging in and going to their User Panel. As of 6/7/16 the PCT Archives may be a little buggy, but we currently do not have the resources to apply to updates at present, or to provide users with this historical data in bulk in some other format

Revision [20070]

Edited on 2017-05-17 13:00:50 by walker [pct archives info on django]
Additions:
- Special permission may be granted on a case-by-case basis to our "PCT Archives" (for journalists and academics only), as long as they abide by our terms of use. The Director of Officials Research and National Director should be consulted for approval. They must create a MyVoteSmart account on our site first. Then, they can be granted access via Django Admin: the user permission "pctarch" will grant access. They would then access the data by logging in and going to their User Panel. As of 6/7/16 the PCT Archives may be a little buggy, but we currently do not have the resources to apply to updates at present, or to provide users with this historical data in bulk in some other format
Deletions:
- Special permission may be granted on a case-by-case basis to our PCT Archives (for journalists and academics only), as long as they abide by our terms of use. They must create a MyVoteSmart account on our site first, at which point we would create a mantis ticket asking IT to grant access to the PCT Archives for that username. They would then access the data by logging in and going to their User Panel. As of 6/7/16 the PCT Archives may be a little buggy, but we currently do not have the resources to apply to updates at present, or to provide users with this historical data in bulk in some other format

Revision [19942]

Edited on 2017-04-21 17:27:29 by cassandra@votesmart.org [pct archives info on django]
Additions:
**Widgets** - Vote Smart provides some ‘widgets’ which are essentially completed code so users can just cut and paste them into their websites. This is an easy way for users to integrate Vote Smart data. Widgets are built on top of the API and will require a valid key.
**Libraries**- Vote Smart provides libraries, which are pieces of code that will directly connect to Vote Smart servers through our API. This gives users controlled access to our database where we provide the data in a way we think will be useful to the users. This is a powerful way for an outside entity to access our data but it does require some technical ability. Multiple libraries are provided so outside developers can work with their preferred programming language; currently we have libraries in Java, Ruby, Python, PHP, and R.
Deletions:
**Widgets** - PVS provides 'widgets' which are essentially completed code that we provide so the users can just cut and paste it into their website. This will be the easiest way for users to integrate our data. Widgets are built on top of the API and require a valid key.
**Libraries**- We also provide libraries, which are pieces of code that will directly connect to our servers through our API interface. This does not give them raw access to our database but a controlled access where we provide the data in a way we think will be useful to the users. This is the most powerful way for an outside entity to access our data but it does require some technical ability. Multiple libraries will be provided so outside developer can work with their preferred programming language. If necessary, we can also provide documentation on our API interface so developers can create their own libraries.

Revision [19941]

Edited on 2017-04-21 17:26:23 by cassandra@votesmart.org [pct archives info on django]
Additions:
**Widgets** - PVS provides 'widgets' which are essentially completed code that we provide so the users can just cut and paste it into their website. This will be the easiest way for users to integrate our data. Widgets are built on top of the API and require a valid key.
**Libraries**- We also provide libraries, which are pieces of code that will directly connect to our servers through our API interface. This does not give them raw access to our database but a controlled access where we provide the data in a way we think will be useful to the users. This is the most powerful way for an outside entity to access our data but it does require some technical ability. Multiple libraries will be provided so outside developer can work with their preferred programming language. If necessary, we can also provide documentation on our API interface so developers can create their own libraries.

Revision [19940]

Edited on 2017-04-21 17:07:14 by cassandra@votesmart.org [pct archives info on django]
Additions:
- [[http://wiki.votesmart.org/APIandDataRequests/files.xml?action=download&file=PVS%20Data%20Graphic%20%28Exists%20in%20Canva%21%29.pdf Data available via API- graphic]]
- [[http://wiki.votesmart.org/APIandDataRequests/files.xml?action=download&file=Vote%20Smart%20Data%20Coverage.ods PVS data coverage]]
Deletions:
- [[http://wiki.votesmart.org/APIandDataRequests/files.xml?action=download&file=PVS%20Data%20Graphic%20%28Exists%20in%20Canva%21%29.pdf Data available via API graphic]]
- [[http://wiki.votesmart.org/APIandDataRequests/files.xml?action=download&file=Vote%20Smart%20Data%20Coverage.ods data coverage]]

Revision [19939]

Edited on 2017-04-21 17:06:23 by cassandra@votesmart.org [pct archives info on django]
Additions:
**Random Note:** 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 [19938]

Edited on 2017-04-21 17:04:55 by cassandra@votesmart.org [pct archives info on django]
Additions:
===Additional API Resources===
Deletions:
==Additional API Resources==

Revision [19937]

Edited on 2017-04-21 17:04:22 by cassandra@votesmart.org [pct archives info on django]
Additions:
Most of Vote Smart’s data is available through the API (Application Program Interface). Subscribers of the API obtain access to a vast database of information that has been collected by Vote Smart’s staff, interns, and volunteers since 1992.
Some of the data Vote Smart covers includes:
- candidates: basic background, educational experience, political experience, professional experience, contact information;
- elections: ballot measures, primary and general election tracking;
- special interest groups (SIGs): ratings;
- legislation: original bill summaries, federal and state voting records, and executive vetoes.
**Purpose of the API:**
The API allows people outside of Vote Smart to integrate our data into their applications. Some people even use it for their personal use, news articles, and school research papers. The API responds to simple requests for data, such as ‘get biographical information for candidate Y’ and ‘get votes information for candidate X.’ Each type of request (get bio, get votes) has to be planned for. Our API provides data in XML or JSON format.

Revision [19936]

Edited on 2017-04-21 17:03:21 by cassandra@votesmart.org [pct archives info on django]
Additions:
====What is the API?====
===Scope of Data Available in the API===
===How To Use the API===
Deletions:
====Scope of Data Available in the API====
====How To Use the API====

Revision [19935]

Edited on 2017-04-21 17:02:12 by cassandra@votesmart.org [pct archives info on django]
Additions:
==Additional API Resources==
Deletions:
==**Additional API Resources**==

Revision [19934]

Edited on 2017-04-21 17:01:57 by cassandra@votesmart.org [pct archives info on django]
Additions:
==**Additional API Resources**==
Deletions:
====Additional API Resources====

Revision [19933]

Edited on 2017-04-21 17:01:25 by cassandra@votesmart.org [pct archives info on django]
Additions:
*Currently, historical PCT information is not currently available in bulk due to resource limitations.

Revision [19931]

Edited on 2017-04-21 16:59:40 by cassandra@votesmart.org [pct archives info on django]
Additions:
-Information sourced from the public domain (government websites, campaign websites, etc.)
-Unique content generated by Project Vote Smart (for example, ratings reports, legislative summaries, PCT questions)
-Candidate-submitted content that we otherwise display publicly
-Content we are using under fair use but do not have clear authorization to redistribute (speeches)
-Content which may be of an unclear origin and thus our rights to redistribute are unclear (photos)
-Candidate-submitted content not publicly-available on our website (except at the request of the candidate who authored it, journalists, and academics)
- Determine if they truly **need** bulk data? depending on their needs, they may actually find want they're looking for on our voter-oriented tools listed [[ManagingInformationDelivery here]]
- [[http://wiki.votesmart.org/APIAdministration DevComm: How To Administer the API]] (registering users, pricing, subscription length, etc.)
- The pricing policy is stated in the [[http://votesmart.org/share/api/register registration form]]
Deletions:
-information sourced from the public domain (government websites, campaign websites, etc.)
-unique content generated by Project Vote Smart (for example, ratings reports, legislative summaries, PCT questions)
-candidate-submitted content that we otherwise display publicly
-content we are using under fair use but do not have clear authorization to redistribute (speeches)
-content which may be of an unclear origin and thus our rights to redistribute are unclear (photos)
-candidate-submitted content not publicly-available on our website (except at the request of the candidate who authored it, journalists, and academics)
- determine if they truly **need** bulk data? depending on their needs, they may actually find want they're looking for on our voter-oriented tools listed [[ManagingInformationDelivery here]]
- [[http://wiki.votesmart.org/APIAdministration How To Administer the API]] (registering users, pricing, subscription length, etc.)
====Understanding the API====
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.
The pricing policy is stated in the [[http://votesmart.org/share/api/register registration form]].

Revision [19930]

Edited on 2017-04-21 16:57:51 by cassandra@votesmart.org [pct archives info on django]

No Differences

Revision [19929]

Edited on 2017-04-21 16:57:38 by cassandra@votesmart.org [pct archives info on django]
Additions:
====Additional API Resources====
- [[http://wiki.votesmart.org/APIAdministration How To Administer the API]] (registering users, pricing, subscription length, etc.)
Deletions:
====Additional API Resources
- [[http://wiki.votesmart.org/APIAdministration How To Administer the API (registering users, pricing, subscription length, etc.)

Revision [19928]

Edited on 2017-04-21 16:57:20 by cassandra@votesmart.org [pct archives info on django]
Additions:
====Additional API Resources
- [[http://wiki.votesmart.org/APIAdministration How To Administer the API (registering users, pricing, subscription length, etc.)
Deletions:
In order to answer the bulk of questions you will get, you will need to familiarize yourself with:
- [[http://wiki.votesmart.org/APIandDataRequests#hn_Special_Delivery_Mechanisms_for_Bulk_Data_Users the purpose and role of the API]]
- [[http://wiki.votesmart.org/APIandDataRequests#hn_How_To_Use_the_API how the API and registration process works for users]] ( It helps to go through and register for a key for yourself, and then use that key to pull out data)
- [[http://wiki.votesmart.org/APIandDataRequests#hn_Scope_of_Data_Available_in_the_API the data included in it (and not included)]]
- the policies surrounding it: [[http://wiki.votesmart.org/APIandDataRequests#hn_Terms_of_Use_and_Enforcement Terms of Use and Enforcement]], [[http://wiki.votesmart.org/APIandDataRequests#hn_Current_Policies_for_Standard_API_Subscriptions Standard Subscription Terms and Charging Policies]]

Revision [19927]

Edited on 2017-04-21 16:54:39 by cassandra@votesmart.org [pct archives info on django]
Additions:
This is displayed on each candidate's Political Courage Test webpage, on our section describing what the political courage test is, as part of our website's copyright notice, and on our webpage "For Candidates." It is also distributed to all candidates as part of our Political Courage Test Bulk Communications. Violations of this particular policy are addressed as "[[CandidateFights Candidate Fights]]," while other violations are addressed by the National Director
Deletions:
This is displayed on each candidate's Political Courage Test webpage, on our section describing what the political courage test is, as part of our website's copyright notice, and on our webpage "For Candidates." It is also distributed to all candidates as part of our Political Courage Test Bulk Communications. Violations of this particular policy are addressed as "[[CandidateFights Candidate Fights]]," while other violations are addressed by the National Director.

Revision [19926]

Edited on 2017-04-21 16:53:53 by cassandra@votesmart.org [pct archives info on django]
Additions:
- [[http://wiki.votesmart.org/APIandDataRequests/files.xml?action=download&file=PVS%20Data%20Graphic%20%28Exists%20in%20Canva%21%29.pdf Data available via API graphic]]
Deletions:
- [[PVS Data Graphic (Exists in Canva!).pdf Data available via API graphic]]

Revision [19925]

Edited on 2017-04-21 16:50:54 by cassandra@votesmart.org [pct archives info on django]
Additions:
[[http://wiki.votesmart.org/APIandDataRequests/files.xml?action=download&file=API%20Information%20Sheet.docx API Info Sheet]]
Deletions:
[[<a href="http://wiki.votesmart.org/APIandDataRequests/files.xml?action=download&file=API%20Information%20Sheet.docx API Info Sheet]]

Revision [19924]

Edited on 2017-04-21 16:50:40 by cassandra@votesmart.org [pct archives info on django]
Additions:
[[<a href="http://wiki.votesmart.org/APIandDataRequests/files.xml?action=download&file=API%20Information%20Sheet.docx API Info Sheet]]
Deletions:
[[http://wiki.votesmart.org/APICribSheet API Crib Sheet]]

Revision [19923]

Edited on 2017-04-21 16:45:22 by cassandra@votesmart.org [pct archives info on django]
Additions:
- [[PVS Data Graphic (Exists in Canva!).pdf Data available via API graphic]]
Deletions:
- [[http://wiki.votesmart.org/APIandDataRequests/files.xml?action=download&file=Vote%20Smart%20Data%20Crib%20Sheet.pdf the data crib sheet]]

Revision [19922]

Edited on 2017-04-21 16:41:08 by cassandra@votesmart.org [pct archives info on django]
Additions:
====Routing API-Related Communications====
Deletions:
===Routing API-Related Communications===
===Reviewing Existing API Subscriptions===
If you need to review an API registration at a later date, you can access their user account through Django admin (http://skittles.votesmart.org/admin). Click on Users, search by user name or email address, and then click on the user. Scroll down to the bottom of the page, which displays the API key next to API Registration. The key is a link, which will then display information including the subscription type, whether the key is active, and survey details. From this interface you may manually activate or deactivate a key. Click on the link by survey details (API Subscription Survey) to review the registration form. ***Check Mantis ticket #0006752 to see if this has changed per Melanie and Mike's conversation***API subscribers imported from the old system may not have had their survey transferred, and their answers may only be available via the original survey in Icontact. This is also stored here: hr/5- PROJECT MGMT/API Information/Nov 11 - Oct 12 API Registration Forms. If you want them to fill out the survey, you can send them to the following page and just tell them not to bother with making payment at the following step: http://votesmart.org/share/api/register/step-2 [^]. An email may also be sent out to affected users to make this request\
===Administering API Renewals and Deactivations===
Temporary keys, custom payment plans, special contracts, and those who pay for subscriptions outside of the API subscription registration page, will need to be handled manually through Django Admin. It is a good idea to set Google Calendar alerts for notifications, invoicing, and deactivations.
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 to our Resources for API subscribers as necessary.
To some extent, renewal requests may be automated with assistance from IT. Warnings should begin at least 30 days prior to the current subscription term end date. At this point, it would also be a good idea to request stats on the usage of our data on their products. Users may renew in the same manner that they originally signed up. After the subscription term end date or trial key end date, subscribers who do not renew should be notified that their key will be deactivated, and then actually deactivated by deselecting "active" on their key in Django Admin.
Because of the various complications with API subscribers, it is wise to reconcile the API payments recorded in Donor Perfect with the roster of current subscribers on a quarterly basis, deactivating past-due subscribers as necessary and making sure all those who paid the appropriate amounts for a full subscription have their key still active
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 [19920]

Edited on 2017-04-21 16:32:52 by cassandra@votesmart.org [pct archives info on django]
Additions:
Because of the various complications with API subscribers, it is wise to reconcile the API payments recorded in Donor Perfect with the roster of current subscribers on a quarterly basis, deactivating past-due subscribers as necessary and making sure all those who paid the appropriate amounts for a full subscription have their key still active
Deletions:
Because of the various complications with API subscribers, it is wise to reconcile the API payments recorded in Donor Perfect with the roster of current subscribers on a quarterly basis, deactivating past-due subscribers as necessary and making sure all those who paid the appropriate amounts for a full subscription have their key still active.

Revision [19919]

Edited on 2017-04-21 16:32:04 by cassandra@votesmart.org [pct archives info on django]
Additions:
DevComm is the primary manager of API subscriptions and is generally the first point of contact with API users. They take the payment and log it in DonorPerfect, activate keys (if needed), answer billing/ account questions. Questions about the fee schedule and API policies are generally answered by the DevComm. High-volume users, name-brand users, users looking to relicense or resell data, users looking for a separate contract, partnership requests, or other unusual questions will be run by the National Director, via DevComm. The National Director may need to consult the President.
Deletions:
DevComm is the primary manager of API subscriptions and is generally the first point of contact with API users. They take the payment and log it in DonorPerfect, activate keys (if needed), answer billing/ account questions. Questions about the fee schedule and API policies are generally answered by the DevComm. If DevComm needs additional assistance, they will ask the National Director.
High-volume users, name-brand users, users looking to relicense or resell data, users looking for a separate contract, partnership requests, or other unusual questions should be run by the National Director. The National Director may need to consult the President

Revision [19916]

Edited on 2017-04-21 16:23:57 by cassandra@votesmart.org [pct archives info on django]
Additions:
====Understanding the API====
The pricing policy is stated in the [[http://votesmart.org/share/api/register registration form]].
Deletions:
====How to Manage API Subscribers====
===Understanding the API===
==Charging Policy==
The standard charging policy is stated in the [[http://votesmart.org/share/api/register registration form]].
===Administration of the Registration Process===
In mid-October 2012, a new registration system through Django Admin was instituted to streamline registration with a MyVotesmart account. New registrations submit payment and complete a form, at which point an API key is automatically activated. 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. Officemgr@votesmart.org receives a purchase confirmation, which is then forwarded to membership@votesmart.org. The Development Department then [[DevelopmentAPI adds the API Subscriber (if new) and their gift information into Donor Perfect]]
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 (who will consult the President) to assign the appropriate fee
Some subscribers may request a more formal invoice or receipt. DevComm can pull their thank you letter they get for their subscription, or pull a receipt from CyberSource.
For more information about API subscribers see:
outreach>Partnerships and API Sales->API Information->Subscribers
[[https://docs.google.com/document/d/1pRcFGbg3Jv7DFRc2I-nALg1eqyxDWQogdT9gL-ufUtE/edit Partnerships and Large API Users Contact Notes]]
outreach>partnerships & api sales>contracts and partnership discussions
outreach>partnerships & api sales>link to partnership with media orgs
For more information about API subscription payments see:
Donor Perfect records
outreach>Partnerships and API Sales->API Information

Revision [19910]

Edited on 2017-04-21 15:58:29 by cassandra@votesmart.org [pct archives info on django]
Additions:
The standard charging policy is stated in the [[http://votesmart.org/share/api/register registration form]].
Deletions:
===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.
==Subscription Length==
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.
**Exceptions**: A trial key may be possible, upon request. A trial key (of no more than one month) can be administered with the understanding that the key will be deactivated after the designated # of days, at which time the user cannot use any Vote Smart data obtained by the API. We may choose to charge a pro-rated fee for longer trial session. If the user decides to purchase an API key at the end of the trial, be sure to change the user api information in Django admin to reflect the subscription type, payment date, and subscription start date
The standard charging policy is stated in the [[http://votesmart.org/share/api/register registration form]] and the [[http://wiki.votesmart.org/APIandDataRequests/files.xml?action=download&file=API%20Upper%20Tier%20Fee%20Schedule%20modified%202015.doc Upper Tier fee schedule]] (also located at outreach>Partnerships and API Sales->API Information->Pricing)
**Personal Use**
- Members get access for free, as long it's just for personal, internal use.
- Non-members pay $45 to get access for personal, internal use.
Exceptions: Undergraduate and graduate students who are conducting research for a class can access the API at the $45 level. If that is too burdensome, then they can purchase a Millennial Membership at $15.
**Other Uses**
Businesses, academic institutions or other groups wishing to use the API, or individuals looking to publish our data to the public must pay for “Other Use” which can span anywhere from $100 to $50,000+. Anyone releasing our data to the public falls in the $2000 tier. The fee schedule is based on Organization's potential for use. Those wishing to relicense or resell data must pay a minimum of $15,000.
Exceptions: If someone claims the fee is too burdensome, we can consider a reduced fee on a case-by-case basis. Generally, we will suggest a reduced fee of $250, but only if 2 out of 3 of the following criteria are met:
1. low quality/traffic website
2. small budget
3. not a direct competitor
===Custom API Subscriptions and Partnerships===
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
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 physical administrative files
Past Partnership and Other Info:

Revision [19897]

Edited on 2017-04-21 15:22:57 by cassandra@votesmart.org [pct archives info on django]
Additions:
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)
Deletions:
===API Outreach===
It may be useful to reach out to nonsubscribers who may find our data useful with a sales pitch.

Revision [19851]

Edited on 2017-04-20 16:03:19 by cassandra@votesmart.org [pct archives info on django]
Deletions:
===Resources for API Subscribers===
[[http://wiki.votesmart.org/APIandDataRequests#hn_Scope_of_Data_Available_in_the_API Scope of Data]]
outreach>partnerships & api sales>data collection processes
[[http://wiki.votesmart.org/APIandDataRequests#hn_Current_Policies_for_Standard_API_Subscriptions Current Policies for API Subscriptions]]
[[http://wiki.votesmart.org/APIandDataRequests#hn_Terms_of_Use_and_Enforcement Terms of Use]]

Revision [19844]

Edited on 2017-04-20 13:53:20 by cassandra@votesmart.org [pct archives info on django]
Additions:
Businesses, academic institutions or other groups wishing to use the API, or individuals looking to publish our data to the public must pay for “Other Use” which can span anywhere from $100 to $50,000+. Anyone releasing our data to the public falls in the $2000 tier. The fee schedule is based on Organization's potential for use. Those wishing to relicense or resell data must pay a minimum of $15,000.
Exceptions: If someone claims the fee is too burdensome, we can consider a reduced fee on a case-by-case basis. Generally, we will suggest a reduced fee of $250, but only if 2 out of 3 of the following criteria are met:
1. low quality/traffic website
2. small budget
3. not a direct competitor
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 (who will consult the President) to assign the appropriate fee
Some subscribers may request a more formal invoice or receipt. DevComm can pull their thank you letter they get for their subscription, or pull a receipt from CyberSource.
Deletions:
Businesses, academic institutions or other groups wishing to use the API, or individuals looking to publish our data to the public must pay for “Other Use” which can span anywhere from $100 to $50,000+. The fee schedule is based on Organization's potential for use. Those wishing to relicense or resell data must pay a minimum of $15,000.
Exceptions: If someone claims the fee is too burdensome, we can consider a reduced fee on a case-by-case basis. Generally, we will suggest a reduced fee of $250, but only if 2 out of 3 of the following criteria are met: 1. low quality/traffic website, 2. small budget, 3. not a direct competitor.
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 forwards the request to officemgr@votesmart.org stating whether or not the person is a member at the $45 level or higher. Office Manager 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 officemgr@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 (who will consult the President) to assign the appropriate fee
Some subscribers may request a more formal invoice or receipt. Templates for these may be found in outreach>Partnerships and API Sales->API Information->Pricing

Revision [19838]

Edited on 2017-04-20 11:26:10 by cassandra@votesmart.org [pct archives info on django]
Additions:
**Exceptions**: A trial key may be possible, upon request. A trial key (of no more than one month) can be administered with the understanding that the key will be deactivated after the designated # of days, at which time the user cannot use any Vote Smart data obtained by the API. We may choose to charge a pro-rated fee for longer trial session. If the user decides to purchase an API key at the end of the trial, be sure to change the user api information in Django admin to reflect the subscription type, payment date, and subscription start date
The standard charging policy is stated in the [[http://votesmart.org/share/api/register registration form]] and the [[http://wiki.votesmart.org/APIandDataRequests/files.xml?action=download&file=API%20Upper%20Tier%20Fee%20Schedule%20modified%202015.doc Upper Tier fee schedule]] (also located at outreach>Partnerships and API Sales->API Information->Pricing)
- Non-members pay $45 to get access for personal, internal use.
Deletions:
**Exceptions**: A trial key may be possible, upon request. A trial key (of no more than one month) can be administwith the understanding that the key will be deactivated after 30 days, at which time the user cannot use any Vote Smart data obtained by the API. A longer trial key can be issued for potential partner/high-tier organizations. We may also choose to charge a pro-rated fee for longer trial session. If the user decides to purchase an API key at the end of the trial, be sure to change the user api information in Django admin to reflect the subscription type, payment date, and subscription start date
the standard charging policy is stated in the [[http://votesmart.org/share/api/register registration form]] and the [[http://wiki.votesmart.org/APIandDataRequests/files.xml?action=download&file=API%20Upper%20Tier%20Fee%20Schedule%20modified%202015.doc Upper Tier fee schedule]] (also located at outreach>Partnerships and API Sales->API Information->Pricing)
- Non-members must become members in order to get access for personal, internal use by paying $45 or more.

Revision [19837]

Edited on 2017-04-20 11:24:02 by cassandra@votesmart.org [pct archives info on django]
Additions:
For example, [[http://api.votesmart.org/docs/CandidateBio.html the Candidate Bio API method]] would translate into the following URL: http://api.votesmart.org/CandidateBio.getBio?key=<your_key>&candidateId=9490. In this example, if I didn't know a candidateId, I would look for another method whose output was candidateId. I might start with the [[http://api.votesmart.org/docs/Officials.html Officials.getByLevenshtein()]] method, where the required input is lastName, because I know the official's last name. Using this: http://api.votesmart.org/CandidateBio.getBio?key=<your_key>&lastName=bullock I discover that Steve Bullock's candidateId is 110899, which I can then use as the input in the first example
Deletions:
For example, [[http://api.votesmart.org/docs/CandidateBio.html the Candidate Bio API method]] would translate into the following URL: http://api.votesmart.org/CandidateBio.getBio?key=<your_key>&candidateId=9490
In this example, if I didn't know a candidateId, I would look for another method whose output was candidateId. I might start with the [[http://api.votesmart.org/docs/Officials.html Officials.getByLevenshtein()]] method, where the required input is lastName, because I know the official's last name. Using this: http://api.votesmart.org/CandidateBio.getBio?key=<your_key>&lastName=bullock I discover that Steve Bullock's candidateId is 110899, which I can then use as the input in the first example

Revision [19836]

Edited on 2017-04-20 11:12:27 by cassandra@votesmart.org [pct archives info on django]
Additions:
NOTE: The key is case-sensitive and should use the case as listed in the documentation; [[http://api.votesmart.org/docs/semi-static.html Semi-Static Data]] may provide some input values, while others may be retrieved through a combination of API calls; for multiple inputs, separate each input with an ampersand ("&")
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.
**Exceptions**: A trial key may be possible, upon request. A trial key (of no more than one month) can be administwith the understanding that the key will be deactivated after 30 days, at which time the user cannot use any Vote Smart data obtained by the API. A longer trial key can be issued for potential partner/high-tier organizations. We may also choose to charge a pro-rated fee for longer trial session. If the user decides to purchase an API key at the end of the trial, be sure to change the user api information in Django admin to reflect the subscription type, payment date, and subscription start date
Deletions:
NOTE: It is case-sensitive and should use the case as listed in the documentation; [[http://api.votesmart.org/docs/semi-static.html Semi-Static Data]] may provide some input values, while others may be retrieved through a combination of API calls; for multiple inputs, separate each input with an ampersand ("&")
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.
**Exceptions**: A trial key may be possible, upon request. A one month trial key can be issued through the “Already a Member” option with the understanding that the key will be deactivated after 30 days, at which time the user cannot use any Vote Smart data obtained by the API. A longer trial key can be issued for potential partner/high-tier organizations. We may also choose to charge a pro-rated fee for longer trial session. If the user decides to purchase an API key at the end of the trial, be sure to change the user api information in Django admin to reflect the subscription type, payment date, and subscription start date

Revision [19835]

Edited on 2017-04-20 10:09:41 by cassandra@votesmart.org [pct archives info on django]
Additions:
- 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.
Deletions:
Subscribers are required to fill out the usage survey upon registration and submit the appropriate payment in accordance with our charging policy. They sign up for a MyVoteSmart account in the process. See: [[http://wiki.votesmart.org/APIandDataRequests#hn_Administration_of_the_Registration_Process Administration of the Registration Process]]
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 [19834]

Edited on 2017-04-20 10:04:29 by cassandra@votesmart.org [pct archives info on django]
Additions:
====How to Manage API Subscribers====
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.
- 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
Deletions:
====How to Manage The API Subscribers====
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.
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

Revision [19833]

Edited on 2017-04-20 10:01:53 by cassandra@votesmart.org [pct archives info on django]
Additions:
http://votesmart.org/share/api/register: You should receive an email from officemgr@votesmart.org with your API Key once payment is made.
Deletions:
http://votesmart.org/share/api/register: You should receive an email with your API Key once payment is made.

Revision [19832]

Edited on 2017-04-20 09:58:39 by cassandra@votesmart.org [pct archives info on django]
Additions:
For example, [[http://api.votesmart.org/docs/CandidateBio.html the Candidate Bio API method]] would translate into the following URL: http://api.votesmart.org/CandidateBio.getBio?key=<your_key>&candidateId=9490
Deletions:
For example, [[http://api.votesmart.org/docs/CandidateBio.html the Candidate Bio API method]] would translate into the following URL:
http://api.votesmart.org/CandidateBio.getBio?key=<your_key>&candidateId=9490

Revision [19831]

Edited on 2017-04-20 09:58:00 by cassandra@votesmart.org [pct archives info on django]
Additions:
For example, [[http://api.votesmart.org/docs/CandidateBio.html the Candidate Bio API method]] would translate into the following URL:
In this example, if I didn't know a candidateId, I would look for another method whose output was candidateId. I might start with the [[http://api.votesmart.org/docs/Officials.html Officials.getByLevenshtein()]] method, where the required input is lastName, because I know the official's last name. Using this: http://api.votesmart.org/CandidateBio.getBio?key=<your_key>&lastName=bullock I discover that Steve Bullock's candidateId is 110899, which I can then use as the input in the first example
Deletions:
see:
for example, [[http://api.votesmart.org/docs/CandidateBio.html the Candidate Bio API method]] would translate into the following URL:
In this example, if I didn't know a candidateId, I would look for another method whose output was candidateId. I might start with the [[http://api.votesmart.org/docs/Officials.html Officials.getByLevenshtein()]] method, where the required input is lastName, because I know the official's last name. Using this: http://api.votesmart.org/CandidateBio.getBio?key=<your_key>&lastName=bullock I discover that Steve Bullock's candidateId is 110899, which I can then use as the input in the first example

Revision [19830]

Edited on 2017-04-20 09:56:56 by cassandra@votesmart.org [pct archives info on django]
Additions:
**If none of these solutions meet their needs:**
**Read:**
[[http://wiki.votesmart.org/APICribSheet API Crib Sheet]]
[[http://votesmart.org/share/api About the API]]
[[http://api.votesmart.org/docs/index.html API Documentation]]
[[UndocumentedAPIMethods Undocumented API Methods]] (may only be given out on a case-by-case basis, with permission from the National Director)
**Register for a Key to Access It:**
http://votesmart.org/share/api/register: You should receive an email with your API Key once payment is made.
**Getting Started with the API:**
NOTE: It is case-sensitive and should use the case as listed in the documentation; [[http://api.votesmart.org/docs/semi-static.html Semi-Static Data]] may provide some input values, while others may be retrieved through a combination of API calls; for multiple inputs, separate each input with an ampersand ("&")
Deletions:
If none of these solutions meet their needs:
Read:
[[http://wiki.votesmart.org/APICribSheet API Crib Sheet]]
[[http://votesmart.org/share/api About the API]]
[[http://api.votesmart.org/docs/index.html API Documentation]]
[[UndocumentedAPIMethods Undocumented API Methods]] (may only be given out on a case-by-case basis, with permission from the National Director)
Register for a Key to Access It:
[[http://votesmart.org/share/api/register Registration]] You should receive an email with your API Key once payment is made.
Getting Started with the API:
note that it is case-sensitive and should use the case as listed in the documentation; [[http://api.votesmart.org/docs/semi-static.html Semi-Static Data]] may provide some input values, while others may be retrieved through a combination of API calls; for multiple inputs, separate each input with an ampersand ("&")

Revision [19828]

Edited on 2017-04-20 09:24:35 by cassandra@votesmart.org [pct archives info on django]
Deletions:
==Subscribers Receive==
- access to the data listed in the API Documentation through their API key(more details [[http://wiki.votesmart.org/APIandDataRequests#hn_Scope_of_Data_Available_in_the_API here]]).

Revision [19827]

Edited on 2017-04-20 09:23:57 by cassandra@votesmart.org [pct archives info on django]
Additions:
-information sourced from the public domain (government websites, campaign websites, etc.)
-unique content generated by Project Vote Smart (for example, ratings reports, legislative summaries, PCT questions)
-candidate-submitted content that we otherwise display publicly

-content we are using under fair use but do not have clear authorization to redistribute (speeches)
-content which may be of an unclear origin and thus our rights to redistribute are unclear (photos)
-candidate-submitted content not publicly-available on our website (except at the request of the candidate who authored it, journalists, and academics)
-raw data provided by our [[CategoryExternalDataSources data partners]] (though zip-to-district queries may be done via the API and our widget)
-information about our members and users (see: [[http://votesmart.org/about/privacy our privacy policy]])
[[http://votesmart.org/share/api/register Registration]] You should receive an email with your API Key once payment is made.
Deletions:
-information sourced from the public domain (government websites, campaign websites, etc.)
-unique content generated by Project Vote Smart (for example, ratings reports, legislative summaries, PCT questions)
-candidate-submitted content that we otherwise display publicly
-content we are using under fair use but do not have clear authorization to redistribute (speeches)
-content which may be of an unclear origin and thus our rights to redistribute are unclear (photos)
-candidate-submitted content not publicly-available on our website (except at the request of the candidate who authored it, journalists, and academics)
-raw data provided by our [[CategoryExternalDataSources data partners]] (though zip-to-district queries may be done via the API and our widget)
-information about our members and users (see: [[http://votesmart.org/about/privacy our privacy policy]])
[[http://votesmart.org/share/api/register Registration]]
You should receive an email with your API Key once it is approved by the API Administrator.

Revision [19821]

Edited on 2017-04-19 16:59:20 by cassandra@votesmart.org [pct archives info on django]
Additions:
===Routing API-Related Communications===
Deletions:
===Routing API-Related Communications====

Revision [19820]

Edited on 2017-04-19 16:58:55 by cassandra@votesmart.org [pct archives info on django]
Deletions:
- Subscribers are granted “Pro-Access” to our website by default

Revision [19819]

Edited on 2017-04-19 16:57:36 by cassandra@votesmart.org [pct archives info on django]
Additions:
===Routing API-Related Communications====
Deletions:
===Routing API-Related Communications===

Revision [19817]

Edited on 2017-04-19 16:57:05 by cassandra@votesmart.org [pct archives info on django]
Additions:
DevComm is the primary manager of API subscriptions and is generally the first point of contact with API users. They take the payment and log it in DonorPerfect, activate keys (if needed), answer billing/ account questions. Questions about the fee schedule and API policies are generally answered by the DevComm. If DevComm needs additional assistance, they will ask the National Director.
Deletions:
DevComm is the primary manager of API subscriptions and is generally the first point of contact with API users. They take the payment, activate keys (if needed), answer billing/ account questions. Questions about the fee schedule and API policies are generally answered by the DevComm. If DevComm needs additional assistance, they will ask the National Director.

Revision [19816]

Edited on 2017-04-19 16:55:02 by cassandra@votesmart.org [pct archives info on django]
Additions:
Temporary keys, custom payment plans, special contracts, and those who pay for subscriptions outside of the API subscription registration page, will need to be handled manually through Django Admin. It is a good idea to set Google Calendar alerts for notifications, invoicing, and deactivations.
DevComm is the primary manager of API subscriptions and is generally the first point of contact with API users. They take the payment, activate keys (if needed), answer billing/ account questions. Questions about the fee schedule and API policies are generally answered by the DevComm. If DevComm needs additional assistance, they will ask the National Director.
Deletions:
Temporary keys, custom payment plans, special contracts, and those who pay for subscriptions outside of the API subscription registration page, will need to be handled manually through Django Admin. It is a good idea to set alerts for notifications, invoicing, and deactivations.
The Office Manager is the primary manager of API subscriptions and is generally the first point of contact with API users.
All API correspondence and receipts should be saved and filed in the appropriate folders of the officemgr@votesmart.org account for future reference.
Questions about the fee schedule and API policies are generally answered by the Office Manager.
API users can discuss usage and implementation problems with other users by subscribing to the mailing list by E-mailing pvsapi-subscribe@vote-smart.org.
To confirm API payments have been received, consult the Development department.

Revision [19814]

Edited on 2017-04-19 16:38:30 by cassandra@votesmart.org [pct archives info on django]

No Differences

Revision [19813]

Edited on 2017-04-19 16:38:11 by cassandra@votesmart.org [pct archives info on django]
Additions:
- Outreach>partnerships & api sales>cribsheets on scope of data available through the API
Deletions:
- hr>partnerships & api sales>cribsheets on scope of data available through the API

Revision [19812]

Edited on 2017-04-19 16:36:15 by cassandra@votesmart.org [pct archives info on django]

No Differences

Revision [19811]

Edited on 2017-04-19 16:36:07 by cassandra@votesmart.org [pct archives info on django]
Additions:
**Data we're generally comfortable giving out:**
**Content we are hesitant to give out, particularly with some guarantee:**
**Content we will NOT give out:**
Deletions:
Data we're generally comfortable giving out:
Content we are hesitant to give out, particularly with some guarantee:
Content we will NOT give out:

Revision [18735]

Edited on 2016-11-28 10:08:15 by walker [updated files to reflect API move to outreach]
Additions:
the standard charging policy is stated in the [[http://votesmart.org/share/api/register registration form]] and the [[http://wiki.votesmart.org/APIandDataRequests/files.xml?action=download&file=API%20Upper%20Tier%20Fee%20Schedule%20modified%202015.doc Upper Tier fee schedule]] (also located at outreach>Partnerships and API Sales->API Information->Pricing)
outreach>Partnerships and API Sales->API Information->Subscribers
outreach>partnerships & api sales>contracts and partnership discussions
outreach>partnerships & api sales>link to partnership with media orgs
Some subscribers may request a more formal invoice or receipt. Templates for these may be found in outreach>Partnerships and API Sales->API Information->Pricing
outreach>Partnerships and API Sales->API Information->Subscribers
outreach>partnerships & api sales>contracts and partnership discussions
outreach>partnerships & api sales>link to partnership with media orgs
outreach>Partnerships and API Sales->API Information
outreach>partnerships & api sales>data collection processes
Deletions:
the standard charging policy is stated in the [[http://votesmart.org/share/api/register registration form]] and the [[http://wiki.votesmart.org/APIandDataRequests/files.xml?action=download&file=API%20Upper%20Tier%20Fee%20Schedule%20modified%202015.doc Upper Tier fee schedule]] (also located at hr>Partnerships and API Sales->API Information->Pricing)
hr>Partnerships and API Sales->API Information->Subscribers
hr>partnerships & api sales>contracts and partnership discussions
hr>partnerships & api sales>link to partnership with media orgs
Some subscribers may request a more formal invoice or receipt. Templates for these may be found in hr>Partnerships and API Sales->API Information->Pricing
hr>Partnerships and API Sales->API Information->Subscribers
hr>partnerships & api sales>contracts and partnership discussions
hr>partnerships & api sales>link to partnership with media orgs
hr>Partnerships and API Sales->API Information
hr>partnerships & api sales>data collection processes

Revision [18159]

Edited on 2016-08-02 15:59:58 by walker [Fixed date]
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.
Deletions:
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, 2016.

Revision [18152]

Edited on 2016-07-29 11:13:00 by walker [Added instructions: send data inquiries to researc]
Additions:
Data questions (such as those about our research processes; frequency of update; or sources) should be forwarded to the Research Director at research@votesmart.org.

Revision [18151]

Edited on 2016-07-29 10:23:56 by KristenVicedomini [Added instructions: send data inquiries to researc]
Additions:
Subscribers are required to fill out the usage survey upon registration and submit the appropriate payment in accordance with our charging policy. They sign up for a MyVoteSmart account in the process. See: [[http://wiki.votesmart.org/APIandDataRequests#hn_Administration_of_the_Registration_Process Administration of the Registration Process]]
Deletions:
Subscribers are required to fill out the usage survey upon registration and submit the appropriate payment in accordance with our charging policy. They sign up for a MyVoteSmart account in the process. See:[[http://wiki.votesmart.org/APIandDataRequests#hn_Administration_of_the_Registration_Process Administration of the Registration Process]]

Revision [18150]

Edited on 2016-07-29 10:03:06 by KristenVicedomini [Added instructions: send data inquiries to researc]
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.
[[http://wiki.votesmart.org/APIandDataRequests#hn_Scope_of_Data_Available_in_the_API Scope of Data]]
Deletions:
[[[[http://wiki.votesmart.org/APIandDataRequests#hn_Scope_of_Data_Available_in_the_API Scope of Data]]

Revision [18149]

Edited on 2016-07-29 09:58:31 by KristenVicedomini [Added instructions: send data inquiries to researc]
Additions:
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
===Administering API Renewals and Deactivations===
Temporary keys, custom payment plans, special contracts, and those who pay for subscriptions outside of the API subscription registration page, will need to be handled manually through Django Admin. It is a good idea to set alerts for notifications, invoicing, and deactivations.
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 to our Resources for API subscribers as necessary.
To some extent, renewal requests may be automated with assistance from IT. Warnings should begin at least 30 days prior to the current subscription term end date. At this point, it would also be a good idea to request stats on the usage of our data on their products. Users may renew in the same manner that they originally signed up. After the subscription term end date or trial key end date, subscribers who do not renew should be notified that their key will be deactivated, and then actually deactivated by deselecting "active" on their key in Django Admin.
Because of the various complications with API subscribers, it is wise to reconcile the API payments recorded in Donor Perfect with the roster of current subscribers on a quarterly basis, deactivating past-due subscribers as necessary and making sure all those who paid the appropriate amounts for a full subscription have their key still active.
===API Outreach===
It may be useful to reach out to nonsubscribers who may find our data useful with a sales pitch.
Deletions:
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. 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

Revision [18147]

Edited on 2016-07-29 09:40:15 by KristenVicedomini [Added instructions: send data inquiries to researc]
Additions:
- the policies surrounding it: [[http://wiki.votesmart.org/APIandDataRequests#hn_Terms_of_Use_and_Enforcement Terms of Use and Enforcement]], [[http://wiki.votesmart.org/APIandDataRequests#hn_Current_Policies_for_Standard_API_Subscriptions Standard Subscription Terms and Charging Policies]]
===Current Policies for Standard API Subscriptions===
==General Terms==
==Subscription Length==
**Exceptions**: A trial key may be possible, upon request. A one month trial key can be issued through the “Already a Member” option with the understanding that the key will be deactivated after 30 days, at which time the user cannot use any Vote Smart data obtained by the API. A longer trial key can be issued for potential partner/high-tier organizations. We may also choose to charge a pro-rated fee for longer trial session. If the user decides to purchase an API key at the end of the trial, be sure to change the user api information in Django admin to reflect the subscription type, payment date, and subscription start date
==Subscribers Receive==
==Charging Policy==
**Personal Use**
**Other Uses**
===Custom API Subscriptions and Partnerships===
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. 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
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 physical administrative files
Past Partnership and Other Info:
===Resources for API Subscribers===
[[[[http://wiki.votesmart.org/APIandDataRequests#hn_Scope_of_Data_Available_in_the_API Scope of Data]]
hr>partnerships & api sales>data collection processes
[[http://wiki.votesmart.org/APIandDataRequests#hn_Current_Policies_for_Standard_API_Subscriptions Current Policies for API Subscriptions]]
[[http://wiki.votesmart.org/APIandDataRequests#hn_Terms_of_Use_and_Enforcement Terms of Use]]
===Routing API-Related Communications===
Deletions:
- the policies surrounding it: [[http://wiki.votesmart.org/APIandDataRequests#hn_Terms_of_Use_and_Enforcement Terms of Use and Enforcement]], Standard Subscription Terms and Charging Policies]]
==Current Policies for Standard API Subscriptions==
**General Terms**
**Subscription Length**
Exceptions: A trial key may be possible, upon request. A one month trial key can be issued through the “Already a Member” option with the understanding that the key will be deactivated after 30 days, at which time the user cannot use any Vote Smart data obtained by the API. A longer trial key can be issued for potential partner/high-tier organizations. We may also choose to charge a pro-rated fee for longer trial session. If the user decides to purchase an API key at the end of the trial, be sure to change the user api information in Django admin to reflect the subscription type, payment date, and subscription start date
**Subscribers Receive**
**Charging Policy**
==Personal Use==
==Other Uses==
==Routing API-Related Communications==

Revision [18146]

Edited on 2016-07-29 09:29:44 by KristenVicedomini [Added instructions: send data inquiries to researc]
Additions:
- the policies surrounding it: [[http://wiki.votesmart.org/APIandDataRequests#hn_Terms_of_Use_and_Enforcement Terms of Use and Enforcement]], Standard Subscription Terms and Charging Policies]]
==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. They sign up for a MyVoteSmart account in the process. See:[[http://wiki.votesmart.org/APIandDataRequests#hn_Administration_of_the_Registration_Process Administration of the Registration Process]]
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.
**Subscription Length**
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, 2016.
Exceptions: A trial key may be possible, upon request. A one month trial key can be issued through the “Already a Member” option with the understanding that the key will be deactivated after 30 days, at which time the user cannot use any Vote Smart data obtained by the API. A longer trial key can be issued for potential partner/high-tier organizations. We may also choose to charge a pro-rated fee for longer trial session. If the user decides to purchase an API key at the end of the trial, be sure to change the user api information in Django admin to reflect the subscription type, payment date, and subscription start date
**Subscribers Receive**
- access to the data listed in the API Documentation through their API key(more details [[http://wiki.votesmart.org/APIandDataRequests#hn_Scope_of_Data_Available_in_the_API here]]).
- Subscribers are granted “Pro-Access” to our website by default
**Charging Policy**
the standard charging policy is stated in the [[http://votesmart.org/share/api/register registration form]] and the [[http://wiki.votesmart.org/APIandDataRequests/files.xml?action=download&file=API%20Upper%20Tier%20Fee%20Schedule%20modified%202015.doc Upper Tier fee schedule]] (also located at hr>Partnerships and API Sales->API Information->Pricing)
==Personal Use==
- Members get access for free, as long it's just for personal, internal use.
- Non-members must become members in order to get access for personal, internal use by paying $45 or more.
Exceptions: Undergraduate and graduate students who are conducting research for a class can access the API at the $45 level. If that is too burdensome, then they can purchase a Millennial Membership at $15.
==Other Uses==
Businesses, academic institutions or other groups wishing to use the API, or individuals looking to publish our data to the public must pay for “Other Use” which can span anywhere from $100 to $50,000+. The fee schedule is based on Organization's potential for use. Those wishing to relicense or resell data must pay a minimum of $15,000.
Exceptions: If someone claims the fee is too burdensome, we can consider a reduced fee on a case-by-case basis. Generally, we will suggest a reduced fee of $250, but only if 2 out of 3 of the following criteria are met: 1. low quality/traffic website, 2. small budget, 3. not a direct competitor.
Deletions:
- the policies surrounding it: [[http://wiki.votesmart.org/APIandDataRequests#hn_Terms_of_Use_and_Enforcement Terms of Use and Enforcement]], Subscription Terms, and Charging Policies

Revision [18145]

Edited on 2016-07-29 09:17:48 by KristenVicedomini [Added instructions: send data inquiries to researc]
Additions:
see:
- [[http://api.votesmart.org/docs/index.html the API documentation]]
- [[http://wiki.votesmart.org/APIandDataRequests/files.xml?action=download&file=Vote%20Smart%20Data%20Crib%20Sheet.pdf the data crib sheet]]
- [[http://wiki.votesmart.org/APIandDataRequests/files.xml?action=download&file=Vote%20Smart%20Data%20Coverage.ods data coverage]]
- hr>partnerships & api sales>cribsheets on scope of data available through the API
- [[http://wiki.votesmart.org/APIandDataRequests#hn_Data_Restrictions_for_Redistribution Data Restrictions for Redistribution]]
- [[http://wiki.votesmart.org/APIandDataRequests#hn_Scope_of_Data_Available_in_the_API the data included in it (and not included)]]
Deletions:
- the data included in it (and not included)- see: [[http://api.votesmart.org/docs/index.html the API documentation]], the data crib sheet, hr>partnerships & api sales>cribsheets on scope of data available through the API, [[http://wiki.votesmart.org/APIandDataRequests#hn_Data_Restrictions_for_Redistribution Data Restrictions for Redistribution]]

Revision [18144]

Edited on 2016-07-29 09:07:44 by KristenVicedomini [Added instructions: send data inquiries to researc]
Additions:
=====Bulk Data, Research/Records Requests, and the API=====
====Terms of Use and Enforcement====
====Data Restrictions for Redistribution====
====Special Delivery Mechanisms for Bulk Data Users====
====Scope of Data Available in the API====
====How To Use the API====
====How to Manage The API Subscribers====
===Understanding the API===
- [[http://wiki.votesmart.org/APIandDataRequests#hn_Special_Delivery_Mechanisms_for_Bulk_Data_Users the purpose and role of the API]]
- [[APIHistory History of API Subscriptions and Future Considerations]]
- [[http://wiki.votesmart.org/APIandDataRequests#hn_How_To_Use_the_API how the API and registration process works for users]] ( It helps to go through and register for a key for yourself, and then use that key to pull out data)
- the data included in it (and not included)- see: [[http://api.votesmart.org/docs/index.html the API documentation]], the data crib sheet, hr>partnerships & api sales>cribsheets on scope of data available through the API, [[http://wiki.votesmart.org/APIandDataRequests#hn_Data_Restrictions_for_Redistribution Data Restrictions for Redistribution]]
- the policies surrounding it: [[http://wiki.votesmart.org/APIandDataRequests#hn_Terms_of_Use_and_Enforcement Terms of Use and Enforcement]], Subscription Terms, and Charging Policies
===Administration of the Registration Process===
===Reviewing Existing API Subscriptions===
hr>partnerships & api sales>contracts and partnership discussions
hr>partnerships & api sales>link to partnership with media orgs
Deletions:
====Bulk Data, Research/Records Requests, and the API====
===Terms of Use and Enforcement===
===Data Restrictions for Redistribution===
===Special Delivery Mechanisms for Bulk Data Users===
===How To Use the API===
===How to Manage The API Subscribers===
==Understanding the API==
[[http://wiki.votesmart.org/APIandDataRequests#hn_Special_Delivery_Mechanisms_for_Bulk_Data_Users the purpose and role of the API]]
[[http://wiki.votesmart.org/APIandDataRequests#hn_How_To_Use_the_API how the API and registration process works for users]] ( It helps to go through and register for a key for yourself, and then use that key to pull out data)
the data included in it (and not included)- see: [[http://api.votesmart.org/docs/index.html the API documentation]], and the data crib sheet [[http://wiki.votesmart.org/APIandDataRequests#hn_Data_Restrictions_for_Redistribution Data Restrictions for Redistribution]]
the policies surrounding it: http://wiki.votesmart.org/APIandDataRequests#hn_Terms_of_Use_and_Enforcement Terms of Use and Enforcement]], Subscription Terms, and Charging Policies
[[APIHistory History of API Subscriptions and Future Considerations]]
see: hr/3-HUMAN RESOURCES/New Hires/1-Job Descriptions/Operations/Office Manager
[[http://wiki.votesmart.org/DevelopmentAPI DevComm- Data Entry into Donor Perfect]]
==Administration of the Registration Process==
==Reviewing Existing API Subscriptions==

Revision [18143]

Edited on 2016-07-29 08:53:11 by KristenVicedomini [Added instructions: send data inquiries to researc]
Additions:
{{{files}}}

Revision [18142]

Edited on 2016-07-28 12:19:43 by KristenVicedomini [Added instructions: send data inquiries to researc]
Additions:
Some subscribers may request a more formal invoice or receipt. Templates for these may be found in hr>Partnerships and API Sales->API Information->Pricing
If you need to review an API registration at a later date, you can access their user account through Django admin (http://skittles.votesmart.org/admin). Click on Users, search by user name or email address, and then click on the user. Scroll down to the bottom of the page, which displays the API key next to API Registration. The key is a link, which will then display information including the subscription type, whether the key is active, and survey details. From this interface you may manually activate or deactivate a key. Click on the link by survey details (API Subscription Survey) to review the registration form. ***Check Mantis ticket #0006752 to see if this has changed per Melanie and Mike's conversation***API subscribers imported from the old system may not have had their survey transferred, and their answers may only be available via the original survey in Icontact. This is also stored here: hr/5- PROJECT MGMT/API Information/Nov 11 - Oct 12 API Registration Forms. If you want them to fill out the survey, you can send them to the following page and just tell them not to bother with making payment at the following step: http://votesmart.org/share/api/register/step-2 [^]. An email may also be sent out to affected users to make this request\
For more information about API subscribers see:
hr>Partnerships and API Sales->API Information->Subscribers
[[https://docs.google.com/document/d/1pRcFGbg3Jv7DFRc2I-nALg1eqyxDWQogdT9gL-ufUtE/edit Partnerships and Large API Users Contact Notes]]
For more information about API subscription payments see:
Donor Perfect records
hr>Partnerships and API Sales->API Information
hr>Partnerships and API Sales->API Information->Subscribers
[[https://docs.google.com/document/d/1pRcFGbg3Jv7DFRc2I-nALg1eqyxDWQogdT9gL-ufUtE/edit Partnerships and Large API Users Contact Notes]]
Deletions:
If you need to review an API registration at a later date, you can access their user account through Django admin (http://skittles.votesmart.org/admin). Click on Users, search by user name or email address, and then click on the user. Scroll down to the bottom of the page, which displays the API key next to API Registration. The key is a link, which will then display information including the subscription type, whether the key is active, and survey details. From this interface you may manually activate or deactivate a key. Click on the link by survey details (API Subscription Survey) to review the registration form. ***Check Mantis ticket #0006752 to see if this has changed per Melanie and Mike's conversation***API subscribers imported from the old system may not have had their survey transferred, and their answers may only be available via the original survey in Icontact. This is also stored here: hr/5- PROJECT MGMT/API Information/Nov 11 - Oct 12 API Registration Forms. If you want them to fill out the survey, you can send them to the following page and just tell them not to bother with making payment at the following step: http://votesmart.org/share/api/register/step-2 [^]. An email may also be sent out to affected users to make this request

Revision [18139]

Edited on 2016-07-27 16:09:02 by KristenVicedomini [Added instructions: send data inquiries to researc]
Additions:
==Understanding the API==
==Administration of the Registration Process==
In mid-October 2012, a new registration system through Django Admin was instituted to streamline registration with a MyVotesmart account. New registrations submit payment and complete a form, at which point an API key is automatically activated. 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. Officemgr@votesmart.org receives a purchase confirmation, which is then forwarded to membership@votesmart.org. The Development Department then [[DevelopmentAPI adds the API Subscriber (if new) and their gift information into Donor Perfect]]
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 forwards the request to officemgr@votesmart.org stating whether or not the person is a member at the $45 level or higher. Office Manager 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 officemgr@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 (who will consult the President) to assign the appropriate fee
==Reviewing Existing API Subscriptions==
If you need to review an API registration at a later date, you can access their user account through Django admin (http://skittles.votesmart.org/admin). Click on Users, search by user name or email address, and then click on the user. Scroll down to the bottom of the page, which displays the API key next to API Registration. The key is a link, which will then display information including the subscription type, whether the key is active, and survey details. From this interface you may manually activate or deactivate a key. Click on the link by survey details (API Subscription Survey) to review the registration form. ***Check Mantis ticket #0006752 to see if this has changed per Melanie and Mike's conversation***API subscribers imported from the old system may not have had their survey transferred, and their answers may only be available via the original survey in Icontact. This is also stored here: hr/5- PROJECT MGMT/API Information/Nov 11 - Oct 12 API Registration Forms. If you want them to fill out the survey, you can send them to the following page and just tell them not to bother with making payment at the following step: http://votesmart.org/share/api/register/step-2 [^]. An email may also be sent out to affected users to make this request
==Routing API-Related Communications==
The Office Manager is the primary manager of API subscriptions and is generally the first point of contact with API users.
All API correspondence and receipts should be saved and filed in the appropriate folders of the officemgr@votesmart.org account for future reference.
Questions about the fee schedule and API policies are generally answered by the Office Manager.
Technical questions, API bug reports, or API feature requests should be forwarded to IT at webmaster@votesmart.org.
API users can discuss usage and implementation problems with other users by subscribing to the mailing list by E-mailing pvsapi-subscribe@vote-smart.org.
To confirm API payments have been received, consult the Development department.
High-volume users, name-brand users, users looking to relicense or resell data, users looking for a separate contract, partnership requests, or other unusual questions should be run by the National Director. The National Director may need to consult the President
Deletions:
UNDERSTANDING THE API

Revision [18138]

Edited on 2016-07-27 11:38:00 by KristenVicedomini [Added instructions: send data inquiries to researc]
Additions:
[[http://wiki.votesmart.org/APIandDataRequests#hn_How_To_Use_the_API how the API and registration process works for users]] ( It helps to go through and register for a key for yourself, and then use that key to pull out data)
Deletions:
[[http://wiki.votesmart.org/APIandDataRequests#hn_How_To_Use_the_API how it works]] ( It helps to go through and register for a key for yourself, and then use that key to pull out data)

Revision [18137]

Edited on 2016-07-27 11:33:05 by KristenVicedomini [Added instructions: send data inquiries to researc]
Additions:
UNDERSTANDING THE API
In order to answer the bulk of questions you will get, you will need to familiarize yourself with:
[[http://wiki.votesmart.org/APIandDataRequests#hn_Special_Delivery_Mechanisms_for_Bulk_Data_Users the purpose and role of the API]]
[[http://wiki.votesmart.org/APIandDataRequests#hn_How_To_Use_the_API how it works]] ( It helps to go through and register for a key for yourself, and then use that key to pull out data)
the data included in it (and not included)- see: [[http://api.votesmart.org/docs/index.html the API documentation]], and the data crib sheet [[http://wiki.votesmart.org/APIandDataRequests#hn_Data_Restrictions_for_Redistribution Data Restrictions for Redistribution]]
the policies surrounding it: http://wiki.votesmart.org/APIandDataRequests#hn_Terms_of_Use_and_Enforcement Terms of Use and Enforcement]], Subscription Terms, and Charging Policies

Revision [18136]

Edited on 2016-07-27 11:19:02 by KristenVicedomini [Added instructions: send data inquiries to researc]
Additions:
- The primary delivery mechanism for Vote Smart's bulk data is through our [[http://votesmart.org/share/api API]], though this typically requires the use of a developer. The API is an application that queries our database and produces an output for the API user. API users will use this to get bulk data or may directly integrate it into their own websites and applications. Direct people here first: it's relatively low-maintenance on our end and will fulfill most needs.
Deletions:
- Our primary delivery mechanism for bulk data is through our [[http://votesmart.org/share/api API]], though this typically requires the use of a developer. Direct people here first: it's relatively low-maintenance on our end and will fulfill most needs.

Revision [18134]

Edited on 2016-07-27 11:02:51 by KristenVicedomini [Added instructions: send data inquiries to researc]
Additions:
[[APIHistory History of API Subscriptions and Future Considerations]]

Revision [18052]

Edited on 2016-07-11 16:30:02 by KristenVicedomini [Added instructions: send data inquiries to researc]
Additions:
[[http://wiki.votesmart.org/DevelopmentAPI DevComm- Data Entry into Donor Perfect]]

Revision [17884]

Edited on 2016-06-07 09:04:26 by KristenVicedomini [Added instructions: send data inquiries to researc]
Additions:
- Special permission may be granted on a case-by-case basis to our PCT Archives (for journalists and academics only), as long as they abide by our terms of use. They must create a MyVoteSmart account on our site first, at which point we would create a mantis ticket asking IT to grant access to the PCT Archives for that username. They would then access the data by logging in and going to their User Panel. As of 6/7/16 the PCT Archives may be a little buggy, but we currently do not have the resources to apply to updates at present, or to provide users with this historical data in bulk in some other format
Deletions:
- ++Special permission may be granted on a case-by-case basis to our PCT Archives (for journalists and academics only), as long as they abide by our terms of use. They must create a MyVoteSmart account on our site first, at which point we would create a mantis ticket asking IT to grant access to the PCT Archives for that username. They would then access the data by logging in and going to their User Panel.++ As of 6/6/16 the PCT Archives is not currently working- please see IT for more information as to when it would be back up. At this time, we are not able to provide users with this historical data in bulk

Revision [17879]

Edited on 2016-06-06 15:12:12 by KristenVicedomini [Added instructions: send data inquiries to researc]
Additions:
- ++Special permission may be granted on a case-by-case basis to our PCT Archives (for journalists and academics only), as long as they abide by our terms of use. They must create a MyVoteSmart account on our site first, at which point we would create a mantis ticket asking IT to grant access to the PCT Archives for that username. They would then access the data by logging in and going to their User Panel.++ As of 6/6/16 the PCT Archives is not currently working- please see IT for more information as to when it would be back up. At this time, we are not able to provide users with this historical data in bulk
Deletions:
- Special permission may be granted on a case-by-case basis to our PCT Archives (for journalists and academics only), as long as they abide by our terms of use. They must create a MyVoteSmart account on our site first, at which point we would create a mantis ticket asking IT to grant access to the PCT Archives for that username. They would then access the data by logging in and going to their User Panel.

Revision [17878]

Edited on 2016-06-06 15:01:53 by KristenVicedomini [Added instructions: send data inquiries to researc]
Additions:
- Special permission may be granted on a case-by-case basis to our PCT Archives (for journalists and academics only), as long as they abide by our terms of use. They must create a MyVoteSmart account on our site first, at which point we would create a mantis ticket asking IT to grant access to the PCT Archives for that username. They would then access the data by logging in and going to their User Panel.
Deletions:
- Special permission may be granted on a case-by-case basis to our PCT Archives (for journalists and academics only), as long as they abide by our terms of use. They must create a MyVoteSmart account on our site first, and would access the data via their User Panel.

Revision [16916]

Edited on 2015-11-05 14:39:42 by Jamieson [Added instructions: send data inquiries to researc]
Additions:
see: hr/3-HUMAN RESOURCES/New Hires/1-Job Descriptions/Operations/Office Manager
Deletions:
see: hr->6-PROJECT MGMT->API Information

Revision [15551]

Edited on 2015-05-20 11:45:24 by Melanie Magnotto [Added instructions: send data inquiries to researc]
Additions:
- Our primary delivery mechanism for bulk data is through our [[http://votesmart.org/share/api API]], though this typically requires the use of a developer. Direct people here first: it's relatively low-maintenance on our end and will fulfill most needs.
Deletions:
- Our primary delivery mechanism for bulk data is through our [[http://votesmart.org/share/api API]], though this typically requires the use of a developer. Direct people here first: it's relatively low-maintenance and our end and will fulfill most needs.

Revision [15550]

Edited on 2015-05-20 11:39:16 by Melanie Magnotto [Added instructions: send data inquiries to researc]
Additions:
Data we're generally comfortable giving out:
Deletions:
Data we're generally-comfortable giving out:

Revision [14676]

Edited on 2015-04-06 08:37:08 by Jamieson [Added instructions: send data inquiries to researc]
Additions:
note that it is case-sensitive and should use the case as listed in the documentation; [[http://api.votesmart.org/docs/semi-static.html Semi-Static Data]] may provide some input values, while others may be retrieved through a combination of API calls; for multiple inputs, separate each input with an ampersand ("&")
Deletions:
note that it is case-sensitive and should use the case as listed in the documentation; [[http://api.votesmart.org/docs/semi-static.html Semi-Static Data]] may provide some input values, while others may be retrieved through a combination of API calls; for multiple inputs, separate each input with an ampersand

Revision [14590]

Edited on 2015-03-26 15:58:44 by KristenVicedomini [Added instructions: send data inquiries to researc]
Additions:
- Our primary delivery mechanism for bulk data is through our [[http://votesmart.org/share/api API]], though this typically requires the use of a developer. Direct people here first: it's relatively low-maintenance and our end and will fulfill most needs.
- Special permission may be granted on a case-by-case basis to our PCT Archives (for journalists and academics only), as long as they abide by our terms of use. They must create a MyVoteSmart account on our site first, and would access the data via their User Panel.
- Non-developers who wish to incorporate our content on their website may wish to use our widget, RSS feeds, and linking options available on our website
If none of these solutions meet their needs:
- determine if they truly **need** bulk data? depending on their needs, they may actually find want they're looking for on our voter-oriented tools listed [[ManagingInformationDelivery here]]
- As of 2014, we do not provide "data dumps" or bulk data that requires IT assistance or significant staff time, though this may be considered for a fee or for partners. Research staff and interns may fulfill simple requests as part of SQL skill development.
Deletions:
- depending on their needs, they may actually find want they're looking for on our voter-oriented tools listed [[ManagingInformationDelivery here]])
- As of 2014, we do not provide "data dumps" or bulk data that requires IT assistance or significant staff time, though this may be considered for a fee or for partners
- Our primary delivery mechanism for bulk data is through our [[http://votesmart.org/share/api API]], though this typically requires the use of a developer
- Non-developers who wish to incorporate our content on their website may wish to use our widget, RSS feeds, and linking options available on our website
- Special permission may be granted on a case-by-case basis to our PCT Archives (for journalists and academics only), as long as they abide by our terms of use

Revision [14556]

Edited on 2015-03-25 13:55:31 by KristenVicedomini [Added instructions: send data inquiries to researc]
Additions:
===Special Delivery Mechanisms for Bulk Data Users===
- depending on their needs, they may actually find want they're looking for on our voter-oriented tools listed [[ManagingInformationDelivery here]])
Deletions:
===Special Delivery Mechanisms for Bulk Data Users (outside of our voter-oriented tools listed [[ManagingInformationDelivery here]])===

Revision [14554]

Edited on 2015-03-25 13:50:24 by KristenVicedomini [Added instructions: send data inquiries to researc]
Additions:
===Special Delivery Mechanisms for Bulk Data Users (outside of our voter-oriented tools listed [[ManagingInformationDelivery here]])===
Deletions:
===Special Delivery Mechanisms for Bulk Data Users (outside of our voter oriented tools listed [[ManagingInformationDelivery here]])===

Revision [14553]

Edited on 2015-03-25 13:47:21 by KristenVicedomini [Added instructions: send data inquiries to researc]
Additions:
>>{{{toc}}}>>

Revision [13853]

Edited on 2015-01-28 14:58:51 by KristenVicedomini [Added instructions: send data inquiries to researc]
Additions:
You should receive an email with your API Key once it is approved by the API Administrator.
Getting Started with the API:
By default, the output will be in XML. This is fairly readable as is, but it can be converted into another format of your choosing. For example, a quick search for "xml to csv converter" on Google produces over 3 million results.
Deletions:
Once your Key is Approved:

Revision [13852]

Edited on 2015-01-28 14:53:06 by KristenVicedomini [Added instructions: send data inquiries to researc]
Additions:
Once your Key is Approved:
Here is a basic formula for directly interacting with the API in a web browser:
http://api.votesmart.org/<method>?key=<your_key>&<input>
note that it is case-sensitive and should use the case as listed in the documentation; [[http://api.votesmart.org/docs/semi-static.html Semi-Static Data]] may provide some input values, while others may be retrieved through a combination of API calls; for multiple inputs, separate each input with an ampersand
for example, [[http://api.votesmart.org/docs/CandidateBio.html the Candidate Bio API method]] would translate into the following URL:
http://api.votesmart.org/CandidateBio.getBio?key=<your_key>&candidateId=9490
In this example, if I didn't know a candidateId, I would look for another method whose output was candidateId. I might start with the [[http://api.votesmart.org/docs/Officials.html Officials.getByLevenshtein()]] method, where the required input is lastName, because I know the official's last name. Using this: http://api.votesmart.org/CandidateBio.getBio?key=<your_key>&lastName=bullock I discover that Steve Bullock's candidateId is 110899, which I can then use as the input in the first example

Revision [13809]

Edited on 2015-01-28 09:23:31 by KristenVicedomini [Added instructions: send data inquiries to researc]
Additions:
-raw data provided by our [[CategoryExternalDataSources data partners]] (though zip-to-district queries may be done via the API and our widget)
Deletions:
-raw data provided by our data partners: NIMSP, CRP, and Aristotle (though zip-to-district queries may be done via the API and our widget)

Revision [12317]

Edited on 2014-12-24 16:54:46 by KristenVicedomini [Added instructions: send data inquiries to researc]
Additions:
===How to Manage The API Subscribers===
Deletions:
===How to Manage The API===

Revision [12316]

Edited on 2014-12-24 16:46:43 by KristenVicedomini [Added instructions: send data inquiries to researc]
Additions:
- [[http://votesmart.org/copyright Copyright/Attribution Policy]]
===Data Restrictions for Redistribution===
Data we're generally-comfortable giving out:
-information sourced from the public domain (government websites, campaign websites, etc.)
-unique content generated by Project Vote Smart (for example, ratings reports, legislative summaries, PCT questions)
-candidate-submitted content that we otherwise display publicly
Content we are hesitant to give out, particularly with some guarantee:
-content we are using under fair use but do not have clear authorization to redistribute (speeches)
-content which may be of an unclear origin and thus our rights to redistribute are unclear (photos)
-candidate-submitted content not publicly-available on our website (except at the request of the candidate who authored it, journalists, and academics)
Content we will NOT give out:
-raw data provided by our data partners: NIMSP, CRP, and Aristotle (though zip-to-district queries may be done via the API and our widget)
-information about our members and users (see: [[http://votesmart.org/about/privacy our privacy policy]])
===Special Delivery Mechanisms for Bulk Data Users (outside of our voter oriented tools listed [[ManagingInformationDelivery here]])===
- As of 2014, we do not provide "data dumps" or bulk data that requires IT assistance or significant staff time, though this may be considered for a fee or for partners
- Our primary delivery mechanism for bulk data is through our [[http://votesmart.org/share/api API]], though this typically requires the use of a developer
- Non-developers who wish to incorporate our content on their website may wish to use our widget, RSS feeds, and linking options available on our website
- We may allow "scraping" of our website on a case-by-case basis, but generally discourage this practice
- Special permission may be granted on a case-by-case basis to our PCT Archives (for journalists and academics only), as long as they abide by our terms of use
[[http://wiki.votesmart.org/APICribSheet API Crib Sheet]]
===How to Manage The API===
see: hr->6-PROJECT MGMT->API Information
Deletions:
- [[http://votesmart.org/copyright Copyright/Attribution Policy]]
===Delivery Mechanisms for Data===
As of 2014, we do not provide "data dumps" or bulk data that requires IT assistance, though this may be considered for a fee
Our primary delivery mechanism for bulk data is through our [[http://votesmart.org/share/api API]], though this typically requires the use of a developer
Non-developers who wish to incorporate our content on their website may wish to use
We may allow "scraping" of our website on a case-by-case basis, but generally discourage this practice
Special permission may be granted on a case-by-case basis to our PCT Archives (for journalists and academics only), as long as they abide by our terms of use

Revision [12284]

Edited on 2014-12-24 10:43:03 by KristenVicedomini [Added instructions: send data inquiries to researc]
Additions:
===How To Use the API===
Read:
[[http://votesmart.org/share/api About the API]]
[[http://api.votesmart.org/docs/index.html API Documentation]]
[[UndocumentedAPIMethods Undocumented API Methods]] (may only be given out on a case-by-case basis, with permission from the National Director)
Register for a Key to Access It:
[[http://votesmart.org/share/api/register Registration]]

Revision [12282]

The oldest known version of this page was created on 2014-12-24 10:36:40 by KristenVicedomini [Added instructions: send data inquiries to researc]
Valid XHTML :: Valid CSS: :: Powered by WikkaWiki