TABLE OF CONTENTS

What is an API Key?

An API Key lets an application read/write and push/pull data to/from another application.


For example -- get data from Mobilize to automatically enter into VAN, or push a list from VAN into ThruText and see text responses in VAN.


API keys are the most secure, most efficient way to get data in and out of VAN.


There are two steps to requesting + setting up a VAN API Key:

  1. Request and generate an API key in VAN
  2. Enter the API key credentials into the appropriate tool (this often entails emailing the support team for the tool or entering the information on the tool's settings page).

Generating a VAN API key does not create any connection to the tool until the API credentials are set up on the other tool.


Who can request an API Key?

Users Texas (2) and above can request keys. We recommend every committee designate one person to manage API keys so that there is not any confusion about who is requesting the keys.


Each campaign or county party only needs (and can only use) one API key per application. For example, Travis County only needs one Mobilize API key.


What tools can I get an API key for?

Texting Platforms

  • Bluelink
  • Hustle
  • LeftApps SMS
  • Politics Rewired
  • Scale to Win
  • TextOut Open Progress
  • ThruText (formerly Relay Txt)


Dialing/Phones Platforms

  • Callserver (COS)
  • ThruTalk 
    • As of summer 2020, we do not approve ThruTalk API Keys, as it does not send information back into VAN correctly. If you're using ThruTalk for your phones, please submit a ticket and we can assist with exports and uploads back into VAN. We'd also recommend reaching out to ThruTalk support with a product request that they include "VAN phone number IDs" in their exports into VAN so that the API key can become functional.


Relational Voter Contact Platforms

  • Empower (myRVPlist)
  • OutreachCircle
  • OutVote
  • Reach.Vote
  • Tuesday Strategies


Organizing Tools

  • BallotReady
  • Blue Squad
  • ControlShift
  • Mobilize
  • Organizer Inc


Data Analysis Platforms

  • Civitech
  • Deck
  • Parsons
  • Phoenix (BigQuery)


How do I get an API Key?

Log in to your VAN committee and then in a new tab, copy & paste this link: https://www.texasvan.com/APIIntegrations.aspx


Or, you can navigate to the Administrative Menu (on VAN's main menu, the page you'll see when you first log in to your committee), and select Integrations > API Integrations:


You can also search for "API Integrations" on the sidebar:


Next, you'll see a page that probably looks like this:

(if your page looks different, you may already have an API key or two in your committee! most county parties probably have Mobilize or a texting platform, but new committees won't have any API keys set up yet.)


Click either of the "Request an API Key" buttons and you'll get a pop-up that looks like this:


Next, select from the dropdown the name of the application you'd like an API key for. In this example, we're going to be requesting a Mobilize API key. After selecting your integration, select a TDP Data Team staffer to send the request to.



After submitting, you should see this confirmation blurb on the top of your window: 


Once your API Key request is approved by a TDP Data Team staffer, you will receive an email that it has been approved, and you will need to navigate back to the API Integrations page in VAN (https://www.texasvan.com/APIIntegrations.aspx) to generate your API Key.


Click "Generate API Key," and you'll receive this pop-up warning:


When you're ready to generate your API Key, click the "Generate API Key" button (or click "cancel" if you're not ready), and you'll get a popup with the API key information (we're not posting a screenshot of that for security reasons!)


After copying the information for your API key, you'll need to enter that information into the relevant application. Read more about how to do that here.


Once the API request process is complete, your page will look something like this:


We also set expiration dates for all new API Keys, and our standard is setting the expiration date for each integration to the first day of the month following your general election. Read more about expiration date standards here.